Swagger

The API implements a Swagger documentation and can be accessed by appending "/swagger" to the API URL.

E.g. http://[api-host-name]/swagger

Methods

Initiate Single Document Tracking

Initiates a new "document tracking" flow. Use this flow when an interchange consist of ony one document.

URL: /api/v1/operation/tracking/initiate-single-document-tracking
Action: POST
Permissions: "API Tracking Initiate document"
Prerequisites: None

Initiate Interchange Tracking

Initiates a new "interchange tracking" flow. Use this flow when an interchange consist of one or more documents.

URL: /api/v1/operation/tracking/initiate-interchange-tracking
Action: POST
Permissions: "API Tracking Initiate document"
Prerequisites: None

Track Document

Tracks a document for an existing interchange.

URL: /api/v1/operation/tracking/track-document
Action: POST
Permissions: "API Tracking Track Document"
Prerequisites: An interchange must have been created by calling one of the initiate methods.

Update Document

Updates a document. All provided fields with a valid value will be updated on the document.

URL: /api/v1/operation/tracking/update-document
Action: PATCH
Permissions: "API Tracking Update document"
Prerequisites: A document should have been created by either "Initiate Single Document Tracking" or "Track Document"

Set Interchange Out

Updates the specified document with Interchange Out informations. This may also include the physical interchange out file and an interchange log file.

URL: /api/v1/operation/tracking/set-interchange-out
Action: POST
Permissions: "API Tracking Set Interchange Out"
Prerequisites: A document should have been created by either "Initiate Single Document Tracking" or "Track Document"

Update Interchange

Updates an interchange. All provided fields with a valid value will be updated on the interchange.

URL: /api/v1/operation/tracking/update-interchange
Action: PATCH
Permissions: "API Tracking Update Interchange"
Prerequisites: An interchange must have been created by calling one of the initiate methods.

Set Document Status

Updates the status of the document

URL: /api/v1/operation/tracking/set-document
Action: POST
Permissions: "API Tracking Set document status"
Prerequisites: A document should have been created by either "Initiate Single Document Tracking" or "Track Document"

Track File

Uploads a file to the specified document

File types:

- InterchangeIn
- InterchangeOut
- MessageOut
- MessageCdm
- MessageIn
- InterchangeInLog
- InterchangeOutLog

URL: /api/v1/operation/tracking/track-file
Action: POST
Permissions: "API Tracking Track file"
Prerequisites: A document should have been created by either "Initiate Single Document Tracking" or "Track Document"

Track Additional File

Uploads an additional file to a document according to the specified relation.

Additional file relations:

- Document
- InterchangeIn
- InterchangeOut

URL: /api/v1/operation/tracking/track-additional-file
Action: POST
Permissions: "API Tracking Track additional file"
Prerequisites: A document should have been created by either "Initiate Single Document Tracking" or "Track Document"

Track CDM

Extracts the tracking fields from the CDM

URL: /api/v1/operation/tracking/track-cdm
Action: POST
Permissions: "API Tracking Track CDM"
Prerequisites: A file of type "MessageCdm" should have been uploaded using the "Track File" method.

Auto Create

It is possible to auto create missing entities like Format, Variant and Version.
To to so add a HTTP Header to the request with the name "X-Link-Allow-AutoCreate".
It can also be done by setting a URL parameter named 'autocreate' with a value set to 'true'.

Content on this page:

Browser not supported