Workflows

Get all workflows in the system

get

Authorizations

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/workflows HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Label": "text",
    "DefaultStateUid": "123e4567-e89b-12d3-a456-426614174000",
    "States": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "Label": "text",
        "Transitions": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "TransitionToStateUid": "123e4567-e89b-12d3-a456-426614174000",
            "Label": "text",
            "Description": "text",
            "RequiredPermission": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "Color": "text"
      }
    ],
    "ProductAssignmentProductStructureUids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "VariantAssignmentProductStructureUids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "CatalogueAssignmentCatalogueUids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "AssetAssignmentAssetTypeUids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "VariantGroupAssignmentProductStructureUids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Create a workflow

post

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Model used to create a new workflow

Uidstring · uuidOptional

Unique id of workflow

Aliasstring | nullableOptional

Alias of the workflow

Labelstring | nullableOptional

Label of the workflow

DefaultStateUidstring · uuidOptional

The default state of the workflow

ProductAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to products using the product structures

VariantAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to variants using the product structures

CatalogueAssignmentCatalogueUidsstring · uuid[] | nullableOptional

Assignment of the workflow to categories in the catalogues

AssetAssignmentAssetTypeUidsstring · uuid[] | nullableOptional

Assignment of the workflow to asset types

VariantGroupAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to variant groups using the product structures

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · uuid

400

Bad Request

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /v1/workflows HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 853

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "DefaultStateUid": "123e4567-e89b-12d3-a456-426614174000",
  "States": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Label": "text",
      "Transitions": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "TransitionToStateUid": "123e4567-e89b-12d3-a456-426614174000",
          "Label": "text",
          "Description": "text",
          "RequiredPermission": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "Color": "text"
    }
  ],
  "ProductAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "CatalogueAssignmentCatalogueUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "AssetAssignmentAssetTypeUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantGroupAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

123e4567-e89b-12d3-a456-426614174000

Update a workflow

put

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Model used to create a new workflow

Uidstring · uuidOptional

Unique id of workflow

Aliasstring | nullableOptional

Alias of the workflow

Labelstring | nullableOptional

Label of the workflow

DefaultStateUidstring · uuidOptional

The default state of the workflow

ProductAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to products using the product structures

VariantAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to variants using the product structures

CatalogueAssignmentCatalogueUidsstring · uuid[] | nullableOptional

Assignment of the workflow to categories in the catalogues

AssetAssignmentAssetTypeUidsstring · uuid[] | nullableOptional

Assignment of the workflow to asset types

VariantGroupAssignmentProductStructureUidsstring · uuid[] | nullableOptional

Assignment of the workflow to variant groups using the product structures

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · uuid

400

Bad Request

text/plainapplication/jsontext/json

put

HTTPcURLJavaScriptPython

PUT /v1/workflows HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 957

{
  "MoveEntitiesFromStateUidToStateUid": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "DefaultStateUid": "123e4567-e89b-12d3-a456-426614174000",
  "States": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Label": "text",
      "Transitions": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "TransitionToStateUid": "123e4567-e89b-12d3-a456-426614174000",
          "Label": "text",
          "Description": "text",
          "RequiredPermission": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "Color": "text"
    }
  ],
  "ProductAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "CatalogueAssignmentCatalogueUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "AssetAssignmentAssetTypeUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantGroupAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

123e4567-e89b-12d3-a456-426614174000

Get a workflow

get

Authorizations

Path parameters

uidstring · uuidRequired

Id of workflow to get

Responses

200

OK

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/workflows/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "DefaultStateUid": "123e4567-e89b-12d3-a456-426614174000",
  "States": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Label": "text",
      "Transitions": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "TransitionToStateUid": "123e4567-e89b-12d3-a456-426614174000",
          "Label": "text",
          "Description": "text",
          "RequiredPermission": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "Color": "text"
    }
  ],
  "ProductAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "CatalogueAssignmentCatalogueUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "AssetAssignmentAssetTypeUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "VariantGroupAssignmentProductStructureUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete a workflow

delete

Authorizations

Path parameters

uidstring · uuidRequired

Id of workflow to delete

Responses

200

OK

delete

HTTPcURLJavaScriptPython

DELETE /v1/workflows/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content