GET /integration/documents/r1/documents/download-urls

Http Verb	GET
Url	/integration/documents/r1/documents/download-urls
Permissions required	Core Additional Parameters: Edit (fsm.core.additionalparameter.edit)
Last Modified Version	r1
Tech Tags
Available Async	No

BPMN Diagram

Business Logic

This Integration API provides the list of attachments of a Work Order.

One of code or externalCode must be present. If code is provided it has the precedence among the other fields.

System verifies Permission Required and starts the elaboration that is organized in steps.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: External Systems

Input: externalSystemCode, active=true

Output: externalSystemId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

IA001_001
IA001_002
Others - see link in Resource

STEP 2 - Download Url Request

System takes Input fields and checks their existence.

API Verb: GET

Resource: Download Urls

Input: fileUuid

Output: downloadUrl

If System can obtain the Output fields → elaboration is stopped. See Response payload fields

If System can’t obtain the Output fields → responds with error. See Response payload fields

Error Type:

Others - see link in Resource

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Filter

	Field	Description	Mandatory	Constraint
1	_language	Language option for the response. It supports the following values: - ALL: Request the server to return every possible translation of the response data. - USER	N	Null or Not Blank
2	_exclude	Allows to specify a subset of data that need to be excluded from the response	N	Null or Not Blank
3	_fields	Allows to specify a subset of data that need to be returned	N	Null or Not Blank
4	externalSystemCode	External System Code	Y
5	fileUuid	Document UuId	Y	Max length: 80

Fields

The parameter _fields allows to choose output fields. More info here How to use APIs: Output fields selection.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Example

{baseUrl}/integration/documents/r1/documents/download-urls?externalSystemCode=SAP&fileUuid=a1d5d85e-cf05-495b-8acb-8b82e9da7499

Response documentation

Response payload fields

	Field	Field Type	Description
1	downloadUrl	string	URL per scaricare l'allegato scelto tramite uuid

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html.

Extension fields:

Field	Description	Note
code	Extension member of a Problem Details Object that contains the error code	Only for ERROR

Response example

{
  "extension": {
    "myFieldName": "myValue"
  },
  "downloadUrl": "https://overit.s3.eu-central-1.amazonaws.com/documents/report.pdf"
}

Error example

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/documents/r1/documents/download-urls",
  "code": "IA001_001"
}