External actions endpoints

List external actions

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns a list with all external actions.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id.

sizeintegerOptional

number of entities to show

Default: 25

groupsstring[]Optional

Filter by the given group or groups

processRefstringOptional

Filter by the given processRef

Responses

200

Returning the list of external actions available.

application/json

ExternalAction

actionone ofRequired

or

or

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

groupsstring[]Required

User-defined text strings for grouping external actions

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

idstringRequired

The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: LGMl2DuvPnfPoSHhYFOm

namestringRequired

The name of this external action.

processRefstringRequired

Id of the global process related to this entity.

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

404

External action not found

application/json

get

/api/externalactions

HTTPcURLJavaScriptPython

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

[
  {
    "nameLocalized": "{ en_US: 'SomeName' }",
    "action": {
      "cancel": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "elements": [
        {
          "titleLocalized": "{ en_US: 'SomeName' }",
          "elementType": "TEXT_INPUT",
          "style": "BODY",
          "title": "text"
        }
      ],
      "success": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "type": "BLANK_LINK"
    },
    "customAttributes": {},
    "groups": [
      "text"
    ],
    "version": 42,
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z"
  }
]

Get external action

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns an external action with the given id if found.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

externalActionIdstringRequired

Id of the external action you want to get

Responses

200

External action was found & you are allowed to get it. The result is in the body.

application/json

ExternalAction

actionone ofRequired

or

or

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

groupsstring[]Required

User-defined text strings for grouping external actions

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

idstringRequired

The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: LGMl2DuvPnfPoSHhYFOm

namestringRequired

The name of this external action.

processRefstringRequired

Id of the global process related to this entity.

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

404

External action not found

application/json

get

/api/externalactions/{externalActionId}

HTTPcURLJavaScriptPython

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

[
  {
    "nameLocalized": "{ en_US: 'SomeName' }",
    "action": {
      "cancel": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "elements": [
        {
          "titleLocalized": "{ en_US: 'SomeName' }",
          "elementType": "TEXT_INPUT",
          "style": "BODY",
          "title": "text"
        }
      ],
      "success": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "type": "BLANK_LINK"
    },
    "customAttributes": {},
    "groups": [
      "text"
    ],
    "version": 42,
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z"
  }
]

Create external action

post

Creates a new external action for a process.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ExternalActionForCreation

actionone ofRequired

or

or

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

groupsstring[]Required

User-defined text strings for grouping external actions

processRefstringRequired

Id of the global process related to this entity.

Responses

201

The external action was successfully 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 endpoint

application/json

404

External action not found

application/json

post

/api/externalactions

HTTPcURLJavaScriptPython

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

{
  "nameLocalized": "{ en_US: 'SomeName' }",
  "action": {
    "cancel": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "elements": [
      {
        "titleLocalized": "{ en_US: 'SomeName' }",
        "elementType": "TEXT_INPUT",
        "style": "BODY",
        "title": "text"
      }
    ],
    "success": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "type": "BLANK_LINK"
  },
  "customAttributes": {},
  "groups": [
    "text"
  ],
  "processRef": "text"
}

{
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "name": "text",
  "processRef": "text",
  "nameLocalized": "{ en_US: 'SomeName' }",
  "action": {
    "cancel": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "elements": [
      {
        "titleLocalized": "{ en_US: 'SomeName' }",
        "elementType": "TEXT_INPUT",
        "style": "BODY",
        "title": "text"
      }
    ],
    "success": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "type": "BLANK_LINK"
  },
  "customAttributes": {},
  "groups": [
    "text"
  ],
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Replace an external action

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Replaces the external action with the provided in the body.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

externalActionIdstringRequired

ID of the external action that you want update

Body

application/json

ExternalActionForReplacement

actionone ofRequired

or

or

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

groupsstring[]Required

User-defined text strings for grouping external actions

versioninteger · int64RequiredExample: 42

Responses

200

External action was found & you are allowed to update it.

application/json

ExternalAction

actionone ofRequired

or

or

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

groupsstring[]Required

User-defined text strings for grouping external actions

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

idstringRequired

The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: LGMl2DuvPnfPoSHhYFOm

namestringRequired

The name of this external action.

processRefstringRequired

Id of the global process related to this entity.

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

404

Facility not found

application/json

put

/api/externalactions/{externalActionId}

HTTPcURLJavaScriptPython

PUT /api/externalactions/{externalActionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "nameLocalized": "{ en_US: 'SomeName' }",
  "action": {
    "cancel": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "elements": [
      {
        "titleLocalized": "{ en_US: 'SomeName' }",
        "elementType": "TEXT_INPUT",
        "style": "BODY",
        "title": "text"
      }
    ],
    "success": {
      "labelLocalized": "{ en_US: 'SomeName' }",
      "label": "text"
    },
    "type": "BLANK_LINK"
  },
  "customAttributes": {},
  "groups": [
    "text"
  ],
  "version": 42
}

[
  {
    "nameLocalized": "{ en_US: 'SomeName' }",
    "action": {
      "cancel": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "elements": [
        {
          "titleLocalized": "{ en_US: 'SomeName' }",
          "elementType": "TEXT_INPUT",
          "style": "BODY",
          "title": "text"
        }
      ],
      "success": {
        "labelLocalized": "{ en_US: 'SomeName' }",
        "label": "text"
      },
      "type": "BLANK_LINK"
    },
    "customAttributes": {},
    "groups": [
      "text"
    ],
    "version": 42,
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z"
  }
]

Delete external action

delete

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

externalActionIdstringRequired

ID of the external action that you want delete

Responses

200

External action was found & you were allowed to delete it.

No content

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

404

External action not found

application/json

delete

/api/externalactions/{externalActionId}

HTTPcURLJavaScriptPython

DELETE /api/externalactions/{externalActionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List external action logs

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the logs related with the given external action.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

externalActionIdstringRequired

Id of the external action you want to get the logs from

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

Logs were found & you are allowed to get it. The result is in the body.

application/json

ExternalActionLogs

totalintegerRequired

Total number of found entities for this query

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

404

External action logs not found

application/json

get

/api/externalactions/{externalActionId}/logs

HTTPcURLJavaScriptPython

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

[
  {
    "externalActionLogs": [
      {
        "actionPayload": {
          "linkOpenedAt": "2020-02-03T08:45:50.525Z"
        },
        "requiresAnonymization": true
      }
    ],
    "total": 42
  }
]

Create external action logs

post

Creates a new external action log.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

externalActionIdstringRequired

ID of the external action you want to create the log for

Body

application/json

ExternalActionLogForCreation

actionPayloadone ofRequired

or

or

requiresAnonymizationbooleanRequired

Responses

201

The log for the external action was successfully 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 endpoint

application/json

404

External action not found

application/json

post

/api/externalactions/{externalActionId}/logs

HTTPcURLJavaScriptPython

POST /api/externalactions/{externalActionId}/logs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "actionPayload": {
    "linkOpenedAt": "2020-02-03T08:45:50.525Z"
  },
  "requiresAnonymization": true
}

{
  "created": "2020-02-03T08:45:50.525Z",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "externalActionRef": "text",
  "id": "text",
  "actionPayload": {
    "linkOpenedAt": "2020-02-03T08:45:50.525Z"
  },
  "requiresAnonymization": true
}