Expiries (Core)

Endpoints to read and modify expires, e.g. by extending the provisioning time.

Get expiries

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstring · enumOptional

ExpiryEntityStatus

Possible values:

processRefstringOptional

ProcessRef to filter the results

startDatestring · date-timeOptional

StartDate to filter the results. Expiry Date of results is after or equals the given value

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

endDatestringOptional

EndDate to filter the results. Expiry Date of results is before or equals the given value

startAfterIdstringOptional

entity to start after

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

found entities in the result.

application/json

ExpiryEntity

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

expiryTimestring · date-timeRequired

Time where the connected process expires, if not fulfilled

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

idstringRequired

Generated identifier of this entity

Example: 611c860f-3f00-4b01-9f4c-64cdee38a30e

lastModifiedstring · date-timeRequired

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

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

processRefstringRequired

Reference to the Process of this Entity

Example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f

processVersioninteger · int64Optional

the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages

Example: 42

provisioningTimestring · date-timeRequired

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumRequired

ExpiryEntityStatus

Possible values:

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 endpoint

application/json

get

/api/expiries

HTTPcURLJavaScriptPython

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

[]

Create expiry

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ExpiryEntityForCreation

processRefstringRequired

Reference to the Process for which this expiry entity will be created

Example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f

provisioningTimestring · date-timeRequired

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumRequired

ExpiryEntityStatus

Possible values:

Responses

200

created entity in the result.

application/json

ExpiryEntity

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

expiryTimestring · date-timeRequired

Time where the connected process expires, if not fulfilled

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

idstringRequired

Generated identifier of this entity

Example: 611c860f-3f00-4b01-9f4c-64cdee38a30e

lastModifiedstring · date-timeRequired

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

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

processRefstringRequired

Reference to the Process of this Entity

Example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f

processVersioninteger · int64Optional

the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages

Example: 42

provisioningTimestring · date-timeRequired

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumRequired

ExpiryEntityStatus

Possible values:

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 endpoint

application/json

post

/api/expiries

HTTPcURLJavaScriptPython

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

{
  "processRef": "c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f",
  "provisioningTime": "2020-02-03T08:45:51.525Z",
  "status": "ACTIVE"
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "expiryTime": "2020-02-03T08:45:51.525Z",
  "id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRef": "c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f",
  "processVersion": 42,
  "provisioningTime": "2020-02-03T08:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}

Get expiry

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

expiryIdstringRequired

id for the searched entity

Responses

200

found entity in the result.

application/json

ExpiryEntity

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

expiryTimestring · date-timeRequired

Time where the connected process expires, if not fulfilled

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

idstringRequired

Generated identifier of this entity

Example: 611c860f-3f00-4b01-9f4c-64cdee38a30e

lastModifiedstring · date-timeRequired

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

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

processRefstringRequired

Reference to the Process of this Entity

Example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f

processVersioninteger · int64Optional

the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages

Example: 42

provisioningTimestring · date-timeRequired

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumRequired

ExpiryEntityStatus

Possible values:

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 endpoint

application/json

get

/api/expiries/{expiryId}

HTTPcURLJavaScriptPython

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "expiryTime": "2020-02-03T08:45:51.525Z",
  "id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRef": "c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f",
  "processVersion": 42,
  "provisioningTime": "2020-02-03T08:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}

Update expiry

patch

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

expiryIdstringRequired

id of the entity to be changed

Body

application/json

ExpiryEntityForUpdate

provisioningTimestring · date-timeOptional

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumOptional

ExpiryEntityStatus

Possible values:

versionintegerRequired

version of the entity you want to alter

Responses

200

changed entity in the result.

application/json

ExpiryEntity

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

expiryTimestring · date-timeRequired

Time where the connected process expires, if not fulfilled

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

idstringRequired

Generated identifier of this entity

Example: 611c860f-3f00-4b01-9f4c-64cdee38a30e

lastModifiedstring · date-timeRequired

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

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

processRefstringRequired

Reference to the Process of this Entity

Example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f

processVersioninteger · int64Optional

the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages

Example: 42

provisioningTimestring · date-timeRequired

Planned time where this entity should be provided or handed over to the customer

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

statusstring · enumRequired

ExpiryEntityStatus

Possible values:

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 endpoint

application/json

patch

/api/expiries/{expiryId}

HTTPcURLJavaScriptPython

PATCH /api/expiries/{expiryId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "provisioningTime": "2020-02-03T08:45:51.525Z",
  "status": "ACTIVE",
  "version": 1
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "expiryTime": "2020-02-03T08:45:51.525Z",
  "id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRef": "c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f",
  "processVersion": 42,
  "provisioningTime": "2020-02-03T08:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}