Workflows

Get all workflows in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/workflows

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
    "Alias": "Workflow1",
    "Label": "Workflow 1",
    "DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
    "States": [
      {
        "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
        "Alias": "State1",
        "Label": "State 1",
        "Transitions": [
          {
            "Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
            "TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
            "Label": "To state 2",
            "Description": "Transition to state 2",
            "RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
          }
        ],
        "Color": "bg-gray-5 text-white"
      },
      {
        "Uid": "2974bab2-613d-429a-841d-98ab091249c8",
        "Alias": "State2",
        "Label": "State 2",
        "Transitions": [],
        "Color": "bg-yellow-l1 text-white"
      }
    ],
    "ProductAssignmentProductStructureUids": [
      "333be26b-af23-446b-973c-d190e9df676b"
    ],
    "VariantAssignmentProductStructureUids": [],
    "CatalogueAssignmentCatalogueUids": [],
    "AssetAssignmentAssetTypeUids": [],
    "VariantGroupAssignmentProductStructureUids": []
  },
  {
    "Uid": "c534744f-955c-4021-b1d0-4265212d3962",
    "Alias": "Workflow2",
    "Label": "Workflow 2",
    "DefaultStateUid": "fdf1dd9c-f80d-4f4b-a2ff-f65f25f59d54",
    "States": [
      {
        "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
        "Alias": "State1",
        "Label": "State 1",
        "Transitions": [],
        "Color": "bg-gray-5 text-white"
      }
    ],
    "ProductAssignmentProductStructureUids": [],
    "VariantAssignmentProductStructureUids": [],
    "CatalogueAssignmentCatalogueUids": [],
    "AssetAssignmentAssetTypeUids": [],
    "VariantGroupAssignmentProductStructureUids": []
  }
]

Create a workflow

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/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

application/json

Responsestring · uuid

400

Bad Request

application/json

post

/v1/workflows

HTTPcURLJavaScriptPython

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

{
  "Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
  "Alias": "Workflow1",
  "Label": "Workflow 1",
  "DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
  "States": [
    {
      "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
      "Alias": "State1",
      "Label": "State 1",
      "Transitions": [
        {
          "Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
          "TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
          "Label": "To state 2",
          "Description": "Transition to state 2",
          "RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
        }
      ],
      "Color": "bg-gray-5 text-white"
    },
    {
      "Uid": "2974bab2-613d-429a-841d-98ab091249c8",
      "Alias": "State2",
      "Label": "State 2",
      "Transitions": [],
      "Color": "bg-yellow-l1 text-white"
    }
  ],
  "ProductAssignmentProductStructureUids": [
    "333be26b-af23-446b-973c-d190e9df676b"
  ],
  "VariantAssignmentProductStructureUids": [],
  "CatalogueAssignmentCatalogueUids": [],
  "AssetAssignmentAssetTypeUids": [],
  "VariantGroupAssignmentProductStructureUids": []
}

123e4567-e89b-12d3-a456-426614174000

Update a workflow

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/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

application/json

Responsestring · uuid

400

Bad Request

application/json

put

/v1/workflows

HTTPcURLJavaScriptPython

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

{
  "MoveEntitiesFromStateUidToStateUid": {
    "a5aba802-9260-4851-861b-bdacb9d40db1": "7d000a12-849f-405a-8ea7-0f3a0cf92048"
  },
  "Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
  "Alias": "Workflow1",
  "Label": "Workflow 1",
  "DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
  "States": [
    {
      "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
      "Alias": "State1",
      "Label": "State 1",
      "Transitions": [
        {
          "Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
          "TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
          "Label": "To state 2",
          "Description": "Transition to state 2",
          "RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
        }
      ],
      "Color": "bg-gray-5 text-white"
    },
    {
      "Uid": "2974bab2-613d-429a-841d-98ab091249c8",
      "Alias": "State2",
      "Label": "State 2",
      "Transitions": [],
      "Color": "bg-yellow-l1 text-white"
    }
  ],
  "ProductAssignmentProductStructureUids": [
    "333be26b-af23-446b-973c-d190e9df676b"
  ],
  "VariantAssignmentProductStructureUids": [],
  "CatalogueAssignmentCatalogueUids": [],
  "AssetAssignmentAssetTypeUids": [],
  "VariantGroupAssignmentProductStructureUids": []
}

123e4567-e89b-12d3-a456-426614174000

Get a workflow

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Id of workflow to get

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/v1/workflows/{uid}

HTTPcURLJavaScriptPython

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

[
  {
    "Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
    "Alias": "Workflow1",
    "Label": "Workflow 1",
    "DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
    "States": [
      {
        "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
        "Alias": "State1",
        "Label": "State 1",
        "Transitions": [
          {
            "Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
            "TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
            "Label": "To state 2",
            "Description": "Transition to state 2",
            "RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
          }
        ],
        "Color": "bg-gray-5 text-white"
      },
      {
        "Uid": "2974bab2-613d-429a-841d-98ab091249c8",
        "Alias": "State2",
        "Label": "State 2",
        "Transitions": [],
        "Color": "bg-yellow-l1 text-white"
      }
    ],
    "ProductAssignmentProductStructureUids": [
      "333be26b-af23-446b-973c-d190e9df676b"
    ],
    "VariantAssignmentProductStructureUids": [],
    "CatalogueAssignmentCatalogueUids": [],
    "AssetAssignmentAssetTypeUids": [],
    "VariantGroupAssignmentProductStructureUids": []
  },
  {
    "Uid": "c534744f-955c-4021-b1d0-4265212d3962",
    "Alias": "Workflow2",
    "Label": "Workflow 2",
    "DefaultStateUid": "fdf1dd9c-f80d-4f4b-a2ff-f65f25f59d54",
    "States": [
      {
        "Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
        "Alias": "State1",
        "Label": "State 1",
        "Transitions": [],
        "Color": "bg-gray-5 text-white"
      }
    ],
    "ProductAssignmentProductStructureUids": [],
    "VariantAssignmentProductStructureUids": [],
    "CatalogueAssignmentCatalogueUids": [],
    "AssetAssignmentAssetTypeUids": [],
    "VariantGroupAssignmentProductStructureUids": []
  }
]

Delete a workflow

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Id of workflow to delete

Responses

200

OK

No content

delete

/v1/workflows/{uid}

HTTPcURLJavaScriptPython

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

200

OK

No content