Attach or change images

Workflow: REST_AttachImageToJob

Functional details

This workflow allows third parties to add or change images of an existing job in Ultimo. Images can be provided as files or in Base64 format.

The following parameters are used in the request.

JobId

The internal Id of an existing job in Ultimo.

ImageFile

Image related to the job.

ImageFile2

Image related to the job.

ImageFile3

Image related to the job.

ImageFile4

Image related to the job.

ImageFileBase64

Use this parameter for Base64 encoding.

ImageFile2Base64

Use this parameter for Base64 encoding.

ImageFile3Base64

Use this parameter for Base64 encoding.

ImageFile4Base64

Use this parameter for Base64 encoding.

ImageFileBase64Extension

This parameter can be used for Base64 encoded images. The default value is ".jpg". This parameter should be provided when the image is not in JPG format.

When these parameters are properly filled in, Ultimo will give a HTTP 200 response with the following properties:

Parameter

Description

JobId

The internal Id of the created job in Ultimo.

Technical details

Basic URL (POST):

https://customer.ultimo.com/api/V1/Action/REST_AttachImageToJob

Header data:

Parameter

Description

ApiKey

Request an API key at (application manager or consultant)

ApplicationElementId

Fixed value “d1fb01d5-77c2-48df-b95a-2ada578578df”

Body (example):

Normal response:

Status: 200 OK

Response when the action is not allowed:

Status: 400 Bad Request

Response when the API-key is invalid:

Status: 401 Unauthorized

PreviousIT-incidentsNextArticle

Last updated