Stacks (Operations)

Endpoints to operate with stacks.

Get all Stacks respecting the given filter

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Get all Stacks respecting the given filter

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

entity to start after

sizeintegerOptional

number of entities to show

Default: 25

facilityRefsstring[]Optional

facilities to filter the results

Responses

200

Entities were found & you were allowed to access it. The result is in the body.

application/json

StackResponse

totalinteger · int64Required

Total number of stacks for the given filter

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/stacks

HTTPcURLJavaScriptPython

GET /api/stacks HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "stacks": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "facilityRefs": [
        "text"
      ],
      "id": "text",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "processRefs": [
        "text"
      ],
      "version": 42
    }
  ],
  "total": 42
}

Create stack

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Create stack

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StackForCreation

facilityRefsstring[] · max: 50Required

Linked Facilities through reference

processRefsstring[] · max: 50Required

Linked Processes through reference

Responses

201

Stack created.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

post

/api/stacks

HTTPcURLJavaScriptPython

POST /api/stacks HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "facilityRefs": [
    "text"
  ],
  "processRefs": [
    "text"
  ]
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRefs": [
    "text"
  ],
  "version": 42
}

Get stack

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Get Stack respecting the given id

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stackIdstringRequired

Responses

200

Entity was found & you were allowed to access it. The result is in the body.

application/json

Stack

createdstring · date-timeRequired

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

facilityRefsstring[] · max: 50Required

Linked Facilities through reference

idstringRequired

Unique identifier of the Stack

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

processRefsstring[] · max: 50Required

Linked Processes through reference

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/stacks/{stackId}

HTTPcURLJavaScriptPython

GET /api/stacks/{stackId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRefs": [
    "text"
  ],
  "version": 42
}