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

Incident APIs

Companies that own or link to Agile Process Teams use these APIs to add, update, and resolve general supply chain incidents on the Owner's network. Partners must be a member of the Owner company's network to collaborate with the Owner on an incident. For example, a Manufacturer's internal location might have a material shortage that impacts production and needs to be investigated by the Supplier, or a 3PL might need to report to the Manufacturer that shipping labels are missing. After adding the incident, both parties can collaborate to investigate and resolve the reported problem. Partners must be a member of the Owner company's network to collaborate with the Owner on an incident.

Incidents can be in one of three base workflow states:

  • To Do – The incident is new and has not been reviewed. This state is applied to new incidents that are not submitted to Partner or created by a Partner user. Can be transitioned to Under Investigation or Closed.
  • Under Investigation – The incident has been reviewed and is ready for investigation by assigned users. This state can be manually applied. It is automatically applied when an incident is submitted to Partner and when a closed incident is reopened. Can be transitioned to Closed by closing the incident.
  • Closed – The incident is resolved. This state is automatically applied when the resolution is submitted. Can be transitioned back to Under Investigation by reopening the closed incident.

Add Incident

Owners and Partners use this API to add a new general incident to the Owner company's network, including any initial comments or file attachments. The response returns a generated identifier for the new incident. Notification timers are created based on the entered due dates for alerts.

New incidents 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-incident: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 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.
 

aptBusinessObjectSummary

 String Required. A brief summary of the incident. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the incident. Provides additional information to help the responsible parties to triage and resolve the incident. Cannot exceed 5000 characters.
  businessPriority Enum

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

Valid values:
  • LOW - The incident has low business priority.
  • MEDIUM – The incident has medium business priority.
  • HIGH – The incident has high business priority.
  • CRITICAL – The incident is critical.
  resolutionDueDate Number

The date and time (in Unix epoch time in milliseconds) that the incident must be resolved (e.g. 1623668400). Process team members from the Partner company cannot set this date.

If omitted, the date is calculated by adding the default time (in hours) configured for the network to the time the incident was added. For example, if the default resolutionRequiredWithinHours is 336 and the current date is 01 Jun 2021, the resolutionDueDate is calculated as 14 Jun 2021.
 

incidentCategory

 String

The main problem that caused the incident.

  • AGGREGATION_ERROR – An aggregation or disaggregation error occurred.
  • CANNOT_RECONCILE_SERIAL_NUMBER_WITH_ERP_OR_WMS – The product's serial number could not be reconciled against the appropriate ERP or WMS system.
  • CGMP_SOP_NOT_FOLLOWED – Good manufacturing practices documented in the current standard operating procedure (SOP) were not followed.
  • CLOSURE_ISSUE_WITH_LID_OR_CAP – A problem occurred with the product's lid or cap.
  • COMMISSIONED_PRODUCT_NOT_SHIPPED – The commissioned product was not included in the shipment.
  • CONTAMINATION_FROM_FOREIGN_PARTICLE_OR_PARTICULATE – The product was contaminated with an undesired particulate.
  • DAMAGE_FROM_PACKING_TRANSPORT_OR_FILLING –
  • DAMAGED_PRODUCT – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage.
  • HANDLING_OR_STORAGE_DEVIATION – An unplanned deviation from current best practices related to product handling or storage occurred.
  • IMPURITIES_PRESENT – One or more impurities were found in the product.
  • IMPROPER_ARTWORK_INSPECTION – An error occurred during artwork inspection.
  • INCORRECT_LABEL_INFORMATION – The product's label includes incorrect information, such as dosage or usage information.
  • LABEL_QUALITY_INCONSISTENCY – The product's label (e.g. graphics, colors, or fonts) does not meet quality requirements.
  • LABEL_COMPLIANCE_ERROR – The product's label is not in compliance with necessary regulations.
  • LOT_AND_EXPIRATION_PRINT_ISSUE – An issue occurred related to lot and expiration information.
  • MATERIAL_SHORTAGE – A material shortage occurred.
  • MARKET_LANGUAGE_TRANSLATION_ERROR – An error occurred when translating product information for the target market.
  • MANUFACTURING_FACILITY_EXCEPTION – The issue is related to an exception raised by the manufacturing facility.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • MISSING_PRODUCT_OR_PARTIAL_LOT – Not all expected product is included in the lot.
  • NOT_ON_TIME_OR_IN_FULL – The shipment was late or missing product.
  • OUT_OF_SPECIFICATION – The product is not compliant with required specifications.
  • PARTIAL_SERIAL_NUMBER_LEGIBLE – The serial number is not legible.
  • PH_SHIFT_DUE_TO_GLASS_DISSOLUTION – The product's pH has changed.
  • POOR_LABEL_ADHESION – An issue occurred with the product's label.
  • POOR_CHEMICAL_DURABILITY – An issue occurred with the product's durability, such as weathering, pitted surfaces, or delamination.
  • PRODUCT_SHIPPED_BUT_NOT_COMMISSIONED – The product is not in the required state of Commissioned.
  • PRINTED_SERIAL_NUMBER_DOES_NOT_MATCH_DATA – The product serial number does not have the expected value.
  • PRODUCT_SHIPPED_BUT_NOT_QA_RELEASED – The product is not in the required state of QA Released.
  • POTENTIAL_LEACHING_OR_INTERACTION_WITH_PRODUCT – The product has possibly interacted with an undesired contaminant.
  • PRINTING_MATERIALS_ISSUE – A printing error occurred.
  • QUALITY_ISSUE_DURING_INCOMING_INSPECTION – An issue was discovered during product inspection.
  • RAW_MATERIAL_QUALITY – The product does not meet quality requirements.
  • REDUCED_PERFORMANCE_IN_GLASS_PREFILLED_SYRINGE – The product's quality has been affected by interaction with glass.
  • REDUCED_POTENCY_FROM_ABSORPTION_OF_DRUG_PRODUCT_ONTO_GLASS_SURFACE – The product's potency has been affected by interaction with glass.
  • SERIAL_NUMBER_COMMISSION_OUTPUT_CHANGE – A commissioning error occurred.
  • SHIPMENT_DAMAGE – The shipment was damaged at an undetermined time.
  • SHORT_SHIPMENT_OR_PRODUCTION_RUN – The shipment or production run does not include all expected contents.
  • SHORT_SHIPMENT_RECEIVED – The received shipment does not include all expected contents.
  • SILICONE_LUBRICANTS_IMPACTED_PRODUCT_QUALITY – The product's quality has been affected by interaction with silicone lubricants.
  • TEMPERATURE_EXCURSION_DURING_SHIPMENT_OR_STORAGE – The product did not stay within the required temperature range.
  • VARIABILITY_IN_PARTICLE_SIZE_HARDNESS_DISINTEGRATION_AND_COMPRESSIBILITY – The product does not meet consistency requirements.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the incident (e.g. PO Number 1896155149).
    referenceTransactionType Enum

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.
  impactedProducts Array Identifiers for the one or more products that are affected by the incident.
    productDetailId String The identifier for the product affected by the incident.
    impactedLots String The lot numbers containing product affected by the incident.
  responsibleEntity Array Conditionally required if isSubmittedToPartner is true. The identifier number and type for the Partner company associated with the incident.
    partnerId String The identifier for the Partner company that the incident is being submitted to. This field cannot be modified after the incident is submitted to the Partner (isSubmittedToPartner= true).
    toIdType String

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  responsiblePartyAtCompany String The identifier for the person from the Owner company that owns the incident from the Owner's side and is responsible for the incident's resolution. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedCompanyUsers Array List of identifiers for the one or more users at the Owner company assigned to the incident. If omitted, defaults to null (i.e. the system Unassigned user).
  responsiblePartyAtPartner String The identifier for the person from the Partner company that owns the incident from the Partner's side and is responsible for the incident's resolution. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of identifiers for the one or more users at the Partner company assigned to the incident. If omitted, defaults to null (i.e. the system Unassigned user).
  relatedProcesses Array

One or more processes to link to the incident 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.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-incident:v5",
        "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "aptBusinessObjectSummary": "Kendall Pharma | ACME Inc | INC-2023-01 | No EPCIS Data for 1 package",
        "aptBusinessObjectDescription": "Shipment quarantined due to T1 reflecting incomplete data|SO 3027209239|PO 5201019344|Transaminase enzyme, CDX-017 (ACS-4007466). EPCIS shows 48 pallets and receiving called out 50 received ",
        "businessPriority": "HIGH",
        "incidentCategory":"Aggregate Shipment Error",
        "referenceIdentifiers": [
            {
                "referenceTransactionType": "PO Number",
                "value": "PO-123"
            },
            {
                "referenceTransactionType": "PO Number",
                "value": "PO-345"
            }
        ],
        "impactedProducts": [
            {
                "productDetailId": "ea92a360-55ac-15eb-bb95-8bd76e7bd0015",
                "impactedLots": "4"
            }
        ],
        "responsibleEntity": {
            "partnerId": "c923a50c-3fbe-4cd2-bb6e-14b2be894189",
            "toIdType": "companyLocationMasterData"
        },
        "resolutionDueDate": 1681640075000,
        "responsiblePartyAtCompany": "9fc845af-3a50-43d7-83a4-4358108057c2",
        "currentlyAssignedCompanyUsers": [
            "d5b2b867-fdeb-4b1c-a0d4-8aabf853c169",
            "a4bc6e7f-6436-4499-b453-270cdd052271"
        ],
        "responsiblePartyAtPartner": "13fb0cc6-771c-447a-a1bb-02513a235b24",
        "currentlyAssignedPartnerUsers": [
            "13fb0cc6-771c-447a-a1bb-02513a235b24",
            "ee532337-89d2-4f5f-b024-bfa070139b73"
        ]
    }
}

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-incident-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The name of the TraceLink application. Valid value is agile-process-teams.
  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.
  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 payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new incident.  
  businessObjectId String The unique identifier TraceLink assigns to the incident (e.g. APT-12345)..

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-incident:v5",
        "ownerId": "d248fb86-9f76-455e-8a31-320285d019d5",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "VViyog-PqbMte"
    },
    "payload": {
        "id": "0c7fa3a9-291f-42a5-8ad0-767ef94fc30b",
        "businessObjectID": "INC-123"
    }
}

Errors

Element Error Message Description
authorization User does not have permission to add incidents. The error occurs if the user does not have the Add permission.
processNetworkId Process Network Id is required. The error occurs if the source is empty or null.
aptBusinessObjectSummary Incident summary is required. The error occurs if the source is empty or null.
aptBusinessObjectSummary Incident summary is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
responsiblePartyAtCompany Invalid user, must be a user of the owning company and a member of the specified process network.

The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
responsiblePartyAtPartner Invalid user, must be a user of the partner company and a member of the specified process network.

The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
currentlyAssignedCompanyUsers Invalid user, must be a user of the owning company and a member of the specified process network. The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
currentlyAssignedPartnerUsers Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
businessPriority Business Priority is required. The error occurs if the source is empty or null.
businessPriority Invalid Business Priority, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
resolutionDueDate Invalid Resolution Due Date, must be a valid date in the future. The error occurs if the source is less than the current time of the incident event.
incidentCategory Invalid Incident Category, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
referenceIdentifiers Invalid Transaction ID Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
relatedProcesses Invalid Process ID, must be a valid process ID within the specified process network. The error occurs if the source does not exist on the network specified in the request.

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 Incident

Owners and Partners use this API to to do the following: 

  • Modify an existing general incident with new, updated, or corrected information and documentation (e.g. adding an initial response, fixing a typo, updating the root cause notes for a closed incident).
  • Update the incident workflow state (e.g. manually transitioning the base state from To Do to Under Investigation to indicate that the incident has been reviewed and submitted for investigation).
Use the shared comment APIs to add, edit, or delete comments and file attachments. These APIs are shared across all incident types.

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

aptBusinessObjectSummary

 String Required. A brief summary of the incident. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the incident. Provides additional information to help the responsible parties to triage and resolve the incident. Cannot exceed 5000 characters.
  businessPriority Enum

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

Valid values:
  • LOW - The incident has low business priority.
  • MEDIUM – The incident has medium business priority.
  • HIGH – The incident has high business priority.
  • CRITICAL – The incident is critical.
  resolutionDueDate Number

The date and time (in Unix epoch time in milliseconds) that the incident must be resolved (e.g. 1623668400). Process team members from the Partner company cannot set this date.

If omitted, the date is calculated by adding the default time (in hours) configured for the network to the time the incident was added. For example, if the default resolutionRequiredWithinHours is 336 and the current date is 01 Jun 2021, the resolutionDueDate is calculated as 14 Jun 2021.
 

incidentCategory

 String

The main problem that caused the incident.

  • AGGREGATION_ERROR – An aggregation or disaggregation error occurred.
  • CANNOT_RECONCILE_SERIAL_NUMBER_WITH_ERP_OR_WMS – The product's serial number could not be reconciled against the appropriate ERP or WMS system.
  • CGMP_SOP_NOT_FOLLOWED – Good manufacturing practices documented in the current standard operating procedure (SOP) were not followed.
  • CLOSURE_ISSUE_WITH_LID_OR_CAP – A problem occurred with the product's lid or cap.
  • COMMISSIONED_PRODUCT_NOT_SHIPPED – The commissioned product was not included in the shipment.
  • CONTAMINATION_FROM_FOREIGN_PARTICLE_OR_PARTICULATE – The product was contaminated with an undesired particulate.
  • DAMAGE_FROM_PACKING_TRANSPORT_OR_FILLING –
  • DAMAGED_PRODUCT – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage.
  • HANDLING_OR_STORAGE_DEVIATION – An unplanned deviation from current best practices related to product handling or storage occurred.
  • IMPURITIES_PRESENT – One or more impurities were found in the product.
  • IMPROPER_ARTWORK_INSPECTION – An error occurred during artwork inspection.
  • INCORRECT_LABEL_INFORMATION – The product's label includes incorrect information, such as dosage or usage information.
  • LABEL_QUALITY_INCONSISTENCY – The product's label (e.g. graphics, colors, or fonts) does not meet quality requirements.
  • LABEL_COMPLIANCE_ERROR – The product's label is not in compliance with necessary regulations.
  • LOT_AND_EXPIRATION_PRINT_ISSUE – An issue occurred related to lot and expiration information.
  • MATERIAL_SHORTAGE – A material shortage occurred.
  • MARKET_LANGUAGE_TRANSLATION_ERROR – An error occurred when translating product information for the target market.
  • MANUFACTURING_FACILITY_EXCEPTION – The issue is related to an exception raised by the manufacturing facility.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • MISSING_PRODUCT_OR_PARTIAL_LOT – Not all expected product is included in the lot.
  • NOT_ON_TIME_OR_IN_FULL – The shipment was late or missing product.
  • OUT_OF_SPECIFICATION – The product is not compliant with required specifications.
  • PARTIAL_SERIAL_NUMBER_LEGIBLE – The serial number is not legible.
  • PH_SHIFT_DUE_TO_GLASS_DISSOLUTION – The product's pH has changed.
  • POOR_LABEL_ADHESION – An issue occurred with the product's label.
  • POOR_CHEMICAL_DURABILITY – An issue occurred with the product's durability, such as weathering, pitted surfaces, or delamination.
  • PRODUCT_SHIPPED_BUT_NOT_COMMISSIONED – The product is not in the required state of Commissioned.
  • PRINTED_SERIAL_NUMBER_DOES_NOT_MATCH_DATA – The product serial number does not have the expected value.
  • PRODUCT_SHIPPED_BUT_NOT_QA_RELEASED – The product is not in the required state of QA Released.
  • POTENTIAL_LEACHING_OR_INTERACTION_WITH_PRODUCT – The product has possibly interacted with an undesired contaminant.
  • PRINTING_MATERIALS_ISSUE – A printing error occurred.
  • QUALITY_ISSUE_DURING_INCOMING_INSPECTION – An issue was discovered during product inspection.
  • RAW_MATERIAL_QUALITY – The product does not meet quality requirements.
  • REDUCED_PERFORMANCE_IN_GLASS_PREFILLED_SYRINGE – The product's quality has been affected by interaction with glass.
  • REDUCED_POTENCY_FROM_ABSORPTION_OF_DRUG_PRODUCT_ONTO_GLASS_SURFACE – The product's potency has been affected by interaction with glass.
  • SERIAL_NUMBER_COMMISSION_OUTPUT_CHANGE – A commissioning error occurred.
  • SHIPMENT_DAMAGE – The shipment was damaged at an undetermined time.
  • SHORT_SHIPMENT_OR_PRODUCTION_RUN – The shipment or production run does not include all expected contents.
  • SHORT_SHIPMENT_RECEIVED – The received shipment does not include all expected contents.
  • SILICONE_LUBRICANTS_IMPACTED_PRODUCT_QUALITY – The product's quality has been affected by interaction with silicone lubricants.
  • TEMPERATURE_EXCURSION_DURING_SHIPMENT_OR_STORAGE – The product did not stay within the required temperature range.
  • VARIABILITY_IN_PARTICLE_SIZE_HARDNESS_DISINTEGRATION_AND_COMPRESSIBILITY – The product does not meet consistency requirements.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the incident (e.g. PO Number 1896155149).
    referenceTransactionType Enum

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.
  impactedProducts Array Identifiers for the one or more products that are affected by the incident.
    productDetailID String The identifier for the product affected by the incident.
    impactedLots String The lot numbers containing product affected by the incident.
  responsibleEntity Array Conditionally required if isSubmittedToPartner is true. The identifier number and type for the Partner company associated with the incident.
    partnerId String The identifier for the Partner company that the incident is being submitted to. This field cannot be modified after the incident is submitted to the Partner (isSubmittedToPartner= true).
    toIdType String

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  responsiblePartyAtCompany String The identifier for the person from the Owner company that owns the incident from the Owner's side and is responsible for the incident's resolution. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedCompanyUsers Array List of identifiers for the one or more users at the Owner company assigned to the incident. If omitted, defaults to null (i.e. the system Unassigned user).
  responsiblePartyAtPartner String The identifier for the person from the Partner company that owns the incident from the Partner's side and is responsible for the incident's resolution. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of identifiers for the one or more users at the Partner company assigned to the incident. If omitted, defaults to null (i.e. the system Unassigned user).
  relatedProcesses Array

One or more processes to link to the incident 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.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-incident:v5",
        "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "aptBusinessObjectSummary": "Kendall Pharma | ACME Inc | INC-2023-01 | No EPCIS Data for 1 package",
        "aptBusinessObjectDescription": "Shipment quarantined due to T1 reflecting incomplete data|SO 3027209239|PO 5201019344|Transaminase enzyme, CDX-017 (ACS-4007466). EPCIS shows 48 pallets and receiving called out 50 received",
        "businessPriority": "HIGH",
        "incidentCategory":"Aggregate Shipment Error",
        "referenceIdentifiers": [
            {
                "referenceTransactionType": "PO Number",
                "value": "PO-123"
            },
            {
                "referenceTransactionType": "PO Number",
                "value": "PO-345"
            }
        ],
        "impactedProducts": [
            {
                "productDetailId": "ea92a360-55ac-15eb-bb95-8bd76e7bd0015",
                "impactedLots": "4"
            }
        ],
        "responsibleEntity": {
            "partnerId": "c923a50c-3fbe-4cd2-bb6e-14b2be894189",
            "toIdType": "companyLocationMasterData"
        },
        "resolutionDueDate": 1681640075000,
        "responsiblePartyAtCompany": "9fc845af-3a50-43d7-83a4-4358108057c2",
        "currentlyAssignedCompanyUsers": [
            "d5b2b867-fdeb-4b1c-a0d4-8aabf853c169",
            "a4bc6e7f-6436-4499-b453-270cdd052271"
        ],
        "responsiblePartyAtPartner": "13fb0cc6-771c-447a-a1bb-02513a235b24",
        "currentlyAssignedPartnerUsers": [
            "13fb0cc6-771c-447a-a1bb-02513a235b24",
            "ee532337-89d2-4f5f-b024-bfa070139b73"
        ]
    }
}

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-incident-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The name of the TraceLink application. Valid value is agile-process-teams.
  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.
  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 payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new incident.  
  businessObjectId String The unique identifier TraceLink assigns to the incident (e.g. APT-12345)..

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-incident:v5",
        "ownerId": "d248fb86-9f76-455e-8a31-320285d019d5",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "VViyog-PqbMte"
    },
    "payload": {
        "id": "0c7fa3a9-291f-42a5-8ad0-767ef94fc30b",
        "businessObjectID": "INC-123"
    }
}

Errors

Element Error Message Description
authorization User does not have permission to edit incidents. The error occurs if the user does not have the Edit permission.
processNetworkId Process Network ID is required. The error occurs if the source is empty or null.
responsiblePartyAtCompany Invalid user, must be a user of the owning company and a member of the specified process network.

The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
responsiblePartyAtPartner Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
currentlyAssignedCompanyUsers Invalid user, must be a user of the owning company and a member of the specified process network.

The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
currentlyAssignedPartnerUsers Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
businessPriority Invalid Business Priority, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
businessPriority Partner users are not allowed to update the Business Priority when the incident was created by the owning company. The error occurs if the incident was created by a process team member of the Owner company and the source is modified by a Partner user.
aptBusinessObjectDescription Incident Description is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
aptBusinessObjectDescription Partner users are not allowed to update the Description when the incident was created by the owning company. The error occurs if the incident was created by a process team member of the Owner company and the source is modified by a Partner user.
resolutionDueDate Invalid Resolution Due Date, must be a valid date in the future.

The error occurs if the source is less than the current time of the incident event.
resolutionDueDate Partner users are not allowed to update the Resolution Due Date. The error occurs if the source is modified by a process team member of the Partner company.
incidentCategory Invalid Incident Category, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list..
referenceIdentifiers Invalid Transaction ID Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
referenceIdentifiers Partner users are not allowed to update the Transaction IDs when the incident was created by the owning company. The error occurs if the source is modified by a process team member of the Partner company.
relatedProcesses Invalid Process ID, must be a valid process ID within the specified process network. The error occurs if the source is not a valid process identifier within the network.

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.

Copy Incident

Owners and Partners use this API to copy an existing incident to the network. A boolean field determines whether to the linked processes from the original to the new incident.

The new incident is assigned the To Do base 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-incident: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 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 existing incident to copy.
  aptBusinessObjectSummary String Required. A brief summary of the incident. Cannot exceed 255 characters.
  createdByPartner Boolean

Indicates whether the new incident is created by a person from the Partner company.

Valid values:

  • true – Yes, the new incident is created by a user from the Partner.
  • false – No, the new incident is created by a user from the Owner.
  copyRelatedProcesses Boolean

Required. Indicates whether all Related Processes values are copied from the original incident to the new incident.

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

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-incident:v3",
        "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "862d6e7b-3c87-448c-94cb-a47e07297ef4",
        "aptBusinessObjectSummary": "Copy Without generalInfo",
        "copyRelatedProcesses": true,
        "createdByPartner":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-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.
 

aptBusinessObjectId

 String Required. The unique TraceLink identifier for the new incident (e.g. APT-12345).
  id String Required. The identifier for the new incident.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:copy-incident-response:v3",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "80dHz8-jhrrTu"
    },
    "payload": {
        "aptBusinessObjectId": "SRJCMP-3283",
        "id": "8be527b8-bb95-4ada-a334-d7fea5c855ba"
    }
}

Errors

Element Error Message Description
authorization User does not have permission to copy incidents. The error occurs if the user does not have the Copy Incident permission.
id Process ID is required. The error occurs is the source is empty or null.
copyRelatedProcesses Copy Related Processes value must be True or False. The error occurs if the source does not equal true or false.

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.

Close Incident

Owners and Partners use this API to close an existing general incident. A closing statement and resolution type must be provided.

The closed incident transitions from its current base state (either To Do or Under Investigation) to a Closed state. Closed incidents 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-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 existing incident to close.
 

isReoccurring

 Boolean

Indicates whether the incident has previously occurred one or more times. Valid values:

  • true – The incident has previously occurred one or more times.
  • false – The incident has not occurred before.
  resolutionType Enum

Required. The reason why the incident is being closed. Valid values depend on the current base state of the incident:

  • If currentBaseState = UnderInvestigation, valid values are:
    • RESOLVED – The problem that caused the incident is resolved.
    • OTHER – The resolution type is user-defined in otherResolutionType.
  • If currentBaseState = ToDo, valid values are:
    • DUPLICATE – An incident for the problem already exists.
    • NOT_AN_ISSUE – The incident was created in error and the investigation determined there was not actually a problem.
    • OTHER – The resolution type is user-defined in otherResolutionType.
  otherResolutionType String

If resolutionType is OTHER, this is the user-defined resolution type.

To prevent corrupted data, otherResolutionType should only be included in the request if resolutionType is OTHER.
  finalRootCause Enum

The main issue that directly caused the issue to occur. Valid values:

  • DOCUMENTATION – The incident occurred due to a documentation issue.
  • EQUIPMENT – The incident occurred due to an equipment issue.
  • MATERIAL – The incident occurred due to a material issue.
  • PROCEDURE – The incident occurred due to a procedural issue.
  • PROCESS – The incident occurred due to a process issue.
  • ROOT_CAUSE_NOT_ATTRIBUTED_TO_PARTNER – The root cause of the incident cannot be attributed to the Partner.
 

closingStatement

 String

Any final closing statement about the incident and its closure. Cannot exceed 5000 characters.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-incident:v1",
         "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "3b1e308a-8c89-431b-bbee-34f9b0b36302",
        "resolutionType": "NOT_AN_ISSUE",
        "isReoccuring": false,
        "finalRootCause": "AUDIT_ERROR",
        "closingStatement": "Closing this 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:close-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.
 

aptBusinessObjectId

 String The unique TraceLink identifier for the closed incident (e.g. APT-12345).
  id String Required. The identifier for the closed incident.
  message String Required. The message confirming that the incident was closed.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-incident-response:v1",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "80dHz8-jhrrTu"
    },
    "payload": {
        "aptBusinessObjectId": "SRJCMP-3318",
        "id": "3b1e308a-8c89-431b-bbee-34f9b0b36302",
        "message": "incident reopened successfully."
    }
}

Errors

Element Error Message Description
authorization User does not have permission to close incidents. The error occurs if the user does not have the Close Incident permission.
id Process ID is required. The error occurs if the source is empty or null.
resolutionType Resolution Type is required. The error occurs if the source is empty or null.
resolutionType Invalid Resolution Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
isReoccurring Reoccurring Incident value must be True or False. The error occurs if the source does not equal true or false.
closingStatement Closing Statement is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.

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.

Reopen Incident

Owners use this API to reopen a closed general incident. The response returns the identifier of the reopened incident. The system reopens the incident with all information intact, except the base state is updated from from Closed to UnderInvestigation. Reopened incidents cannot be transitioned back to the initial ToDo base 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-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 closed incident to reopen.
  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:reopen-incident:v1",
         "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "3b1e308a-8c89-431b-bbee-34f9b0b36302",
        "resolutionType": "NOT_AN_ISSUE",
        "isReoccuring": false,
        "finalRootCause": "AUDIT_ERROR",
        "closingStatement": "Closing this 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:reopen-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.
 

aptBusinessObjectId

 String The unique TraceLink identifier for the reopened incident (e.g. APT-12345).
  id String Required. The identifier for the reopened incident.
  message String Required. The message indicating the incident is reopened.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-incident-response:v1",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "80dHz8-jhrrTu"
    },
     "payload": {
       "aptBusinessObjectId": "SRJCMP-3318",
        "id": "3b1e308a-8c89-431b-bbee-34f9b0b36302",
        "message": "incident reopened successfully."
    }
}

Errors

Element Error Message Description
authorization User does not have permission to reopen incidents. The error occurs if the user does not have the Reopen Incident permission.
id Process ID is required. The error occurs if the source is empty or null.
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 ownerOnly or Public.
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 ownerOnly or Public.

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.

Submit Incident to Partner

Owners use API to submit an existing general incident to the Partner specified in the incident partnerId. This cannot be undone.

Upon successful response:

  • isSubmittedToPartner updates to true.
  • The incident becomes visible to the Partner.
This API does not update the incident's base workflow state. Use the Edit API to transition the incident 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-incident-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 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 submit to the Partner company specified in the partnerId.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:submit-incident-to-partner:v1",
         "ownerId": "{{test-owner1}}",
        "processNetworkId": "{{test-pni1}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id" : "d0714093-9270-4567-9f2b-5e054875befc"
    }
}

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-incident-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.
  successMessage String Required. The message indicating the incident is submitted to the Partner.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:submit-incident-to-partner-response:v1",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "80dHz8-jhrrTu"
    },
    "payload": {
        "successMessage": "Process is submitted to partner."
    }
}

Errors

Element Error Messages Description
authorization User does not have permission to submit the incident to the partner.

The error occurs if the user does not have the Submit to Partner permission.
id Process ID is required. The error occurs if the source is empty or null.

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.