Volver al centro de ayuda

Formularios

Endpoints

POST /api/form/

OperationId: createForm

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

POST /api/form/bulkapproveapproval_step/

OperationId: bulkApproveApprovalStepForm

Aprobar en masa los pasos de aprobación para múltiples formularios.

Cuerpo de la solicitud:{"formids": [1, 2, 3],"stepname": "Revisión","comments": "Aprobado" (opcional)}

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

POST /api/form/bulkrejectapproval_step/

OperationId: bulkRejectApprovalStepForm

Rechazar en masa los pasos de aprobación para múltiples formularios.

Cuerpo de la solicitud:{"formids": [1, 2, 3],"stepname": "Revisión","comments": "Motivo del rechazo"}

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

POST /api/form/from_v2/

OperationId: fromV2Form

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

POST /api/form/restore/

OperationId: restoreForm

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

POST /api/form/{id}/files/

OperationId: filesForm

Parameters

NameInTypeRequiredDescription
idpathstringyesUn valor de entero único que identifique este formulario.

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
201#/components/schemas/Form

PUT /api/form/{id}/

OperationId: updateForm

Parameters

NameInTypeRequiredDescription
idpathstringyesUn valor de entero único que identifique este formulario.
qquerystringnoUn término de búsqueda.
idquerystringnoid
id__inquerystringnoid\\in
codequerystringnocode
assigned_supplier__isnullquerystringnoassignedsupplier\\_isnull
assigneduseridquerystringnoassigneduserid
assigned_user__isnullquerystringnoassigneduser\\_isnull
status__inquerystringnostatus\\in
status__is_closedquerystringnostatus\\is_closed
status__is_cancelledquerystringnostatus\\is_cancelled
plan_datequerystringnoplan_date
plan_date__ltequerystringnoplandate\\_lte
plan_date__gtequerystringnoplandate\\_gte
date_approved__ltequerystringnodateapproved\\_lte
date_approved__gtequerystringnodateapproved\\_gte
last_syncquerystringnolast_sync
last_sync__ltquerystringnolastsync\\_lt
last_sync__gtquerystringnolastsync\\_gt
when_created__ltequerystringnowhencreated\\_lte
when_created__gtequerystringnowhencreated\\_gte
whenlastedit__ltequerystringnowhenlastedit\\lte
whenlastedit__gtequerystringnowhenlastedit\\gte
attributes__isnullquerystringnoattributes\\isnull
template__isnullquerystringnotemplate\\isnull
organizationquerystringnoorganization
projectquerystringnoproject
project__operationalunitidquerystringnoproject\\operationalunitid
templatequerystringnotemplate
sitesquerystringnosites
sites__zonequerystringnosites\\zone
sites__countryquerystringnosites\\country
sites__country_divisionquerystringnosites\\country_division
site_typequerystringnosite_type
clientquerystringnoclient
network_elementquerystringnonetwork_element
network_element__parent_nequerystringnonetworkelement\\parentne
statusquerystringnostatus
statusnotinquerystringnostatusnotin
taskquerystringnotask
attributesquerystringnoattributes
requested_byquerystringnorequested_by
approverquerystringnoapprover
assigned_supplierquerystringnoassigned_supplier
assigned_userquerystringnoassigned_user
collaborator_userquerystringnocollaborator_user
collaboratorassigneduserquerystringnocollaboratorassigneduser
supplier_responsiblequerystringnosupplier_responsible
reviewer_userquerystringnoreviewer_user
reviewer_supplierquerystringnoreviewer_supplier
revisor_userquerystringnorevisor_user
siteresponsiblerolequerystringnositeresponsiblerole
siteresponsiblestaffquerystringnositeresponsiblestaff
related_userquerystringnorelated_user
wbsquerystringnowbs
h_statusquerystringnoh_status
hide_cancelledquerystringnohide_cancelled
recent_activityquerystringnorecent_activity
needs_approvalquerystringnoneeds_approval
needsapprovalby_userquerystringnoneedsapprovalby_user
sites__attributesquerystringnosites\\attributes
work_structure__attributesquerystringnoworkstructure\\_attributes
sites__statusquerystringnosites\\status
sitesstatusstep_namequerystringnositesstatusstep_name
work_structure__statusquerystringnoworkstructure\\_status
task__statusquerystringnotask\\status
taskstatusstep_namequerystringnotaskstatusstep_name
notinrequirementquerystringnonotinrequirement
date_approvedquerystringnodate_approved
when_createdquerystringnowhen_created
who_createdquerystringnowho_created
bboxquerystringnobbox
answer_valuequerystringnoanswer_value
has_appealsquerystringnohas_appeals
whenlasteditquerystringnowhenlastedit
activeapprovalstepquerystringnoactiveapprovalstep
approvalflowrole__idquerystringnoapprovalflowrole\\id
orderingquerystringnoQué campo usar para ordenar los resultados.

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
200#/components/schemas/Form

PATCH /api/form/{id}/

OperationId: partialUpdateForm

Parameters

NameInTypeRequiredDescription
idpathstringyesUn valor de entero único que identifique este formulario.
qquerystringnoUn término de búsqueda.
idquerystringnoid
id__inquerystringnoid\\in
codequerystringnocode
assigned_supplier__isnullquerystringnoassignedsupplier\\_isnull
assigneduseridquerystringnoassigneduserid
assigned_user__isnullquerystringnoassigneduser\\_isnull
status__inquerystringnostatus\\in
status__is_closedquerystringnostatus\\is_closed
status__is_cancelledquerystringnostatus\\is_cancelled
plan_datequerystringnoplan_date
plan_date__ltequerystringnoplandate\\_lte
plan_date__gtequerystringnoplandate\\_gte
date_approved__ltequerystringnodateapproved\\_lte
date_approved__gtequerystringnodateapproved\\_gte
last_syncquerystringnolast_sync
last_sync__ltquerystringnolastsync\\_lt
last_sync__gtquerystringnolastsync\\_gt
when_created__ltequerystringnowhencreated\\_lte
when_created__gtequerystringnowhencreated\\_gte
whenlastedit__ltequerystringnowhenlastedit\\lte
whenlastedit__gtequerystringnowhenlastedit\\gte
attributes__isnullquerystringnoattributes\\isnull
template__isnullquerystringnotemplate\\isnull
organizationquerystringnoorganization
projectquerystringnoproject
project__operationalunitidquerystringnoproject\\operationalunitid
templatequerystringnotemplate
sitesquerystringnosites
sites__zonequerystringnosites\\zone
sites__countryquerystringnosites\\country
sites__country_divisionquerystringnosites\\country_division
site_typequerystringnosite_type
clientquerystringnoclient
network_elementquerystringnonetwork_element
network_element__parent_nequerystringnonetworkelement\\parentne
statusquerystringnostatus
statusnotinquerystringnostatusnotin
taskquerystringnotask
attributesquerystringnoattributes
requested_byquerystringnorequested_by
approverquerystringnoapprover
assigned_supplierquerystringnoassigned_supplier
assigned_userquerystringnoassigned_user
collaborator_userquerystringnocollaborator_user
collaboratorassigneduserquerystringnocollaboratorassigneduser
supplier_responsiblequerystringnosupplier_responsible
reviewer_userquerystringnoreviewer_user
reviewer_supplierquerystringnoreviewer_supplier
revisor_userquerystringnorevisor_user
siteresponsiblerolequerystringnositeresponsiblerole
siteresponsiblestaffquerystringnositeresponsiblestaff
related_userquerystringnorelated_user
wbsquerystringnowbs
h_statusquerystringnoh_status
hide_cancelledquerystringnohide_cancelled
recent_activityquerystringnorecent_activity
needs_approvalquerystringnoneeds_approval
needsapprovalby_userquerystringnoneedsapprovalby_user
sites__attributesquerystringnosites\\attributes
work_structure__attributesquerystringnoworkstructure\\_attributes
sites__statusquerystringnosites\\status
sitesstatusstep_namequerystringnositesstatusstep_name
work_structure__statusquerystringnoworkstructure\\_status
task__statusquerystringnotask\\status
taskstatusstep_namequerystringnotaskstatusstep_name
notinrequirementquerystringnonotinrequirement
date_approvedquerystringnodate_approved
when_createdquerystringnowhen_created
who_createdquerystringnowho_created
bboxquerystringnobbox
answer_valuequerystringnoanswer_value
has_appealsquerystringnohas_appeals
whenlasteditquerystringnowhenlastedit
activeapprovalstepquerystringnoactiveapprovalstep
approvalflowrole__idquerystringnoapprovalflowrole\\id
orderingquerystringnoQué campo usar para ordenar los resultados.

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
200#/components/schemas/Form


NameInTypeRequiredDescription
idpathstringyesUn valor de entero único que identifique este formulario.
qquerystringnoUn término de búsqueda.
idquerystringnoid
id__inquerystringnoid\\in
codequerystringnocode
assigned_supplier__isnullquerystringnoassignedsupplier\\_isnull
assigneduseridquerystringnoassigneduserid
assigned_user__isnullquerystringnoassigneduser\\_isnull
status__inquerystringnostatus\\in
status__is_closedquerystringnostatus\\is_closed
status__is_cancelledquerystringnostatus\\is_cancelled
plan_datequerystringnoplan_date
plan_date__ltequerystringnoplandate\\_lte
plan_date__gtequerystringnoplandate\\_gte
date_approved__ltequerystringnodateapproved\\_lte
date_approved__gtequerystringnodateapproved\\_gte
last_syncquerystringnolast_sync
last_sync__ltquerystringnolastsync\\_lt
last_sync__gtquerystringnolastsync\\_gt
when_created__ltequerystringnowhencreated\\_lte
when_created__gtequerystringnowhencreated\\_gte
whenlastedit__ltequerystringnowhenlastedit\\lte
whenlastedit__gtequerystringnowhenlastedit\\gte
attributes__isnullquerystringnoattributes\\isnull
template__isnullquerystringnotemplate\\isnull
organizationquerystringnoorganization
projectquerystringnoproject
project__operationalunitidquerystringnoproject\\operationalunitid
templatequerystringnotemplate
sitesquerystringnosites
sites__zonequerystringnosites\\zone
sites__countryquerystringnosites\\country
sites__country_divisionquerystringnosites\\country_division
site_typequerystringnosite_type
clientquerystringnoclient
network_elementquerystringnonetwork_element
network_element__parent_nequerystringnonetworkelement\\parentne
statusquerystringnostatus
statusnotinquerystringnostatusnotin
taskquerystringnotask
attributesquerystringnoattributes
requested_byquerystringnorequested_by
approverquerystringnoapprover
assigned_supplierquerystringnoassigned_supplier
assigned_userquerystringnoassigned_user
collaborator_userquerystringnocollaborator_user
collaboratorassigneduserquerystringnocollaboratorassigneduser
supplier_responsiblequerystringnosupplier_responsible
reviewer_userquerystringnoreviewer_user
reviewer_supplierquerystringnoreviewer_supplier
revisor_userquerystringnorevisor_user
siteresponsiblerolequerystringnositeresponsiblerole
siteresponsiblestaffquerystringnositeresponsiblestaff
related_userquerystringnorelated_user
wbsquerystringnowbs
h_statusquerystringnoh_status
hide_cancelledquerystringnohide_cancelled
recent_activityquerystringnorecent_activity
needs_approvalquerystringnoneeds_approval
needsapprovalby_userquerystringnoneedsapprovalby_user
sites__attributesquerystringnosites\\attributes
work_structure__attributesquerystringnoworkstructure\\_attributes
sites__statusquerystringnosites\\status
sitesstatusstep_namequerystringnositesstatusstep_name
work_structure__statusquerystringnoworkstructure\\_status
task__statusquerystringnotask\\status
taskstatusstep_namequerystringnotaskstatusstep_name
notinrequirementquerystringnonotinrequirement
date_approvedquerystringnodate_approved
when_createdquerystringnowhen_created
who_createdquerystringnowho_created
bboxquerystringnobbox
answer_valuequerystringnoanswer_value
has_appealsquerystringnohas_appeals
whenlasteditquerystringnowhenlastedit
activeapprovalstepquerystringnoactiveapprovalstep
approvalflowrole__idquerystringnoapprovalflowrole\\id
orderingquerystringnoQué campo usar para ordenar los resultados.

Responses

HTTP CodeDescriptionSchema
204``

PUT /api/form/{id}/submitforapproval/

OperationId: submitForApprovalForm

Parameters

NameInTypeRequiredDescription
idpathstringyesUn valor de entero único que identifique este formulario.

Request body

  • application/json
  • Schema: #/components/schemas/Form
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Form
  • multipart/form-data
  • Schema: #/components/schemas/Form
  • application/yaml
  • Schema: #/components/schemas/Form

Responses

HTTP CodeDescriptionSchema
200#/components/schemas/Form