This Help Center is a preview of a future release. The final Help Center will be available on the Validation date.

Task template APIs

Companies that own Agile Process Teams use these APIs to add, edit, and copy task templates and manage the associated template sub-tasks. Every task requires a template. Once the template is created, it can be selected when adding a new task to the Owner's network using the Add Task API.

The template defines the following for any task that uses the template:

The default values that populate for the task.
The sub-tasks that are automatically created for the task. The template settings also determine whether users can modify the template-defined sub-tasks at the task level.

Add Task Template

Owners use this API to add a task template to their network. After the template is added, users can add sub-tasks to the template using the Add Sub-Task to Template API.

Add Task Template request

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-template: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 template. 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.
	templateName	String	Required. The name of the new template to add. Cannot exceed 255 characters.
	aptBusinessObjectDescription	String	A description of the template. Provides additional information about the purpose of the template. Cannot exceed 5000 characters.
	isTemplateModifiableByMember	Boolean	Required. Indicates whether the template can be modified by team members from the Owner company who did not create the template. Valid values: `true` – The template can be modified by the template creator and other team members from the Owner company. `false` – The template cannot be modified by other users. It can only be modified by the template creator.
	isAddRemoveSubtaskAllowed	Boolean	Required. Indicates whether users can modify (i.e. add, edit, or remove) the template's defined sub-tasks when the template is used. Valid values: `true` – The template-defined sub-tasks can be modified when the template is used. `false` – The template-defined sub-tasks cannot be modified when the template is used.
	completionRequiredWithinDays	Integer	Required. For a task that uses the template, this is the number of days after the task is added that the due date defaults to. Valid values are 1–9999.
	businessPriority	Enum	Required. The default urgency with which a task that uses the template needs to be completed. 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.
	responsibleDepartmentAtCompany	String	For a task that uses the template, this is the default business area of the Owner company that is responsible for the task's completion. If omitted from the template, the task defaults to the job function of the responsible party, if defined for the user; otherwise is `null`. Valid values: `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	For a task that uses the template, this is the identifier fr the default person from the Owner company that owns the task from the Owner's side and is responsible for the task's completion. If omitted from the template, the task defaults to `null` (i.e. the system `Unassigned` user).
	currentlyAssignedCompanyUsers	Array	For a task that uses the template, this is the default list of identifiers for one or more users at the Owner company assigned to the task. If omitted from the template, the task defaults to `null` (i.e. the system `Unassigned` user).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-task-template:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "templateName": "Customer Service Task Template",
        "aptBusinessObjectDescription": "Template for customer service tasks",
        "isTemplateModifiableByMember": false,
        "isAddRemoveSubtaskAllowed": false,
        "completionRequiredWithinDays": 7,
        "businessPriority": "LOW",
        "responsibleDepartmentAtCompany": "CUSTOMER_SERVICE",
        "responsiblePartyAtCompany": "788b4d4e-7529-4575-b17c-1f8f61d55e00",
        "currentlyAssignedCompanyUsers": [
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c",
            "11935532-e603-4700-9aed-b14b4ac2a7d8",
            "7713c743-dd56-4074-83f3-c961b52b1519"
        ]
    }
}

Add Task Template response

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-template-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 new template.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-task-template-response:v1",
        "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 Template

Owners use this API to modify a task template with new, updated, or corrected information (e.g. renaming the template, updating the default assigned users). Use the Add Sub-Task to Template or Edit Sub-Task For Template APIs to modify the template's sub-tasks.

If isTemplateModifiableByMember is false, the template can only be modified by the user that created the template.

Edit Task Template request

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-template:v3`.
	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 template. 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 template to modify.
	templateName	String	The name of the template. Cannot exceed 255 characters.
	aptBusinessObjectDescription	String	A description of the template. Provides additional information about the purpose of the template. Cannot exceed 5000 characters.
	isTemplateModifiableByMember	Boolean	Indicates whether the template can be modified by team members from the Owner company who did not create the template. Valid values: `true` – The template can be modified by the template creator and other team members from the Owner company. `false` – The template cannot be modified by other users. It can only be modified by the template creator.
	isAddRemoveSubtaskAllowed	Boolean	Indicates whether users can modify (i.e. add, edit, or remove) the template's defined sub-tasks when the template is used. Valid values: `true` – The template-defined sub-tasks can be modified when the template is used. `false` – The template-defined sub-tasks cannot be modified when the template is used.
	completionRequiredWithinDays	Integer	For a task that uses the template, this is the number of days after the task is added that the due date defaults to. Valid values are 1–9999.
	businessPriority	Enum	The default urgency with which a task that uses the template needs to be completed. 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.
	responsibleDepartmentAtCompany	String	For a task that uses the template, this is the default business area of the Owner company that is responsible for the task's completion. If omitted from the template, the task defaults to the job function of the responsible party, if defined for the user; otherwise is `null`. Valid values: `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	For a task that uses the template, this is the default person from the Owner company that owns the task from the Owner's side and is responsible for the task's completion. If omitted from the template, the task defaults to `null` (i.e. the system `Unassigned` user).
	currentlyAssignedCompanyUsers	Array	For a task that uses the template, this is the default list of one or more users at the Owner company assigned to the task. If omitted from the template, the task defaults to `null` (i.e. the system `Unassigned` user).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-task-template:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },    
"payload": {
        "id": "a67d7261-33b1-4be6-9760-61ae8fe9eed3",
        "aptBusinessObjectDescription": "Updated template for customer service tasks",
        "completionRequiredWithinDays": 3,
        "businessPriority": "HIGH",
        "currentlyAssignedCompanyUsers": [
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
        ]
    }
}

Edit Task Template response

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-template-response:v3`.
	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 template.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
   "header":{
      "headerVersion":1,
      "eventName":"agile-process-teams:edit-task-template-response:v3",
      "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.

Copy Task Template

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

Copy Task Template request

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-template: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 template. 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 template to copy.
	templateName	String	Required. The name of the new template to add. Cannot exceed 255 characters.
	copyGeneralInfo	Boolean	Required. Indicates whether to copy the General section values from the original template to the new template. Valid values: `true` - Yes, copy all General section values to the new template. `false` - No, do not copy the General section values to the new template.
	copySubTasks	Boolean	Required. Indicates whether to copy the sub-tasks from the original template to the new template. Valid values: `true` - Yes, copy all sub-tasks to the new template. `false` - No, do not copy the sub-tasks to the new template.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-task-template:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },    
"payload": {
        "id": "a67d7261-33b1-4be6-9760-61ae8fe9eed3",
        "templateName": "Copy of Template for customer service tasks",
        "copyGeneralInfo": true,
        "copySubTasks": true
    }
}

Copy Task Template response

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-template-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 new template.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-task-template-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "2e3090e9-56d0-42b9-a367-2a35ee7c7567"
    }
}

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 Template

Owners use this API to add a new sub-task to a task template that exists in their company's network. Any task that uses the template will automatically include the sub-task.

Add Sub-Task To Template request

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-template: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 template. 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 template 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.
	completionRequiredWithinDays		Integer	Required. For a sub-task that uses the template, this is the number of days after the sub-task is added that the due date defaults to. Valid values are 1–9999.
	businessPriority		Enum	Required. The default urgency with which a sub-task that uses the template needs to be completed. Valid values: `LOW` - The sub-task has low business priority. `MEDIUM` – The sub-task has medium business priority. `HIGH` – The sub-task has high business priority. `CRITICAL` – The sub-task is critical.
	partnerCompany		Object	The identifier number and type for the Partner company associated with the sub-task.
		partnerId	String	The identifier for the Partner company.
		toIdType	Enum	The Partner identifier type. Valid values: `partnerMasterData` `partnerLocationMasterData` `companyMasterData` `companyLocationMasterData`
	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`. Valid values: `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	How the process is related to the sub-task (e.g. `blocks`, `is contained by`).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-sub-task-to-template:v2",
        "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",
        "subTaskName": "Sub-Task 01234",
        "subTaskType": "Sub-Task Type XYZ",
        "completionRequiredWithinDays": 7,
        "businessPriority": "LOW",
        "partnerCompany": {
            "partnerId": "be9c8cea-72bc-459c-97b9-ef3f7c73ccc8",
            "toIdType": "companyMasterData"
        },        
        "responsiblePartyAtPartner": "bb75c388-16f7-4a18-9c77-f418d928359e",
        "responsibleDepartmentAtPartner": "SUPPLY_CHAIN",
        "currentlyAssignedCompanyUsers": [
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c",
            "11935532-e603-4700-9aed-b14b4ac2a7d8"
        ],
        "currentlyAssignedPartnerUsers": [
            "7713c743-dd56-4074-83f3-c961b52b1519"
        ],
        "referenceIdentifiers": [
            {
                "referenceTransactionType": "BILL_OF_LADING",
                "value": "GTIN-1161187176294956"
            }
        ],
        "relatedProcesses": [
            {
                "processId": "c8c2b7ab-fcfd-448e-8964-798e42fb9aea",
                "processType": "incident",
                "relationship": "Contains"
            }
        ]
    }
}

Add Sub-Task To Template response

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-template-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 sub-task.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-sub-task-to-template-response:v2",
        "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 Sub-Task On Template

Owners and Partners use this API to modify a sub-task associated with a task template with new, updated, or corrected information (e.g. updating the default assigned users, fixing a typo).

Edit Sub-Task On Template request

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-template:v3`.
	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 template. 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 template to modify.
	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	The identifier number and type for the Partner company associated with the sub-task.
		partnerId	String	The identifier for the Partner company.
		toIdType	Enum	The Partner identifier type. Valid values: `partnerMasterData` `partnerLocationMasterData` `companyMasterData` `companyLocationMasterData`
	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`. Valid values: `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).
	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	How the process is related to the sub-task (e.g. `blocks`, `is contained by`).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-sub-task-on-template:v3",
        "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",
        "subTaskName": "Sub-Task 56789",
        "subTaskType": "Sub-Task Type ABC",
        "subTaskDueDate": 1631133945000,
        "currentlyAssignedCompanyUsers": [
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
        ],
        "currentlyAssignedPartnerUsers": [
            "7713c743-dd56-4074-83f3-c961b52b1519",
            "bb75c388-16f7-4a18-9c77-f418d928359e"
        ]
    }
}

Edit Sub-Task On Template response

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-template-response:v3`.
	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

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-sub-task-on-template-response:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "ff060ac0-035d-11eb-8738-0242ac110017"
    }
}

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 Template

Owners use this API to view all sub-tasks associated with a specified template. Returns all sub-tasks currently attached to the template (isDeleted = false).

List Sub-Task For Template request

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-template: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 template. 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 to return the list of sub-tasks for.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-sub-task-for-template: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"
    }
}

List Sub-Task For Template response

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-template-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 template.
		subTaskId	String	The identifier for the sub-task.
		subTaskName	String	The name of the sub-task. Cannot exceed 255 characters.
		subTaskStatus	String	The current workflow state of the sub-task.
		subTaskType	String	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.
		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).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-sub-task-for-template-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "subTask": {
            "subTaskId": "11935532-e603-4700-9aed-b14b4ac2a7d8",
            "subTaskName": "Sub-Task 01234",
            "subTaskStatus": "ToDo",
            "subTaskType": "Type XYZ",
            "subTaskDueDate": 1632576147000,
            "currentlyAssignedCompanyUsers": [
                "9cba9110-0358-11eb-8738-0242ac110017",
                "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
            ],
            "currentlyAssignedPartnerUsers": [
                "7713c743-dd56-4074-83f3-c961b52b1519"
            ]
        }
    }
}

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 Template

Owners use this API to remove a sub-task from a task template.

Remove Sub-Task From Template request

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-template: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 template. 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

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {        
        "headerVersion": 1,
        "eventName": "agile-process-teams:remove-sub-task-from-template: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"
    }
}

Remove Sub-Task From Template response

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-template-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 template.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:remove-sub-task-from-template-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.