2.0info: 2.13.14 Formulários ECM description: Formulários ECM x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: ecm_form contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/ecm_formsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /requestFieldAttachmentUpload: post: description: Retorna dados para upload de um arquivo em um campo do tipo anexo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName – fileSize properties: fileName: type: string description: Nome do arquivo fileSize: type: integer description: Tamanho do arquivo responses: 200: description: Ok schema: type: object required: – uploadUrl – fieldValue properties: uploadUrl: type: string description: Url para realizar o upload do arquivo fieldValue: type: string description: Valor para atribuir ao campo quando o upload for realizado com sucesso default: description: Error response schema: #/definitions/genericError get: description: Retorna dados para upload de um arquivo em um campo do tipo anexo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName – fileSize properties: fileName: type: string description: Nome do arquivo fileSize: type: integer description: Tamanho do arquivo responses: 200: description: Ok schema: type: object required: – uploadUrl – fieldValue properties: uploadUrl: type: string description: Url para realizar o upload do arquivo fieldValue: type: string description: Valor para atribuir ao campo quando o upload for realizado com sucesso default: description: Error response schema: #/definitions/genericError /commitAttachmentFile: post: description: Commita o arquivo enviado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName – version – targetObject properties: fileName: type: string description: Nome do arquivo type: string description: Versão do arquivo targetObject: type: string description: Identificador único do arquivo responses: 200: description: Ok schema: type: object required: – targetObject properties: targetObject: type: string description: Identificador único do arquivo name: type: string description: Nome do arquivo default: description: Error response schema: #/definitions/genericError /requestFieldAttachmentDownload: post: description: Retorna dados para o download de um arquivo em um campo do tipo anexo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – entityName – fieldName properties: entityName: type: string description: Nome da entidade recordId: type: integer description: Id do registro fieldName: type: string description: Nome do campo processInstanceId: type: integer description: Identificador da Instância de Processo BPM timeToLive: type: integer description: Tempo de vida do link responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url de download do documento default: description: Error response schema: #/definitions/genericError get: description: Retorna dados para o download de um arquivo em um campo do tipo anexo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – entityName – fieldName properties: entityName: type: string description: Nome da entidade recordId: type: integer description: Id do registro fieldName: type: string description: Nome do campo processInstanceId: type: integer description: Identificador da Instância de Processo BPM timeToLive: type: integer description: Tempo de vida do link responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url de download do documento default: description: Error response schema: #/definitions/genericError /getRecordIdByWorkflowProcessId: post: description: Retorna o identificador de um registro do formulário utilizando a instância do processo no caso de integração. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – entityName – processInstanceId properties: entityName: type: string description: nome da entidade processInstanceId: type: integer description: identificador do processo de workflow. responses: 200: description: Ok schema: type: object required: – recordId properties: recordId: type: integer description: Identificador do registro do formulário. default: description: Error response schema: #/definitions/genericErrordefinitions: genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE