{
  "openapi": "3.0.1",
  "info": {
    "title": "Workspace Task Group",
    "description": "Create and administer the workspace task group.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Workspace Task Group",
      "description": "Create and administer the workspace task group."
    }
  ],
  "paths": {
    "/workspace-task-groups": {
      "post": {
        "summary": "Create a task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkspaceTaskGroup"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the task group.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        },
        "x-action-code": "Create",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/workspace-task-groups/by-fields": {
      "get": {
        "summary": "Search task groups by fields: name, identifier, from due date, to due date or status. You must provide at least one field.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "fromDueDate",
            "in": "query",
            "description": "The start date of the due date that you want to search. The date must be entered in the following format: \"YYYY-MM-DD\".",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "identifier",
            "in": "query",
            "description": "The unique identifier for identifying the task group.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "The task group name.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "The task group status. Values: 0=inactive, 1=working, 2=ready for approval, 3=approved, 4=ready to commit, 5=complete, 6=cancelled, 7=commit failed, 8=commit in progress, 9=committed, 10=ready to publish, 11=publish in progress, 12=published, 13=publish failed.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "toDueDate",
            "in": "query",
            "description": "The end date of the due date that you want to search. The date must be entered in the following format: \"YYYY-MM-DD\".",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroupCollection"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup"
          }
        },
        "x-expression-builder-class": "com.ibm.commerce.rest.admin.v2.content.util.ContentSearchExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All",
          "template": "/TaskGroup[search(name='$name$' and identifier='$identifier$' and status = '$status$' and dueDate >= '$fromDueDate$' and dueDate <= '$toDueDate$')]"
        },
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      }
    },
    "/workspace-task-groups/by-name-or-identifier": {
      "get": {
        "summary": "Search task groups by basic search term: name, identifier.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "searchText",
            "in": "query",
            "description": "The search text.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroupCollection"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup"
          }
        },
        "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder",
        "x-expression-builder-method": "formatExpression",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All",
          "template": "/TaskGroup[search(name='$searchText$' and identifier='$searchText$' and searchType='taskGroup-basic')]"
        },
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      }
    },
    "/workspace-task-groups/by-workspace-id": {
      "get": {
        "summary": "Get all task groups which reference the workspace ID.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "description": "The unique numeric ID for identifying the workspace.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroupCollection"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup",
            "x-support-paging": false
          }
        },
        "x-expression-template": "{_wcf.ap=IBM_Admin_All}/TaskGroup[TaskGroupIdentifier[ExternalIdentifier[ContainerIdentifier[(UniqueID='{workspaceId}')]]]]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}": {
      "get": {
        "summary": "Get the task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroup"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup[1]"
          }
        },
        "x-expression-template": "{_wcf.ap=IBM_Admin_All}/TaskGroup[TaskGroupIdentifier[UniqueID='{id}']]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      },
      "delete": {
        "summary": "Delete a task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      },
      "patch": {
        "summary": "Update a task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkspaceTaskGroup"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "changeTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ChangeTaskGroupType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/workspace-task-groups/{id}/activate": {
      "post": {
        "summary": "Activate a task group. The task group must be in the \"0: Inactive\" state before it can be activated.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Activate",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/approve": {
      "post": {
        "summary": "Approve a task group. The task group must be in \"2: Ready for Approval\" state in order to be approved.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Approve",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/cancel": {
      "post": {
        "summary": "Cancel a task group. The task group must be in the  \"0: Inactive\", \"1: Working\", \"2: Ready for approval\" or \"7: Commit failed\" state before it can be cancelled",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Cancel",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/changes": {
      "get": {
        "summary": "Get the changes of a task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroupChangeCollection"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupChangeHistories/taskGroupChangeHistory"
          }
        },
        "x-expression-template": "{_wcf.ap=IBM_Admin_TaskGroupChangeHistories}/TaskGroup[TaskGroupIdentifier[UniqueID='{id}']]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/changes/{changeId}/undo": {
      "post": {
        "summary": "Undo a task group change.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          },
          {
            "name": "changeId",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group change.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupChangeHistories/taskGroupChangeHistory[1]/historyUniqueId"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupChangeHistories/taskGroupChangeHistory[1]/historyUniqueId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "UndoChange",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/comments": {
      "get": {
        "summary": "Get the comments of a task group.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTaskGroupCommentCollection"
                }
              }
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupComments/taskGroupComment"
          }
        },
        "x-expression-template": "{_wcf.ap=IBM_Admin_TaskGroupComments}/TaskGroup/TaskGroupIdentifier[UniqueID='{id}']",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "getTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.GetTaskGroupType"
      },
      "post": {
        "summary": "Create a task group comment.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkspaceTaskGroupComment"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the task group comment.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupComments/taskGroupComment/userData/userDataField[@name='commentID']"
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "changeTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ChangeTaskGroupType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/workspace-task-groups/{id}/reactivate": {
      "post": {
        "summary": "Reactivate a task group. The task group must be in the \"2: Ready for approval\", \"3: Approved\", \"4: Ready to commit\" or \"7: Commit failed\" state before it can be returned to active.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "ReturnToActive",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    },
    "/workspace-task-groups/{id}/reject": {
      "post": {
        "summary": "Reject a task group. The task group must be in \"2: Ready for Approval\" state in order to be rejected.",
        "tags": [
          "Workspace Task Group"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the task group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/taskGroup[1]/taskGroupIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Reject",
        "x-expression-template": "/TaskGroup[1]",
        "x-facade-client-class": "com.ibm.commerce.content.facade.client.ContentFacadeClient",
        "x-facade-client-method": "processTaskGroup",
        "x-request-bod-class": "com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType"
      }
    }
  },
  "components": {
    "schemas": {
      "WorkspaceTaskGroup": {
        "type": "object",
        "properties": {
          "approvedDateTime": {
            "type": "string",
            "description": "The date and time of the task group approval. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "approvalDate"
          },
          "approverId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the approver.",
            "format": "int64",
            "x-entity-path": "taskGroupApprovers/taskGroupApprover[1]/approver[1]/uniqueID"
          },
          "comments": {
            "type": "array",
            "description": "The task group comments.",
            "items": {
              "$ref": "#/components/schemas/WorkspaceTaskGroupComment"
            },
            "x-entity-path": "taskGroupComments/taskGroupComment"
          },
          "committedDateTime": {
            "type": "string",
            "description": "The commit date and time of the task group promotion. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "commitDate"
          },
          "description": {
            "type": "string",
            "description": "The task group description.",
            "x-entity-path": "taskGroupDescription/description"
          },
          "dueDateTime": {
            "type": "string",
            "description": "The due date and time of the task group. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "dueDate"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the task group.",
            "format": "int64",
            "readOnly": true,
            "x-entity-path": "taskGroupIdentifier/uniqueID"
          },
          "identifier": {
            "type": "string",
            "description": "The unique identifier for identifying the task group.",
            "readOnly": true,
            "x-entity-path": "taskGroupIdentifier/externalIdentifier/identifier"
          },
          "name": {
            "type": "string",
            "description": "The task group name.",
            "x-entity-path": "taskGroupDescription/name"
          },
          "promotionDateTime": {
            "type": "string",
            "description": "The promotion date and time of the task group. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "promotionDate"
          },
          "quickPublish": {
            "type": "boolean",
            "description": "The task group is quick plublish or not."
          },
          "recurring": {
            "type": "boolean",
            "description": "The task group is recurring or not."
          },
          "status": {
            "type": "integer",
            "description": "The task group status. Values: 0=inactive, 1=working, 2=ready for approval, 3=approved, 4=ready to commit, 5=complete, 6=cancelled, 7=commit failed, 8=commit in progress, 9=committed, 10=ready to publish, 11=publish in progress, 12=published, 13=publish failed.",
            "format": "int32"
          },
          "workspaceId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the workspace.",
            "format": "int64",
            "x-entity-path": "taskGroupIdentifier/externalIdentifier/containerIdentifier/uniqueID"
          }
        },
        "description": "A task group.",
        "x-entity-class": "com.ibm.commerce.content.facade.datatypes.TaskGroupType"
      },
      "WorkspaceTaskGroupChange": {
        "type": "object",
        "properties": {
          "catalogId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the catalog of the changed object.",
            "format": "int64",
            "x-entity-path": "changeHistoryExtendedDataList/changeHistoryExtendedData[3]/extendedAttributeValue"
          },
          "createdBy": {
            "type": "string",
            "description": "The logon ID of the user who made the change.",
            "x-entity-path": "changedBy/logonID"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric identifier for identifying the change.",
            "format": "int64",
            "x-entity-path": "historyUniqueId"
          },
          "lastAction": {
            "type": "string",
            "description": "The last change action.",
            "x-entity-path": "action"
          },
          "objectCode": {
            "type": "string",
            "description": "The changed object code.",
            "x-entity-path": "objectCode"
          },
          "objectId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the changed object.",
            "format": "int64",
            "x-entity-path": "changeHistoryExternalIdentifier/primaryObjectUniqueId"
          },
          "objectType": {
            "type": "string",
            "description": "The changed object type.",
            "x-entity-path": "changeHistoryExternalIdentifier/primaryObjectType"
          },
          "oldObjectCode": {
            "type": "string",
            "description": "The old object code.",
            "x-entity-path": "changeHistoryExtendedDataList/changeHistoryExtendedData[2]/extendedAttributeValue"
          },
          "storeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the store.",
            "format": "int64",
            "x-entity-path": "changeHistoryExternalIdentifier/storeIdentifier/uniqueID"
          },
          "taskIdentifier": {
            "type": "string",
            "description": "The unique identifier for identifying the task.",
            "x-entity-path": "changeHistoryExtendedDataList/changeHistoryExtendedData[1]/extendedAttributeValue"
          },
          "taskName": {
            "type": "string",
            "description": "The task name.",
            "x-entity-path": "taskDescriptionType/name"
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The date and time when the change is made. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "changedTime"
          },
          "workspaceIdentifier": {
            "type": "string",
            "description": "The unique identifier for identifying the workspace.",
            "x-entity-path": "changeHistoryExternalIdentifier/workspaceIdentifier/identifier"
          }
        },
        "description": "A task group change.",
        "x-entity-class": "com.ibm.commerce.content.facade.datatypes.TaskGroupChangeHistoryType"
      },
      "WorkspaceTaskGroupChangeCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/WorkspaceTaskGroupChange"
            }
          }
        },
        "description": "A collection of task group changes."
      },
      "WorkspaceTaskGroupCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/WorkspaceTaskGroup"
            }
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of records to return.",
            "format": "int32"
          },
          "offset": {
            "type": "integer",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "format": "int32"
          }
        },
        "description": "A collection of task groups."
      },
      "WorkspaceTaskGroupComment": {
        "type": "object",
        "properties": {
          "comment": {
            "type": "string",
            "description": "The task group comment."
          },
          "createdBy": {
            "type": "string",
            "description": "The log ID of the user who posted the task group comment.",
            "x-entity-path": "postedBy/logonID"
          },
          "createdDateTime": {
            "type": "string",
            "description": "The posted date and time of the task group comment. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time",
            "x-entity-path": "postDate"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the comment.",
            "format": "int64",
            "x-entity-path": "userData/userDataField[@name='commentID']"
          }
        },
        "description": "A task group description.",
        "x-entity-class": "com.ibm.commerce.content.facade.datatypes.TaskGroupCommentType"
      },
      "WorkspaceTaskGroupCommentCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/WorkspaceTaskGroupComment"
            }
          }
        },
        "description": "A collection of task group comments."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}