Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Welcome to Struct PIM 4
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

Workflows

PreviousWebhooksNextModels

Get a workflow

get
Authorizations
Path parameters
uidstring · uuidRequired

Id of workflow to get

Responses
200
OK
500
Internal Server Error
get
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
DELETE /v1/workflows/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content
  • GETGet all workflows in the system
  • POSTCreate a workflow
  • PUTUpdate a workflow
  • GETGet a workflow
  • DELETEDelete a workflow

Get all workflows in the system

get
Authorizations
Responses
200
OK
get
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

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
Responsestring · uuid
400
Bad Request
post
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"
  ]
}
123e4567-e89b-12d3-a456-426614174000

Update a workflow

put
Authorizations
Body

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
Responsestring · uuid
400
Bad Request
put
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"
  ]
}
123e4567-e89b-12d3-a456-426614174000