Shared incident APIs

These APIs are shared across all incident process types: general, direct supplier, and external manufacturing incidents.

Companies that own or link to a network use these APIs to do the following for an incident of any type:

  • View and manage comments and attachments
  • View activity history
  • Manage followers

Add Comment For Incident

Owners and Partners use this API to add comments and attach files to an existing incident.

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-incident: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 incident 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 incident being commented on.
  processType String

Required. The type of incident process. Valid values:

  • incident – The process is a general Incident type.
  • directSupplierIncident – The process is a Direct Supplier Incident type.
  • externalManufacturingIncident – The process is an External Manufacturing Incident type.
  aptCommentBox Object

Contains any comments or files to attach to the incident.
    aptComment Array One or more comments about the incident 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 incident 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 incident can view the comment.
    addAttachment Array One or more relevant files to attach to the incident. 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 incident 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 incident 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-incident: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": "indirectSupplierIncident",
        "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-incident-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-incident-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "commentId": "a67d7261-33b1-4be6-9760-61ae8fe9eed3"
    }
}

Errors

Element Error Messages Description
authorization User does not have permission to add comments. The error occurs if the user does not have the Add permission.
id Process ID is required. The error occurs if the source is empty or null.
id [id] does not exist. The error occurs if the source does not exist in the network.
processType Process Type is required. The error occurs if the source is empty or null.
processType Process Type must be a valid value. The error occurs if the source is not a valid value from the enumeration list.
aptComment Comment is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
aptComment Comment visibility type must be Public or Internal.

The error occurs if the source is populated and visibilityType does not equal Public or Internal.
addAttachment Attachment file size is greater than max size.

The error occurs if the source exceeds the maximum file size of 25MB.
addAttachment Attachment visibility type must be Public or Internal.

The error occurs if the source is populated and visibilityType does not equal Public or Internal.

This app also 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 For Incident

Owners and Partners use this API to modify or remove existing comments and files attached to an incident. 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 incident.

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-incident: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 incident 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 incident process. Valid values:

  • incident – The process is a general Incident type.
  • directSupplierIncident – The process is a Direct Supplier Incident type.
  • externalManufacturingIncident – The process is an External Manufacturing Incident type.
  aptCommentBox Object

Contains any comments or files to edit.

    aptComment Array One or more comments about the incident or descriptions of the attachments that the user wants to provide.
      commentText String Required. 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 incident 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 incident can view the comment.
    addAttachment Array One or more relevant files to attach to the incident. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String Required. The name of the file. Cannot exceed 255 characters.
      fileSize String Required. The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the incident 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 incident can view the comment.
      requestIdentifier String Required. The identifier for the upload request provided by File Import and Export Manager.
    removeAttachment Array One or more existing attachments to remove from the incident.
      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-incident: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": "directSupplierincident",
        "id": "9d84028a-61ae-11eb-90b4-e933a8e8da5e",
        "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-incident-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-incident-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "jzC1wS"
    },
    "payload": {
        "commentId": "9d84028a-61ae-11eb-90b4-e933a8e8da5e"
    }
}

Errors

Element Error Messages Description
authorization User does not have permission to edit comments.  The error occurs if the user does not have the Edit permission.
commentId Comment ID is required. The error occurs if the source is empty or null.
commentId [commentId] does not exist. The error occurs if the source does not exist in the network.
commentId Cannot edit a comment added by a different user. The error occurs if the user requesting to edit a comment is not the user that added the comment.
processType Process Type is required.

The error occurs if the source is empty or null.
processType Process Type must be a valid value. The error occurs if the source is not a valid value from the enumeration list.
aptComment Comment is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
aptComment Comment visibility type must be Public or Internal.

The error occurs if the source is populated and visibilityType does not equal Public or Internal.
addAttachment Attachment file size is greater than max size.

The error occurs if the source exceeds the maximum file size of 25MB.
addAttachment Attachment visibility type must be Public or Internal.

The error occurs if the source is populated and visibilityType does not equal Public or Internal.

This app also 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 For Incident

Owners and Partners use this API to return all comments and attachments for a specified incident. Return includes all comments and attachments associated with the incident 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-incident: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 incident 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 incident to return the list of comments for.
  processType Enum

Required. The type of incident process. Valid values:

  • incident – The process is a general Incident type.
  • directSupplierIncident – The process is a Direct Supplier Incident type.
  • externalManufacturingIncident – The process is an External Manufacturing Incident type.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:list-comments-for-incident: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": "incident"
    }
}

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-incident-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 incident.
    aptComment Array One or more comments about the incident 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 incident 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 incident can view the comment.
    aptAttachments Array One or more relevant files to attach to the incident. 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 incident 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 incident 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 incident. Valid values:

  • true – Yes, the file is marked as deleted and has been removed from the incident record.
  • false – No, the file is not marked as deleted from the incident.
      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-incident-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

Element Error Messages Description
authorization User does not have permission to view comments. The error occurs if the user does not have the Read permission.
id Process ID is required. The error occurs if the source is empty or null.
id [id] does not exist. The error occurs if the source does not exist in the system.
id No comments exist for [id]. The error occurs if the source has no comments or attachments to return.
processType Process Type is required. The error occurs if the source is empty or null.
processType Process Type must be a valid value. The error occurs if the source is not a valid value from the enumeration list.

This app also 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 Incident

Owners and Partners use this API to start or stop following a incident. Users that follow a incident receive notifications on updates to the request based on the APT notification settings for their profile. When users stop following the incident, 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-incident: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 incident 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 incident to follow or stop following.
  processType Enum

Required. The type of incident process. Valid values:

  • incident – The process is a general Incident type.
  • directSupplierIncident – The process is a Direct Supplier Incident type.
  • externalManufacturingIncident – The process is an External Manufacturing Incident type.
  follow Boolean

Required.Indicates whether the user follows the incident and receives notifications based on their profile settings.

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

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:toggle-user-follows-incident: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": "incident",
        "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-incident-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 The identifier for the incident.
  message String Required. The message indicating whether the user is added or removed as a follower of the specified incident.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:toggle-user-follows-incident-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "successMessage": "User successfully follows incident."
    }
}

Errors

Element Error Messages Description
authorization User does not have permission to follow or unfollow the incident.

The error occurs if the user does not have the Read permission.
id Process ID is required. The error occurs if the source is empty or null.
id [id] does not exist. The error occurs if the source does not exist on the network.
processType Process Type is required. The error occurs if the source is empty or null.
processType Process Type must be a valid value. The error occurs if the source is not a valid value from the enumeration list.
follow Follow value is required. The error occurs if the source is empty or null.
follow Follow value must either be true or false. The error occurs if the source does not equal true or false.
follow User is already a follower of the Incident. The error occurs if the source is true and the user already follows the incident.
follow User does not follow the Incident. The error occurs if the source is false and the user does not currently follow the incident.

This app also 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 For Incident

Owners and Partners use this API to return the full activity history for a specified incident. 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-incident: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 incident 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 incident to return the activity history for.
  processType String

Required. The type of incident process. Valid values:

  • incident – The process is a general Incident type.
  • directSupplierIncident – The process is a Direct Supplier Incident type.
  • externalManufacturingIncident – The process is an External Manufacturing Incident type.

Example

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

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-incident-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.
  auditTrailRecordList Array Required. Array of audit trail records for the incident.
    auditChangeEntry – Required. The identifier for the audit entry.
      auditChangeDetail – Required. Contains information about the audit entry.
        auditRecordDisplayName String Required. The name for the audit record.
        auditRecordNewValue String Required. Updated value of the audit entry.
        auditRecordOldValue String Required. Previous value of the audit entry.
        auditRecordNewResolvedId String Conditionally required if the updated attribute is a foreign key. The updated attribute value related to the audit record.
    timeStamp Integer Required. Date and time of the audit entry.
    networkNodeId String Required. The identifier of the Owner company network that owns the data.
    companyName String Required. The name of the company that owns the data.
    performedByUserName String The name of the user that made the change.
    performedByCompanyName String Required. Name of the company that made the change for that audit entry
    auditItemIdentifier String Required. The identifier for the audit item.
    applicationName String Required. The name of the application that the event occurred within.
    actionType String Required. Represents the type of change the user performed (e.g. CREATE, MODIFY, DELETE, OTHER).
    businessObjectName String Required. The object of the application that the event occurred within.
    businessObjectSchemaName String Required. The specific object within the businessObjectName that the user updated
    supportAccessUserName String The email address of the TraceLink Support Representative performing an action on behalf of the user specified in the performedByUserName field.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:get-activity-history-for-incident-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": "Incident",
                "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

Element Error Messages Description
authorization User does not have permission to view the incident activity. The error occurs if the user does not have the Read permission.
id Process ID is required. The error occurs if the source is empty or null.
id [id] does not exist. The error occurs if the source does not exist on the network.
processType Process Type is required. The error occurs if the source is empty or null.
processType Process Type must be a valid value. The error occurs if the source is not a valid value from the enumeration list.

This app also 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.