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

UserTasks

PreviousVariantGroupsNextVariants

User tasks are used to create tasks for users in the system.

Get a user task from its uid

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of user task to get

Responses
200
OK
get
GET /v1/usertasks/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Created": "2025-05-16T00:29:29.340Z",
  "CreatedBy": "text",
  "Deadline": "2025-05-16T00:29:29.340Z",
  "Title": "text",
  "Description": "text",
  "Status": 0,
  "AssignedUsers": [
    "text"
  ],
  "AssignedUserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Comments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Comment": "text",
      "UserId": "text",
      "Name": "text",
      "Created": "2025-05-16T00:29:29.340Z",
      "LastModified": "2025-05-16T00:29:29.340Z",
      "IsSystemGenerated": true
    }
  ],
  "AttachedEntities": [
    {
      "EntityType": 0,
      "EntityId": "text",
      "Status": 0
    }
  ]
}

Delete a user task

delete
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of user task to delete

Responses
200
OK
400
Bad Request
delete
DELETE /v1/usertasks/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete a user task

delete
Authorizations
Path parameters
uidstring · uuidRequired

Uid of user task

Query parameters
commentUidstring · uuidOptional

Unique id of comment to delete

Responses
200
OK
400
Bad Request
delete
DELETE /v1/usertasks/{uid}/comments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
  • GETGet all user tasks in the system
  • POSTCreate a user task
  • PUTUpdate a user task
  • POSTGet a batch of user tasks by uids
  • GETGet a user task from its uid
  • DELETEDelete a user task
  • POSTCreate a comment on a user task
  • PUTUpdate a comment on a user task
  • DELETEDelete a user task

Get all user tasks in the system

get
Authorizations
Query parameters
pageinteger · int32OptionalDefault: 1
Responses
200
OK
Responseinteger · int32
get
GET /v1/usertasks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

1

Create a user task

post
Authorizations
Body

Model used to create a new user task

Uidstring · uuid | nullableOptional

Unique id of user task

AssignedUserGroupsstring · uuid[] | nullableOptional

Ids of user groups to which the task is assigned

AssignedUsersstring[] | nullableOptional

Ids of specific users to which the task is assigned

Titlestring | nullableOptional

Title for the task

Descriptionstring | nullableOptional

Description of the task

Deadlinestring · date-time | nullableOptional

Deadline for the task, if any

Responses
200
OK
400
Bad Request
post
POST /v1/usertasks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 263

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "AssignedUserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "AssignedUsers": [
    "text"
  ],
  "Title": "text",
  "Description": "text",
  "Deadline": "2025-05-16T00:29:29.340Z",
  "AttachedEntities": [
    {
      "EntityType": 0,
      "EntityId": "text"
    }
  ]
}
No content

Update a user task

put
Authorizations
Body

A task assigned to one or more users in the system

Uidstring · uuid | nullableOptional

Unique id of the task

Deadlinestring · date-time | nullableOptional

Deadline for the task, if any

Titlestring | nullableOptional

Title for the task

Descriptionstring | nullableOptional

Description of the task

Statusinteger · enumOptional

Represents a status of a user task

Possible values:
AssignedUsersstring[] | nullableOptional

Ids of specific users to which the task is assigned

AssignedUserGroupsstring · uuid[] | nullableOptional

Ids of user groups to which the task is assigned

Responses
200
OK
400
Bad Request
put
PUT /v1/usertasks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 274

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Deadline": "2025-05-16T00:29:29.340Z",
  "Title": "text",
  "Description": "text",
  "Status": 0,
  "AssignedUsers": [
    "text"
  ],
  "AssignedUserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "AttachedEntities": [
    {
      "EntityType": 0,
      "EntityId": "text"
    }
  ]
}
No content

Get a batch of user tasks by uids

post
Authorizations
Body
string · uuid[]Optional
Responses
200
OK
post
POST /v1/usertasks/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Created": "2025-05-16T00:29:29.340Z",
    "CreatedBy": "text",
    "Deadline": "2025-05-16T00:29:29.340Z",
    "Title": "text",
    "Description": "text",
    "Status": 0,
    "AssignedUsers": [
      "text"
    ],
    "AssignedUserGroups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "Comments": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Comment": "text",
        "UserId": "text",
        "Name": "text",
        "Created": "2025-05-16T00:29:29.340Z",
        "LastModified": "2025-05-16T00:29:29.340Z",
        "IsSystemGenerated": true
      }
    ],
    "AttachedEntities": [
      {
        "EntityType": 0,
        "EntityId": "text",
        "Status": 0
      }
    ]
  }
]

Create a comment on a user task

post
Authorizations
Path parameters
uidstring · uuidRequired

Uid of user task

Body

Model used to create comment on a user task

Uidstring · uuid | nullableOptional

Unique id of comment

Commentstring | nullableOptional

Comment itself

Responses
200
OK
400
Bad Request
post
POST /v1/usertasks/{uid}/comments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 63

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Comment": "text"
}
No content

Update a comment on a user task

put
Authorizations
Path parameters
uidstring · uuidRequired

Uid of user task

Body
Uidstring · uuidOptional
Commentstring | nullableOptional
Responses
200
OK
400
Bad Request
put
PUT /v1/usertasks/{uid}/comments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 63

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Comment": "text"
}
No content