/api/files/loadImage (Load Image)

Load Image

GET/api/files/loadImage

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/files/loadImage (Load Image) action (under FileController).
Fill in the fields below, then reference the result from later steps as {{apiFilesLoadimageLoadImage.response.data}}.

Request

Query parameters

imageIdstringrequired

Image ID

Response

Returns 200 with an object. Read it in later steps with {{apiFilesLoadimageLoadImage.response.data.<field>}}.

idstring

originalobject

idstringrequired

fileNamestring

thumbnailboolean

filePathstring

fileSizestring

protocolstring

createUserstring

createUserNamestring

updateUserstring

updateUserNamestring

urlstring

angleinteger (int32)

hasMessageboolean

extraDataobject

Thumbnail urlstring

json

{
  "id": "string",
  "original": {
    "id": "string",
    "fileName": "string",
    "thumbnail": false,
    "filePath": "string",
    "fileSize": "string",
    "protocol": "string",
    "createUser": "string",
    "createUserName": "string",
    "updateUser": "string",
    "updateUserName": "string",
    "url": "string",
    "angle": 0
  }
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.

Was this page helpful?