Task and sub-task APIs

Companies that own or link to Agile Process Teams use these APIs to add, update, and complete tasks. Tasks are based on pre-defined task templates, which determine the default values that populate for the task, any sub-tasks that automatically generate, and the extent to which the task can be modified by users.

Tasks are split into one or more sub-tasks, which are smaller, assignable portions of work that are completed as part of of the parent task. Sub-tasks are attached to tasks and managed by separate APIs.

Use the Template APIs to manage the task templates and any template-defined sub-tasks for your company.

Add Task

Owners and Partners use this API to add a new task to the Owner's company network, including any initial comments or file attachments. The response returns a generated identifier for the new task.

New tasks are assigned the ToDo base state by default.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:add-task:v4.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  templateId String

Required. The identifier for the template. This cannot be changed after the task is added.

If the template has sub-tasks defined, the sub-tasks will be added automatically to the new task.
  aptBusinessObjectSummary String Required. A brief summary of the task. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the task. Provides additional information about the purpose of the task. Cannot exceed 5000 characters.
  businessPriority Enum

Required. The urgency with which the task needs to be resolved.

Valid values:
  • LOW - The task has low business priority.
  • MEDIUM – The task has medium business priority.
  • HIGH – The task has high business priority.
  • CRITICAL – The task is critical.
  completionDueDate Number The date that the task must be completed by. If omitted, the default due date is calculated by adding the number of days defined in the template completionRequiredWithinDays to the current date.
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the task's completion. If omitted, defaults to the business area defined in the template or, if unvailable, to the job function defined for the responsible party; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the task is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for completing the task is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for completing the task is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the task is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the task is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the task is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the task is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the task is part of an Operations team.
  • PACKAGING – The user responsible for completing the task is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the task is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the task is part of a Project Management team.
  • PURCHASING – The user responsible for completing the task is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the task is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the task is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the task is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the task is part of a Supply Chain team.
  responsiblePartyAtPartner String

The person from the Owner company that owns the task from the Owner's side and is responsible for the task's completion. If omitted, defaults to the responsible party defined in the template or, if not available,to the department null (i.e. the system Unassigned user).
  isAtRisk Boolean

Indicates whether the task is considered at risk by the responsible party from the Owner company.

Valid values:
  • true – Yes, the task is at risk.
  • false – (default) No, the task is not at risk.
  atRiskNote String Any detailed notes regarding the task's risk provided by the responsible party from the Owner company. Cannot exceed 5000 characters.
  isVisible Boolean

Required. Determines whether process team members from the Partner company associated with the task can view the task being added.

Valid values:
  • true – (default) Yes, users from the Partner company associated with the task can view the task being added.
  • false – No, only users from the Owner company can view the task and any comments or attachments, regardless of the visibilityType values.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the task (e.g. PO Number 1896155149).
    referenceTransactionType String

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  relatedProcesses Array

One or more processes to link to the task as a related process (e.g. a change request that caused an incident, a previously occurring incident).

This must be an existing process in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current incident.

Valid values:

  • RELATES_TO – The linked process is related to the current incident.
  • BLOCKS – The linked process prevents the current incident’s resolution.
  • BLOCKED_BY – The current incident prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current incident.
  • CONTAINED_BY – The current incident is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current incident's resolution.
  • DEPENDENCY_FOR – The current incident affects the linked process's resolution.
  aptCommentBox Object Contains any comments or files to attach to the task.
    aptComment Array One or more comments about the task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task can view the comment.
    addAttachment Array One or more relevant files to attach to the task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-task:v4",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "templateId": "ff060ac0-035d-11eb-8738-0242ac110017",
        "aptBusinessObjectSummary": "Quarterly Purchase Order Tasks",
        "aptBusinessObjectDescription": "Tasks for recurring purchase orders",
        "businessPriority": "HIGH",
        "completionDueDate": 1651133945000, 
        "responsiblePartyAtCompany": "bb75c388-16f7-4a18-9c77-f418d928359e",
        "responsibleDepartmentAtCompany": "SUPPLY_CHAIN",
        "isAtRisk": false,
        "referenceIdentifiers": {
            "referenceTransactionType": "BILL_OF_LADING",
            "value": "GTIN-1161187176294956"
        },
        "relatedProcesses": [
            {
                "processId": "c8c2b7ab-fcfd-448e-8964-798e42fb9aea",
                "processType": "incident",
                "relationship": "Contains"
            }
        ],
        "aptCommentBox": [
            {
                "aptComment": {
                    "commentText": "add DSI.",
                    "visibilityType": "Public"
                },
                "addAttachment": [
                    {
                        "fileSize": "5mb",
                        "fileName": "File1",
                        "requestIdentifier": "fc58cbf8-1098-4f66-bf37-763922bd36b3",
                        "visibilityType": "Public"
                    }
                ]
            }
        ]
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:add-task-response:v4.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new task.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-task-response:v4",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "a67d7261-33b1-4be6-9760-61ae8fe9eed3"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Edit Task

Owners and Partners use this API to do the following: 

  • Modify an existing task with new, updated, or corrected information (e.g. adding a description, updating the responsible party, fixing a typo).
  • Update the workflow state (e.g. manually transitioning the base state from ToDo to InProgress to indicate that the work assigned in the task has started).
Use the following APIs to modify other portions of the task process:

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:edit-task:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the task to modify.
  aptBusinessObjectSummary String A brief summary of the task. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the incident. Provides additional information about the purpose of the incident. Cannot exceed 5000 characters.
  businessPriority Enum

The urgency with which the task needs to be resolved.

Valid values:
  • LOW - The task has low business priority.
  • MEDIUM – The task has medium business priority.
  • HIGH – The task has high business priority.
  • CRITICAL – The task is critical.
  completionDueDate Number The date that the task must be completed by.
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the task's completion. If omitted, defaults to the business area defined in the template or, if unvailable, to the job function defined for the responsible party; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the task is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for completing the task is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for completing the task is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the task is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the task is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the task is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the task is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the task is part of an Operations team.
  • PACKAGING – The user responsible for completing the task is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the task is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the task is part of a Project Management team.
  • PURCHASING – The user responsible for completing the task is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the task is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the task is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the task is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the task is part of a Supply Chain team.
  responsiblePartyAtPartner String

The person from the Owner company that owns the task from the Owner's side and is responsible for the task's completion. If omitted, defaults to the responsible party defined in the template or, if not available,to the department null (i.e. the system Unassigned user).
  isAtRisk Boolean

Indicates whether the task is considered at risk by the responsible party from the Owner company.

Valid values:
  • true – Yes, the task is at risk.
  • false – (default) No, the task is not at risk.
  atRiskNote String Any detailed notes regarding the task's risk provided by the responsible party from the Owner company. Cannot exceed 5000 characters.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the task (e.g. PO Number 1896155149).
    referenceTransactionType String

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  relatedProcesses Array

One or more processes to link to the task as a related process (e.g. a change request that caused an incident, a previously occurring incident).

This must be an existing process in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current incident.

Valid values:

  • RELATES_TO – The linked process is related to the current incident.
  • BLOCKS – The linked process prevents the current incident’s resolution.
  • BLOCKED_BY – The current incident prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current incident.
  • CONTAINED_BY – The current incident is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current incident's resolution.
  • DEPENDENCY_FOR – The current incident affects the linked process's resolution.
  newBaseState String

Transitions the base workflow state of the task from ToDo to InProgress. This cannot be reversed; tasks in the InProgress state can only be transitioned to Closed. The following must be true to update the base state:

  • The currentBaseState must be ToDo.
  • The responsiblePartyAtCompany cannot be blank or null.

Valid value is InProgress.
  newSubBaseState String

Transitions the sub-workflow state. Valid values are defined in the sub-workflow.

For more information on customizing workflows and sub-state transitions, see the Customize Help Center.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-task:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "dcceedb1-fc3c-45d8-9d45-9e159f901d2c",
        "newBaseState": "InProgress"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:edit-task-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the modified task.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-task-response:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Copy Task

Owners use this API to copy an existing task. Boolean fields determine which section values are copied to the new task (e.g. copy all values from the General section but not the related processes from the original task). The new task is created with a new identifier and automatically set to the ToDo base workflow state.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:copy-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the existing task to copy.
  aptBusinessObjectSummary String Required. A brief summary of the task. Cannot exceed 255 characters.
  copyGeneralInfo Boolean

Required. Indicates whether to copy the General section values from the original task to the new task.

Valid values:
  • true - Yes, copy all General section values to the new task.
  • false - No, do not copy the General section values to the new task.
  copySubTasks Boolean

Required. Indicates whether to copy the sub-tasks from the original task to the new task.

Valid values:
  • true - Yes, copy all sub-tasks to the new task.
  • false - No, do not copy the sub-tasks to the new task.
  copyRelatedProcesses Boolean

Required. Indicates whether to copy the Related Processes from the original task to the new task.

Valid values:
  • true - Yes, copy all Related Processes to the new task.
  • false - No, do not copy the Related Processes to the new task.

Example

Copy 
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3",
        "aptBusinessObjectSummary": "Copy of Task 01234",
        "copyGeneralInfo": true,
        "copySubTasks": true,
        "copyRelatedProcesses": true
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:copy-task-response:v2.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new task.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-task-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "i4XDap"
    },
    "payload": {
        "id": "c8fae272-faa9-4f51-9a49-68f67930d4db"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Close Task

Owners use this API to close a task to indicate the work is complete. The closed task transitions from its current base state (either ToDo or InProgress) to a Closedstate. Closed tasks can be edited or reopened by users with the requisite permissions.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:close-task:v2.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the existing task to close.
  resolutionType Enum Required.The reason the task is being closed. Valid values depend on the current base state of the task: 
  • If task currentBaseState = InProgress, valid values:
    • COMPLETED – The task is complete. All sub-tasks must be closed or removed from the task.
    • PARTIALLY_COMPLETED – The activity defined for the task is partially complete.
    • CANCELLED – The task is cancelled.
  • If currentBaseState = ToDo, valid value:
    • CANCELLED – The task is cancelled.
  closingStatement String Any additional comments about the task's closure. Cannot exceed 5000 characters.
  aptCommentBox Object Contains any comments or files to attach to the task.
    aptComment Array One or more comments about the task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task can view the comment.
    addAttachment Array One or more relevant files to attach to the task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-task:v2",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "ff060ac0-035d-11eb-8738-0242ac110017",
        "taskResolutionType": "COMPLETED",
        "closingStatement": "All assigned purchase order sub-tasks completed. Final task approved to be closed by J. Watson.",
        "aptCommentBox": [
            {
                "aptComment": {
                    "commentText": "add DSI.",
                    "visibilityType": "Public"
                },
                "addAttachment": [
                    {
                        "fileSize": "5mb",
                        "fileName": "File1",
                        "requestIdentifier": "fc58cbf8-1098-4f66-bf37-763922bd36b3",
                        "visibilityType": "Public"
                    }
                ]
            }
        ]
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:close-task-response:v2.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the closed task.
  message String Required. The message confirming that the task was closed.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-task-response:v2",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "ff060ac0-035d-11eb-8738-0242ac110017",
        "message": "Task closed successfully."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Reopen Task

Owners use this API to reopen a closed task with all information intact. Returns the identifier for the reopened task with the base workflow state updated from from Closed to InProgress. Reopened tasks cannot be manually transitioned back to the ToDo state.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:reopen-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the closed task to reopen.
  aptCommentBox Object Contains any comments or files to attach to the task.
    aptComment Array One or more comments about the task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task can view the comment.
    addAttachment Array One or more relevant files to attach to the task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "c8fae272-faa9-4f51-9a49-68f67930d4db",
        "aptCommentBox": {
            "aptComment": {
                "commentText": "Reopening Task 01234",
                "visibilityType": "public"
            }
        }
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:reopen-task-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the reopened task.
  message String Required. The message indicating the task is reopened.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-task-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "2rw4zz"
    },
    "payload": {
        "id": "c8fae272-faa9-4f51-9a49-68f67930d4db",
        "message": "Task reopened successfully."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Add Sub-Task To Task

Owners and Partners use this API to add a new sub-task to an existing task. Partners can only add sub-tasks to tasks that contain at least one sub-task that they have already been assigned to.

Sub-tasks can be added only if isAddRemoveSubtaskAllowed is set to true in the task template .

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:add-sub-task-to-task:v4.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  taskId String Required. The identifier for task the new sub-task is being added to.
  subTaskName String Required. The name of the new sub-task to add. Cannot exceed 255 characters.
  subTaskType String Required. The type of sub-task to add. Can be used as a way to categorize sub-tasks.
  startDate Integer The start date for the sub-task.
  subTaskDueDate Integer The date the sub-task is due.
  partnerCompany Object Conditionally required if isSubmittedToPartner is true. The identifier number and type for the Partner company associated with the sub-task.
If the Partner company is adding the sub-task, TraceLink automatically populates this element with the Partner's information, regardless of the value entered.
    partnerId String The identifier for the Partner company that the sub-task is being submitted to. This field cannot be modified after the sub-task is submitted to the Partner (isSubmittedToPartner= true).
If the Partner company is adding the sub-task, TraceLink automatically populates this element with the Partner's information, regardless of the value entered.
    toIdType Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
If the Partner company is adding the sub-task, TraceLink automatically populates this element with the Partner's information, regardless of the value entered.
  responsibleDepartmentAtPartner String The business area of the Partner company that is responsible for the sub-task's completion. If omitted, defaults to the business area defined in the template or, if unvailable, to the job function defined for the responsible party; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the sub-task is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for completing the sub-task is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for completing the sub-task is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the sub-task is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the sub-task is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the sub-task is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the sub-task is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the sub-task is part of an Operations team.
  • PACKAGING – The user responsible for completing the sub-task is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the sub-task is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the sub-task is part of a Project Management team.
  • PURCHASING – The user responsible for completing the sub-task is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the sub-task is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the sub-task is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the sub-task is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the sub-task is part of a Supply Chain team.
  responsiblePartyAtPartner String

The person from the Partner company that owns the sub-task from the Partner's side and is responsible for the sub-task's completion. If omitted, defaults to the responsible party defined in the template or, if not available,to the department null (i.e. the system Unassigned user).
  currentlyAssignedCompanyUsers Array List of one or more users at the Owner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of one or more users at the Partner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
  isSubmittedToPartner Boolean

If the user adding the sub-task is a member of the Owner company with permission to submit the sub-task to Partner, this indicates whether the sub-task is submitted to the Partner specified in partnerId during the add event. Valid values:

  • true – Submit the sub-task to Partner (partnerId cannot be empty). The sub-task is made visible to the process team members from the Partner company.
  • false – Do not submit the sub-task to Partner. The sub-task is not visible to the process team members from the Partner company. The sub-task can be submitted to the Partner manually using the relevant Submit to Partner API.
After the sub-task is submitted to the specified Partner, the partnerId cannot be modified.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the sub-task (e.g. PO Number 1896155149).
    referenceTransactionType String

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  relatedProcesses Array

One or more processes to link to the sub-task as a related process (e.g. a change request that caused an incident, a previously occurring incident).

This must be an existing process in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current incident.

Valid values:

  • RELATES_TO – The linked process is related to the current incident.
  • BLOCKS – The linked process prevents the current incident’s resolution.
  • BLOCKED_BY – The current incident prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current incident.
  • CONTAINED_BY – The current incident is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current incident's resolution.
  • DEPENDENCY_FOR – The current incident affects the linked process's resolution.
  aptCommentBox Object Contains any comments or files to attach to the sub-task.
    aptComment Array One or more comments about the sub-task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the sub-task can view the comment.
    addAttachment Array One or more relevant files to attach to the sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the sub-task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-sub-task-to-task:v4",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "taskId": "ff060ac0-035d-11eb-8738-0242ac110017",
        "subTaskName": "Sub-Task 01234",
        "subTaskType": "Sub-Task Type ABC",
        "startDate": 1651133945000,
        "subTaskDueDate": 1641133945000,
        "partnerCompany": {
            "partnerId": "be9c8cea-72bc-459c-97b9-ef3f7c73ccc8",
            "toIdType": "companyMasterData"
        },
        "responsiblePartyAtPartner": "bb75c388-16f7-4a18-9c77-f418d928359e",
        "responsibleDepartmentAtPartner": "SUPPLY_CHAIN",
        "currentlyAssignedCompanyUsers": [
            "bb75c388-16f7-4a18-9c77-f418d928359e"
        ],
        "currentlyAssignedPartnerUsers": [
            "ff060ac0-035d-11eb-8738-0242ac110017",
            "feb32fd0-035d-11eb-bb87-0242ac110017"
        ],
        "isSubmittedToPartner": false,
        "referenceIdentifiers": {
            "referenceTransactionType": "BILL_OF_LADING",
            "value": "GTIN-1161187176294956"
        },
        "relatedProcesses": [
            {
                "processId": "c8c2b7ab-fcfd-448e-8964-798e42fb9aea",
                "processType": "incident",
                "relationship": "Contains"
            }
        ],
        "aptCommentBox": [
            {
                "aptComment": {
                    "commentText": "add DSI.",
                    "visibilityType": "Public"
                },
                "addAttachment": [
                    {
                        "fileSize": "5mb",
                        "fileName": "File1",
                        "requestIdentifier": "fc58cbf8-1098-4f66-bf37-763922bd36b3",
                        "visibilityType": "Public"
                    }
                ]
            }
        ]
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:add-sub-task-to-task-response:v4.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new sub-task.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-sub-task-to-task-response:v4",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "c9fcb6cf-c193-4d14-a45e-53eef9564e7a"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Edit Sub-Task On Task

Owners and Partners use this API to do the following: 

  • Modify a sub-task associated with a parent task with new, updated, or corrected information (e.g. adding Partner information, fixing a typo, updating the assigned users).
  • Update the workflow state (e.g. manually transitioning the base state from ToDo to InProgress to indicate that the work assigned in the sub-task has begun).
Use the comment APIs to add, edit, or delete comments and file attachments from an existing task or sub-task.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:edit-sub-task-on-task:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the sub-task.
  subTaskName String The name of the sub-task. Cannot exceed 255 characters.
  subTaskType String Required. The type of sub-task to add. Can be used as a way to categorize sub-tasks.
  startDate Integer The start date for the sub-task.
  subTaskDueDate Integer The date the sub-task is due.
  partnerCompany Object Conditionally required if isSubmittedToPartner is true. The identifier number and type for the Partner company associated with the sub-task.
    partnerId String Required. The identifier for the Partner company that the sub-task is being submitted to. This field cannot be modified after the sub-task is submitted to the Partner (isSubmittedToPartner= true).
    toIdType Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  responsibleDepartmentAtCompany String The business area of the Partner company that is responsible for the sub-task's completion. If omitted, defaults to the business area defined in the template or, if unvailable, to the job function defined for the responsible party; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the sub-task is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for completing the sub-task is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for completing the sub-task is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the sub-task is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the sub-task is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the sub-task is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the sub-task is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the sub-task is part of an Operations team.
  • PACKAGING – The user responsible for completing the sub-task is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the sub-task is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the sub-task is part of a Project Management team.
  • PURCHASING – The user responsible for completing the sub-task is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the sub-task is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the sub-task is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the sub-task is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the sub-task is part of a Supply Chain team.
  responsiblePartyAtCompany String

The person from the Partner company that owns the sub-task from the Partner's side and is responsible for the sub-task's completion. If omitted, defaults to the responsible party defined in the template or, if not available,to the department null (i.e. the system Unassigned user).
  currentlyAssignedCompanyUsers Array List of one or more users at the Owner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of one or more users at the Partner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the sub-task (e.g. PO Number 1896155149).
    referenceTransactionType String

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  relatedProcesses Array

One or more processes to link to the sub-task as a related process (e.g. a change request that caused an incident, a previously occurring incident).

This must be an existing process in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current incident.

Valid values:

  • RELATES_TO – The linked process is related to the current incident.
  • BLOCKS – The linked process prevents the current incident’s resolution.
  • BLOCKED_BY – The current incident prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current incident.
  • CONTAINED_BY – The current incident is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current incident's resolution.
  • DEPENDENCY_FOR – The current incident affects the linked process's resolution.
  newBaseState String

Transitions the base workflow state of the sub-task from ToDo to InProgress. This cannot be reversed; sub-tasks in the InProgress state can only be transitioned to Closed (using the Close Sub-Task API). The following must be true to update the base state:

  • The currentBaseState must be ToDo.
  • The responsiblePartyAtCompany cannot be blank or null.

Valid value is InProgress.
  newSubBaseState String

Transitions the sub-workflow state. Valid values are defined in the sub-workflow.

For more information on customizing workflows and sub-state transitions, see the Customize Help Center.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-sub-task-on-task:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "c9fcb6cf-c193-4d14-a45e-53eef9564e7a",
        "currentlyAssignedPartnerUsers": [
            "ff060ac0-035d-11eb-8738-0242ac110017",
            "feb32fd0-035d-11eb-bb87-0242ac110017"
        ],
        "newBaseState": "InProgress"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:edit-sub-task-on-task-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the modified sub-task.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-sub-task-on-task-response:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "c9fcb6cf-c193-4d14-a45e-53eef9564e7a"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

List Sub-Task For Task

Owners and Partners use this API to view all sub-tasks associated with a specified task. Returns all sub-tasks currently attached to the task (isDelete = false). Partner users can only view sub-tasks that they are assigned to.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:list-sub-task-for-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the task to return the list of sub-tasks for.

Example

Copy 
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-sub-task-for-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:list-sub-task-for-task-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  subTask Object

Contains the list of sub-tasks attached to the specified task.
    subTaskId String The identifier for the sub-task.
    subTaskType String The type of sub-task to add. Can be used as a way to categorize sub-tasks.
    subTaskDueDate Integer The date the sub-task is due.
    subTaskName String The name of the sub-task. Cannot exceed 255 characters.
    subTaskStatus String The current workflow state of the sub-task.
    startDate Integer The start date for the sub-task.
    creationDateTime Integer The date and time the sub-task was created.
    lastUpdatedDateTime Integer The date and time the sub-task was last modified.
   

taskIsVisible

 Boolean

Indicates whether process team members from the Partner company associated with the sub-task can view the task. Valid values:

  • true – Yes, users from the Partner company associated with the task can view the task being added.
  • false – No, only users from the Owner company can view the task and any comments or attachments.
    currentlyAssignedCompanyUsers Array List of one or more users at the Owner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
    currentlyAssignedPartnerUsers Array List of one or more users at the Partner company assigned to the sub-task. If omitted, defaults to null (i.e. the system Unassigned user).
    lastUpdatedByUserName String The user name of the person that modified the sub-task most recently.
    partnerCompanyName String The name of the Partner company that the sub-task is currently assigned to.

Example

Copy 
{
   "header":{
      "headerVersion":1,
      "eventName":"agile-process-teams:list-sub-task-for-task-response:v1",
      "ownerId":"94f94f37-2772-4b39-8041-9c2dcfcfff82",
      "isErr":false,
      "errCode":"200_OK",
      "licensePlate":"vXPsFz"
   },
   "payload":{
      "subTask":{
         "subTaskId":"11935532-e603-4700-9aed-b14b4ac2a7d8",
         "subTaskType":"Type XYZ",
         "subTaskDueDate":1632576147000,
         "subTaskName":"Sub-Task 01234",
         "subTaskStatus":"InProgress",
         "creationDateTime":1655114197274,
         "lastUpdatedDateTime":1655114197274,
         "taskIsVisible":false,
         "currentlyAssignedCompanyUsers":[
            "9cba9110-0358-11eb-8738-0242ac110017",
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
         ],
         "currentlyAssignedPartnerUsers":[
            "7713c743-dd56-4074-83f3-c961b52b1519"
         ],
         "lastUpdatedByUserName": "James Roberts",
         "partnerCompanyName": "ABC Inc"
      },
      {
         "subTaskId":"945feb8e-09a7-4fef-9a8a-b3c5b56f87d3",
         "subTaskType":"Type XYZ",
         "subTaskDueDate":1632576147000,
         "subTaskName":"Sub-Task 56789",
         "subTaskStatus":"Closed",
         "creationDateTime":1655114197274,
         "lastUpdatedDateTime":1655114197274,
         "taskIsVisible":true,
         "currentlyAssignedCompanyUsers":[
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
         ],
         "currentlyAssignedPartnerUsers":[
            "91abce50-6359-45dd-843d-94b1b4a3c6b0",
            "03dcb295-d2cb-4c8f-8922-c4c52b6b7648"
         ],
         "lastUpdatedByUserName": "Robert James",
         "partnerCompanyName": "ABC Inc"
      }
   }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Submit Sub-Task To Partner

Owners use API to manually submit a sub-task to the Partner specified in the sub-task partnerId. This cannot be undone.

Upon successful response:

  • isSubmittedToPartner updates to true.
  • The Partner is notified of the sub-task on their network.
  • The parent task and sub-task becomes visible to the Partner.
Submitting the sub-task to Partner does not update the sub-task workflow state. Use the Edit Sub-Task On Task API to manually transition the sub-task from one workflow state to another.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:submit-sub-task-to-partner:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the sub-task to submit to the Partner company specified in the partnerId. The sub-task must be attached to an open task.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:submit-sub-task-to-partner:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "d04d3b43-64e5-41d2-87b6-a3b42241b176"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:submit-sub-task-to-partner-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the sub-task submitted to the associated Partner company.
  message String Required. The message indicating the sub-task is submitted to the Partner.

Example

Copy 
{
    "header" : {
        "headerVersion" : 1,
        "eventName" : "agile-process-teams:submit-sub-task-to-partner-response:v1",
        "ownerId" : "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr" : false,
        "errCode" : "200_OK",
        "licensePlate" : "ofGzDO"
    },
    "payload" : {
        "id": "d04d3b43-64e5-41d2-87b6-a3b42241b176",
        "message": "Sub-task successfully submitted to partner."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Close Sub-Task

Owners and Partners use this API to close a sub-task to indicate the assigned work is completed or no longer applicable. The closed sub-task transitions from its current base state (either To Do or In Progress) to a Closed state. Closed sub-tasks can be edited or reopened by users with the requisite permissions.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:close-sub-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the existing sub-task to close.
  closingStatement String Any additional comments about the task's closure. Cannot exceed 5000 characters.
  aptCommentBox Object Contains any comments or files to attach to the sub-task.
    aptComment Array One or more comments about the sub-task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the sub-task can view the comment.
    addAttachment Array One or more relevant files to attach to the sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the sub-task can view the attached file.
      requestidentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-sub-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:close-sub-task-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the closed sub-task.
  message String Required. The message confirming that the sub-task was closed.

Example

Copy 
{
    "header" : {
        "headerVersion" : 1,
        "eventName" : "agile-process-teams:close-sub-task-response:v1",
        "ownerId" : "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr" : false,
        "errCode" : "200_OK",
        "licensePlate" : "ofGzDO"
    },
    "payload" : {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3",
        "message": "Sub-task successfully removed."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Reopen Sub-Task

Owners and Partners use this API to reopen a closed sub-task with all information intact. Returns the identifier for the reopened sub-task with the base workflow state updated from Closed to InProgress. Reopened sub-tasks can only be returned to the InProgress base state; they cannot be manually transitioned back to ToDo.

A sub-task cannot be reopened if the parent task is already closed. The parent task must be reopened first using the Reopen Task API.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:reopen-sub-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the closed sub-task to reopen.
  aptCommentBox Object Contains any comments or files to attach to the sub-task.
    aptComment Array One or more comments about the sub-task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the sub-task can view the comment.
    addAttachment Array One or more relevant files to attach to the sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the sub-task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-sub-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:reopen-sub-task-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the reopened sub-task.
  message String Required. The message indicating the sub-task is reopened.

Example

Copy 
{
    "header" : {
        "headerVersion" : 1,
        "eventName" : "agile-process-teams:reopen-sub-task-response:v1",
        "ownerId" : "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr" : false,
        "errCode" : "200_OK",
        "licensePlate" : "ofGzDO"
    },
    "payload" : {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3",
        "message": "Sub-task successfully repened."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Remove Sub-Task From Task

Owners use this API to remove a sub-task from a task. Upon successful removal, the sub-task cannot be re-added and will display as a deleted (isDelete = true) in the activity history.

The following must be true to remove a sub-task: 

  • The task template must allow sub-tasks to be modified (isAddRemoveSubtaskAllowed must be true in the task template).
  • The sub-task cannot already be submitted to a Patner (isSubmittedToPartner must be false in the sub-task).

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:remove-sub-task-from-task:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  id String Required. The identifier for the sub-task to remove.

Example

Copy 
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:remove-sub-task-from-task:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:remove-sub-task-from-task-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the removed sub-task
  message String Required. The message indicating the sub-task was removed from the task.

Example

Copy 
{
    "header" : {
        "headerVersion" : 1,
        "eventName" : "agile-process-teams:remove-sub-task-from-task-response:v1",
        "ownerId" : "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr" : false,
        "errCode" : "200_OK",
        "licensePlate" : "ofGzDO"
    },
    "payload" : {
        "id": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d3",
        "message": "Sub-task successfully removed."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Add Comment

Owners and Partners use this API to add comments and attach files to an existing task or sub-task.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:add-comment-for-process:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task or sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  processId String Required. The identifier for the task or sub-task being commented on.
  processType String

Required. The type of process. Valid values:

  • task – The process is a Task type.
  • subTask – The process is a Sub-task type.
  aptCommentBox Object Contains any comments or files to attach to the task or sub-task.
    aptComment Array One or more comments about the task or sub-task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task or sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the comment.
    addAttachment Array One or more relevant files to attach to the task or sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task or sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-comment-for-process:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "processType": "task",
        "aptCommentBox":{
            "aptComment":{
                "commentText": "Attaching latest order documentation per Jen's request",
                "visibilityType": "Public"
            },
            "addAttachment":[
                {
                    "fileName" : "INC-4098_shipping-order.pdf",
                    "fileSize" : "3mb",
                    "visibilityType": "Public",
                    "requestIdentifier": "4383a452-1e19-4aa6-98fe-84c9f7a3bd16"
                }
            ]
        }
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:add-comment-for-process-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  commentId String Required. The identifier for the new comment.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-comment-for-process-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "commentId": "a67d7261-33b1-4be6-9760-61ae8fe9eed3"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Edit Comment

Owners and Partners use this API to modify or remove existing comments and files attached to an task or sub-task. Comments and attachments can only be edited by the user that created the comment or attachment.

Upon successful removal, the attachment is marked deleted (isDelete = true) and will display as a deleted comment in the activity history for the task or sub-task.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:edit-comment-for-process:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task or sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  commentId String Required. The identifier for the comment to modify.
  processType Enum

Required. The type of process. Valid values:

  • task – The process is a Task type.
  • subTask – The process is a Sub-task type.
  aptCommentBox Object Contains any comments or files to attach to the task or sub-task.
    aptComment Array One or more comments about the task or sub-task or explanations for the attachments that the user wants to provide.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task or sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the comment.
    addAttachment Array One or more relevant files to attach to the task or sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task or sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.
    removeAttachment Array One or more existing attachments to remove from the task or sub-task.
      attachmentId String

The identifier for the attachment to remove.

The user removing the attachment must be a process team member of the company that originally added the attachment (e.g. a document attached by a Partner company user cannot be removed by an Owner company user).

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-comment-for-process:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "commentId": "a67d7261-33b1-4be6-9760-61ae8fe9eed3",
        "processType": "task",
        "aptCommentBox": {
            "aptComment": {
                "commentText": "Incorrect order uploaded",
                "visibilityType": "Public"
            },
            "removeAttachment" : [
                "9d84028a-abcd-11eb-90b4-e933a8e8da5e"
            ]
        }
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:edit-comment-for-process-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  commentId String Required. The identifier for the modified comment.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-comment-for-process-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "jzC1wS"
    },
    "payload": {
        "commentId": "a67d7261-33b1-4be6-9760-61ae8fe9eed3"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

List Comments

Owners and Partners use this API to return all comments and attachments for a specified task or sub-task. Return includes all comments and attachments associated with the task or sub-task that the user is authorized to view. Comments and files are listed with additional information (e.g. comment identifier, AWS S3 location of the file), and any deleted items are marked as isDelete = true.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:list-comment-for-process:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task or sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  processId String Required. The identifier for the task or sub-task to return the list of comments for.
  processType String

Required. The type of process. Valid values:

  • task – The process is a Task type.
  • subTask – The process is a Sub-task type.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-comments-for-process:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "processType": "task"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:list-comments-for-process-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  commentsAndAttachments Object Contains the list of comments and attachments associated with the task or sub-task.
    aptComment Array One or more comments about the task or sub-task or descriptions of the attachments.
      id String The identifier for the comment.
      commentText String The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the task or sub-task can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the comment.
    aptAttachments Array One or more relevant files to attach to the task or sub-task. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      id String The identifier for the attached file.
      fileName String The name of the file. Cannot exceed 255 characters.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the task or sub-task can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the task or sub-task can view the attached file.
      fileExtension String The file type of the attachment (e.g. jpg, txt).
      isDelete Boolean

Indicates whether the file is marked as deleted from the task or sub-task. Valid values:

  • true – Yes, the file is marked as deleted and has been removed from the task or sub-task record.
  • false – No, the file is not marked as deleted from the task or sub-task.
      fileS3Location String The AWS S3 location where the file is stored.
      fileSize String The size of the file. Cannot exceed 25MB.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-comments-for-process-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "t1PCsQ"
    },
    "payload": {
        "commentsAndAttachments": [
            {
                "aptComment": {
                    "id": "3bf5221e-503d-11eb-bcb4-f93431755cb0",
                    "commentText": "My comment",
                    "visibilityType": "Public",
                    "aptAttachments": [
                        {
                            "id": "3c3b2bd0-503d-11eb-bcb4-c78a7a2c7004",
                            "fileName": "fileName",
                            "visibilityType": "Public",
                            "fileExtension": "jpg",
                            "isDelete": false,
                            "fileS3Location": "fileS3Location",
                            "fileSize": "fileSize",
                            "requestIdentifier": "requestIdFromFileManager"
                        }
                    ]
                }
            },
            {
                "aptComment": {
                    "id": "b56fb281-503f-11eb-bcb4-9d4de16ff2a2",
                    "commentText": "My comment2",
                    "visibilityType": "Public",
                    "aptAttachments": [
                        {
                            "id": "b5cacad3-503f-11eb-bcb4-bf0cf8a90d01",
                            "fileName": "fileName",
                            "visibilityType": "Public",
                            "fileExtension": "jpg",
                            "isDelete": false,
                            "fileS3Location": "fileS3Location",
                            "fileSize": "fileSize",
                            "requestIdentifier": "requestIdFromFileManager"
                        }
                    ]
                }
            },
            {
                "aptComment": {
                    "id": "b7c49f06-503f-11eb-bcb4-1dfe60b775fa",
                    "commentText": "My comment3",
                    "visibilityType": "Public",
                    "aptAttachments": [
                        {
                            "id": "b82c1368-503f-11eb-bcb4-adcdbccd111e",
                            "fileName": "fileName",
                            "visibilityType": "Public",
                            "fileExtension": "jpg",
                            "isDelete": false,
                            "fileS3Location": "fileS3Location",
                            "fileSize": "fileSize",
                            "requestIdentifier": "requestIdFromFileManager"
                        }
                    ]
                }
            }
        ]
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Toggle User Follows Process

Owners and Partners use this API to start or stop following a task or sub-task. Users that follow a task or sub-task receive notifications on updates to the request based on the APT notification settings for their profile. When users stop following the task or sub-task, notifications will cease.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:toggle-user-follows-process:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task or sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  processId String  Required.The identifier for the task or sub-task to follow or stop following.
  processType String

Required. The type of process. Valid values:

  • task – The process is a Task type.
  • subTask – The process is a Sub-task type.
  follow Boolean

Required.Indicates whether the user follows the task or sub-task and receives notifications based on their profile settings.

Valid values:
  • true – Yes, the user follows the task or sub-task and receives notifications.
  • false – No, the user does not follow the task or sub-task and does not receive notifications.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:toggle-user-follows-process:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "e5701ae7-b447-423a-85c9-b57557fb7007",
        "processType": "task",
        "follow": true
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:toggle-user-follows-process-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the task or sub-task.
  message String Required. The message indicating whether the user is added or removed as a follower of the specified task or sub-task.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:toggle-user-follows-process-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "e5701ae7-b447-423a-85c9-b57557fb7007",
        "message": "User successfully follows task."
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Get Activity History

Owners and Partners use this API to return the full activity history for a specified task or sub-task. The response includes all recorded audit activities and updates to the record.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:get-activity-history-for-process:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the task or sub-task process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  processId String Required. The identifier for the task or sub-task to return the activity history for.
  processType String

Required. The type of process. Valid values:

  • task – The process is a Task type.
  • subTask – The process is a Sub-task type.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:get-activity-history-for-process:v1",
        "ownerId": "tracelink",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "processType": "task"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:get-activity-history-for-process-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  auditTrailRecord Object Contains the list of audit trail entries for the task or sub-task.
    auditChangeEntry –

Required. The identifier for the audit entry.
      auditChangeDetail Array Contains information about the audit entry.
        auditRecordOldValue String Required. The name for the audit record.
        auditRecordNewValue String Required. The name for the audit record.
        auditRecordDisplayName String Required. The name for the audit record.
        auditRecordAttributeName String Required. The name for the audit record.
        auditRecordOldResolvedIdentifier String Required. The name for the audit record.
        auditRecordNewResolvedIdentifier String Required. The name for the audit record.
        auditRecordOldResolvedSchemaName String Required. Updated value of the audit entry.
        auditRecordNewResolvedSchemaName String Required. Previous value of the audit entry.
      auditActionTaken String Conditionally required if the updated attribute is a foreign key. The updated attribute value related to the audit record.
    timeStamp Integer The date and time the audited operation was performed.
    companyName String The name of the company that owns the audit record.
    performedByUserId String The identifier of the user that made the change.
    performedByUserName String The full name of the user that made the change.
    performedByCompanyName String The name of the company user that made the change for that audit entry.
    auditItemIdentifier String The identifier for the item the audited operation is performed on (e.g. INC-01234).
    applicationName String The short name of the application that performed the audited operation.
    applicationDescription   The full name of the application that performed the audited operation.
    actionType String

The type of change that the user took. Valid values: 

  • CREATE – The user created a business object.
  • MODIFY – The user modified a business object.
  • DELETE – The user deleted a business object.
  • OTHER – The user performed an operation that did not modify a business object (e.g. failed login attempt).
    businessObjectName String The name of the business object that the audited operation is performed on.
    businessObjectSchemaName String The name of the schema for the businessObjectName that the audited operation was performed on.
    supportAccessUserId String  
    supportAccessUserName String The full name of the TraceLink Support Representative performing an action on behalf of the user specified in the performedByUserName.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:get-activity-history-for-process-response:v1",
        "ownerId": "0e093b3c-ad28-48ab-97a9-fac574c1cce8",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "NVd76b"
    },
    "payload": {
        "auditTrailRecordList": [
            {
                "auditChangeEntry": {
                    "auditChangeDetail": [
                        {
                            "auditRecordDisplayName": "apt Business Object Summary",
                            "auditRecordNewValue": "AGGREGATION_ERROR"
                        },
                        {
                            "auditRecordDisplayName": "Business Priority",
                            "auditRecordNewValue": "HIGH"
                        },
                        {
                            "auditRecordDisplayName": "Apt Business Object ID",
                            "auditRecordNewValue": "TLNK-1234"
                        },
                        {
                            "auditRecordNewResolvedId": "015c9f20-731a-4e1c-8a25-634edc07c134",
                            "auditRecordDisplayName": "APT Business Object Assigned To Company Partner Master Data",
                            "auditRecordNewValue": "Kendall"
                        }
                    ]
                },
                "supportAccessUserName": "",
                "companyName": "Kendall Pharma",
                "businessObjectName": "Task",
                "performedByCompanyName": "Kendall Pharma",
                "supportAccessUserId": "",
                "timeStamp": 1612384626000,
                "performedByNetworkNodeId": "00448f53-fc7f-489a-a847-dbdb083cb646",
                "actionType": "Added",
                "networkNodeId": "00448f53-fc7f-489a-a847-dbdb083cb646",
                "businessObjectId": "53a671d1-af5e-4e5b-b10a-c8db389f82ca",
                "auditItemIdentifier": "TLNK-1234",
                "businessObjectSchemaName": "agile-process-teams:incident:v1",
                "performedByUserName": "Evelyn Rose",
                "performedByUserId": "007bee3d-ba11-47d1-8b0c-68bba8f591cb",
                "applicationName": "Agile Process Teams"
            }
        ]
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.