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

External manufacturing incident APIs

Companies that own or link to Agile Process Teams use these APIs to add, update, and resolve external manufacturing incidents (i.e. incidents involving providers of contract manufacturing and packaging services for APIs, bulk, and finished goods). For example, a CMO might need to report a damaged lot to the Manufacturer, or a Manufacturer might need to report a late or missing shipment to the CMO. Once the incident is added, 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 External Manufacturing Incident

Owners and Partners use this API to add a new external manufacturing 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-external-manufacturing-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.
  partnerCompany 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 Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  partnerLocationId String The identifier of the Partner company location associated with the incident. The location must exist in Master Data.
 

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.
  deviationType String

The way in which the incident varies from standard operating procedure. Valid values: 

  • PLANNED – The deviation that caused the incident was intentional.
  • UNPLANNED – The deviation that caused the incident was not intentional.
  • OTHER – The deviation that caused the incident was user-defined. If this field is OTHER, use the otherDeviationType to define the deviation type.
  otherDeviationType String

If the deviationType is OTHER, this is the user-defined deviation type.

To prevent corrupted data, the otherDeviationType should only be included in the request if the deviationType is OTHER.
  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).
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the incident's resolution. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for resolving the incident is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for resolving the incident is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for resolving the incident is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for resolving the incident is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for resolving the incident is part of a Customer Service team.
  • ENGINEERING – The user responsible for resolving the incident is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for resolving the incident is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for resolving the incident is part of an Operations team.
  • PACKAGING – The user responsible for resolving the incident is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for resolving the incident is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for resolving the incident is part of a Project Management team.
  • PURCHASING – The user responsible for resolving the incident is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for resolving the incident is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for resolving the incident is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for resolving the incident is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for resolving the incident is part of a Supply Chain team.
  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).
  responsibleDepartmentAtPartner String The business area of the Partner company that is responsible for the incident's resolution. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for resolving the incident is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for resolving the incident is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for resolving the incident is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for resolving the incident is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for resolving the incident is part of a Customer Service team.
  • ENGINEERING – The user responsible for resolving the incident is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for resolving the incident is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for resolving the incident is part of an Operations team.
  • PACKAGING – The user responsible for resolving the incident is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for resolving the incident is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for resolving the incident is part of a Project Management team.
  • PURCHASING – The user responsible for resolving the incident is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for resolving the incident is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for resolving the incident is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for resolving the incident is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for resolving the incident is part of a Supply Chain team.
  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).
  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).
  materialType String

The type of the material associated with the incident. Valid values:

  • API – The incident is associated with an active pharmaceutical ingredient (API).
  • FINISHED_GOOD – The incident is associated with a finished good.
  • SERIALIZED_PRODUCT – The incident is associated with a serialized product.
  • SECONDARY_PACKAGING – The incident is associated with packaging that is not in direct contact with the product.
  • EXCIPIENT – The incident is associated with an excipient or inactive substance.
  • FINISHED_GOOD_SAMPLE – The incident is associated with a sample of a finished good.
  • PRIMARY_PACKAGING – The incident is associated with packaging that is in direct contact with the product.
  • DELIVERY_MECHANISM – The incident is associated with the method used to administer a product.
  • LABEL_AND_ARTWORK – The incident is associated with the product label or artwork.
  • CONTACT_MATERIAL_OR_EQUIPMENT – The incident is associated with materials or equipment intended to come in direct contact with a product.
  • SHIPPING_MATERIAL – The incident is associated with materials used in product shipping.
  • BLOOD_PRODUCT – The incident is associated with a substance prepared from human blood.
  • OTHER – The incident is associated with a user-defined material. If this field is OTHER, use the otherMaterialType to define the material type.
  otherMaterialType String

If the materialType is OTHER, this is the user-defined material type associated with the incident.

To prevent corrupted data, the otherMaterialType should only be included in the request if the materialType is OTHER.
  materialSubtype String

The subtype of the selected material type associated with the incident. Valid values depend on the materialType selected, as follows: 

  • BIOLOGICAL_API – The incident is associated with a biological API.
  • CHEMICAL_API – The incident is associated with a chemical API.
  • RELEASED – The incident is associated with a finished product that has been released.
  • SHIPPED – The incident is associated with a finished product that has been shipped.
  • EACH – The incident is associated with a serialized each.
  • INNER_PACK_BUNDLE – The incident is associated with a serialized inner pack.
  • CASE_SHIPPER – The incident is associated with a serialized case.
  • PALLET – The incident is associated with a serialized pallet.
  • CARTON – The incident is associated with a carton.
  • TRAY – The incident is associated with a tray.
  • INNER_PACK_BUNDLE – The incident is associated with an inner pack or bundle.
  • SHELF_PACK – The incident is associated with a shelf pack.
  • ANTI_ADHERENT – The incident is associated with an anti-adherent.
  • BINDER – The incident is associated with a binder.
  • COATING – The incident is associated with a coating product.
  • DISINTEGRANT – The incident is associated with a disintegrant.
  • FILLER – The incident is associated with filler.
  • FLAVOR – The incident is associated with a flavoring product.
  • COLOR – The incident is associated with a coloring product.
  • LUBRICANT – The incident is associated with a lubricant.
  • GLIDANT – The incident is associated with a lubricant glidant.
  • SORBENT – The incident is associated with a sorbent.
  • SWEETENER – The incident is associated with a sweetener.
  • PRESERVATIVE – The incident is associated with a preservative.
  • SAMPLE – The incident is associated with a sample of a finished good.
  • AMPOULE_AND_CLOSURE – The incident is associated with a sealed ampoule.
  • VIAL_AND_CLOSURE – The incident is associated with a sealed vial.
  • BLISTER_PACK_AND_FOIL – The incident is associated with a blister pack.
  • BOTTLE_AND_LID_OR_CAP – The incident is associated with a bottle.
  • SACHET_OR_POUCH – The incident is associated with a sachet or pouch.
  • STRIP_PACKAGE – The incident is associated with a strip.
  • BULK_PACKAGING – The incident is associated with bulk packaging for multiple items.
  • ORAL – The incident is associated with a product administered orally.
  • TRANSDERMAL – The incident is associated with a product administered transdermally.
  • INJECTABLE – The incident is associated with an injectable product.
  • PULMONARY_INHALER – The incident is associated with a product administered through a pulmonary inhaler.
  • IMPLANT – The incident is associated with an implanted medical device.
  • OPHTHALMIC – The incident is associated with a product administered to the eye.
  • PRIMARY_LABEL – The incident is associated with a product's primary label.
  • SECONDARY_LABEL – The incident is associated with a product's secondary label.
  • LEAFLET_OR_INSERT – The incident is associated with the contents of a leaflet or insert accompanying a product.
  • CARTON_ARTWORK – The incident is associated with artwork on a product carton.
  • FORMULATION_EQUIPMENT – The incident is associated with equipment used in product formulation.
  • FILLING_EQUIPMENT – The incident is associated with equipment used in filling packages.
  • BULK_STORAGE_EQUIPMENT – The incident is associated with equipment used in product storage.
  • TRANSFER_EQUIPMENT – The incident is associated with equipment used in product transfer.
  • PALLET – The incident is associated with a pallet used for shipping.
  • PALLET_LABEL – The incident is associated with a label for a pallet used for shipping.
  • CASE_LABEL – The incident is associated with a label for a case used for shipping.
  • STRETCH_WRAP – The incident is associated with stretch wrap packaging.
  • FRESH_FROZEN_PLASMA – The incident is associated with fresh frozen plasma.
  • PLATELETS – The incident is associated with blood platelets.
  • ALBUMIN – The incident is associated with medicinal albumin.
  • CRYOPRECIPITATE – The incident is associated with cryoprecipitate, which is a concentrated frozen blood product.
  • PACKED_RED_BLOOD_CELLS – The incident is associated with packed cells used for blood transfusions.
  • OTHER – The incident is associated with a user-defined material. If this field is OTHER, use the otherMaterialType to define the subtype.
  otherMaterialSubtype String

If the materialSubtype is OTHER, this is the user-defined subtype of the user-defined material associated with the incident.

To prevent corrupted data, the otherMaterialSubtype should only be included in the request if the materialSubtype is OTHER.
  materialProblem String

The problem with the material associated with the incident. Valid values depend on the materialSubtype selected, as follows:

  • MATERIAL_SHORTAGE – A material shortage occurred.
  • NOT_ON_TIME_OR_IN_FULL – The shipment was late or missing product.
  • DAMAGED_PRODUCT – Product was damaged at an undetermined time.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • TEMPERATURE_EXCURSION_DURING_SHIPMENT_OR_STORAGE – The product did not stay within the required temperature range.
  • CONTAMINATION_FROM_FOREIGN_PARTICLE_OR_PARTICULATE – The product was contaminated with an undesired particulate.
  • MANUFACTURING_FACILITY_EXCEPTION – The issue is related to an exception raised by the manufacturing facility.
  • RAW_MATERIAL_QUALITY – The product does not meet quality requirements.
  • IMPURITIES_PRESENT – One or more impurities were found in the product.
  • HANDLING_OR_STORAGE_DEVIATION – An unplanned deviation from current best practices related to product handling or storage occurred.
  • CGMP_SOP_NOT_FOLLOWED – Good manufacturing practices documented in the current standard operating procedure (SOP) were not followed.
  • SHORT_SHIPMENT_RECEIVED – The received shipment does not include all expected contents.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • PRODUCT_SHIPPED_BUT_NOT_COMMISSIONED – The product is not in the required state of Commissioned.
  • MISSING_PRODUCT_OR_PARTIAL_LOT – Not all expected product is included in the lot.
  • PRINTED_SERIAL_NUMBER_DOES_NOT_MATCH_DATA – The product serial number does not have the expected value.
  • COMMISSIONED_PRODUCT_NOT_SHIPPED – The commissioned product was not included in the shipment.
  • PRODUCT_SHIPPED_BUT_NOT_QA_RELEASED – The product is not in the required state of QA Released.
  • CANNOT_RECONCILE_SERIAL_NUMBER_WITH_ERP_OR_WMS – The product's serial number could not be reconciled against the appropriate ERP or WMS system.
  • AGGREGATION_ERROR – An aggregation or disaggregation error occurred.
  • PARTIAL_SERIAL_NUMBER_LEGIBLE – The serial number is not legible.
  • SERIAL_NUMBER_COMMISSION_OUTPUT_CHANGE – A commissioning error occurred.
  • VARIABILITY_IN_PARTICLE_SIZE_HARDNESS_DISINTEGRATION_AND_COMPRESSIBILITY – The product does not meet consistency requirements.
  • POOR_CHEMICAL_DURABILITY – An issue occurred with the product's durability, such as weathering, pitted surfaces, or delamination.
  • SILICONE_LUBRICANTS_IMPACTED_PRODUCT_QUALITY – The product's quality has been affected by interaction with silicone lubricants.
  • POTENTIAL_LEACHING_OR_INTERACTION_WITH_PRODUCT – The product has possibly interacted with an undesired contaminant.
  • CLOSURE_ISSUE_WITH_LID_OR_CAP – A problem occurred with the product's lid or cap.
  • PH_SHIFT_DUE_TO_GLASS_DISSOLUTION – The product's pH has changed.
  • 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.
  • DAMAGE_FROM_PACKING_TRANSPORT_OR_FILLING – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage.
  • LABEL_COMPLIANCE_ERROR – The product's label is not in compliance with necessary regulations.
  • 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.
  • MARKET_LANGUAGE_TRANSLATION_ERROR – An error occurred when translating product information for the target market.
  • IMPROPER_ARTWORK_INSPECTION – An error occurred during artwork inspection.
  • DAMAGED_PRODUCT – Product was damaged at an undetermined time.
  • LOT_AND_EXPIRATION_PRINT_ISSUE – An issue occurred related to lot and expiration information.
  • POOR_LABEL_ADHESION – An issue occurred with the product's label.
  • SHORT_SHIPMENT_OR_PRODUCTION_RUN – The shipment or production run does not include all expected contents.
  • OTHER – The problem with the material is user-defined. If this field is OTHER, use otherMaterialProblem to define the material problem.
  otherMaterialProblem String

If the materialProblem is OTHER, this is the user-defined problem with the user-defined material associated with the incident.

To prevent corrupted data, the otherMaterialProblem should only be included in the request if the materialProblem is OTHER.
  isEscalated Boolean

Indicates whether the location affected by the incident has requested the incident to be escalated. Valid values:

  • true – Yes, the location affected by the incident requested the incident to be escalated. The escalation report is provided in the aptEscalationReportBox object.
  • false – No, the incident is not escalated.
  originatingLocation Array The identifier number and type of the originating location of the incident.
    originatingLocationId String The identifier of the internal or external location that caused the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
  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.
  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.
  isSubmittedToPartner Boolean

If the user adding the incident is a member of the Owner company with permission to submit the incident to Partner, this indicates whether the incident is submitted to the Partner specified in partnerId during the add event. If the user adding the incident is a member of the Partner company, this field is automatically set to true (the incident is automatically visible to process team members from the Owner and Partner company. Valid values:

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

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  externalManufacturingMaterialInformation Object Contains information about the material product affected by the incident.
    companyInternalMaterialInformation String The internal material number that the Owner company uses to identify the product. Cannot exceed 255 characters.
    partnerInternalMaterialInformation String The internal material number that the Owner company uses to identify the product. Cannot exceed 255 characters.
    materialName String The name of the product affected by the incident. Cannot exceed 255 characters.
    materialDescription String The description of the product. Cannot exceed 500 characters.
    companyLotNumber String The Owner company's lot number for the product. Cannot exceed 255 characters.
    partnerLotNumber String The Partner company's lot number for the product. Cannot exceed 255 characters.
    defectiveQuantity String The amount of product affected by the incident that is no longer saleable (e.g. 1,500). Cannot exceed 72 characters.
    defectiveUnitOfMeasure String

Conditionally required if the defectiveQuantity value is present. The unit of measure for the specified amount of defective product.

  • AMPOULE – The product is measured in ampoules.
  • BUNDLE – The product is measured in bundles.
  • BAG – The product is measured in bags.
  • BOTTLE – The product is measured in bottles.
  • BOX – The product is measured in boxes.
  • CARD_OR_BLISTER – The product is measured in cards or blisters.
  • CENTILITER – The product is measured in centiliters.
  • CAPSULE – The product is measured in capsules.
  • CASE – The product is measured in cases.
  • CUBIC_CENTIMETER – The product is measured in cubic centimeters.
  • CUBIC_FEET – The product is measured in cubic feet.
  • CUBIC_INCH – The product is measured in cubic inches.
  • CYLINDER – The product is measured in cylinders.
  • CENTIMETER – The product is measured in centimeters.
  • CAN – The product is measured in cans.
  • CRATE – The product is measured in crates.
  • CARTRIDGE – The product is measured in cartridges.
  • CUBIC_METER – The product is measured in cubic meters.
  • CARTON – The product is measured in cartons.
  • KILOMETER – The product is measured in kilometers.
  • DECILITER – The product is measured in deciliters.
  • DISPENSER – The product is measured in dispensers.
  • DECIMETER – The product is measured in decimeters.
  • DRUM – The product is measured in drums.
  • DISPLAY – The product is measured in displays.
  • DOZEN – The product is measured in dozens.
  • EACH – The product is measured in eaches.
  • FLUID_OUNCE_US – The product is measured in US fluid ounces.
  • GALLON_US – The product is measured in US gallons.
  • GRAM – The product is measured in grams.
  • GRAM_OR_LITER – The product is measured in grams or liters.
  • GROSS – The product is measured in grosses of product.
  • HECTOLITER – The product is measured in hectoliters.
  • KILOLITER – The product is measured in kiloliters.
  • KILOGRAM – The product is measured in kilograms.
  • KIT – The product is measured in kits.
  • POUND_US – The product is measured in US pounds.
  • LOT – The product is measured in lots.
  • LITER – The product is measured in liters.
  • METER – The product is measured in meters.
  • MICROGRAM – The product is measured in micrograms.
  • MICROLITER – The product is measured in microliters.
  • MILLIGRAM – The product is measured in milligrams.
  • MILLILITER – The product is measured in milliliters.
  • MILLIMETER – The product is measured in millimeters.
  • OUNCE – The product is measured in ounces.
  • PACK – The product is measured in packs.
  • PACKAGE – The product is measured in packages.
  • PAIR – The product is measured in pairs.
  • PALLET – The product is measured in pallets.
  • PIECE – The product is measured in pieces.
  • PINT – The product is measured in pints.
  • POUCH – The product is measured in pouches.
  • QUART – The product is measured in quarts.
  • ROLL – The product is measured in rolls.
  • SET – The product is measured in sets.
  • SHEET – The product is measured in sheets.
  • SQUARE_CENTIMETER – The product is measured in square centimeters.
  • SQUARE_FOOT – The product is measured in square feet.
  • SQUARE_INCH – The product is measured in square inches.
  • SQUARE_METER – The product is measured in square meters.
  • THOUSAND_PIECE – The product is measured in thousand pieces.
  • THOUSANDS – The product is measured in thousands.
  • TRAY – The product is measured in trays.
  • TUBE – The product is measured in tubes.
  • TABLET – The product is measured in tablets.
  • MILLION – The product is measured in millions.
  • UNIT – The product is measured in units.
  • VIAL – The product is measured in vials.
    defectiveItemInformation String The identifiers associated with the defective product that can no longer be used (e.g. container IDs, bag IDs, serial numbers). Cannot exceed 1000 characters.
    samplesAvailable Boolean

Indicates whether samples of the defective product are available. Valid values:

  • true – Yes, samples of the defective product are available.
  • false – No, samples of the defective product are not available.
  externalManufacturingResponse Object Contains information about the incident response from the Partner.
    initialResponseDueDate Number

The date and time (in Unix epoch time in milliseconds) that the initial response from the Partner is due to the Owner (e.g. 1622631600). 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 initialResponseRequiredWithinHours is 24 and the current date is 01 Jun 2021, the initialResponseDueDate is calculated as 02 Jun 2021.
    initialResponseInformation String The text of the initial response from the Partner. Cannot exceed 5000 characters.
    finalResponseDueDate Number

The date and time (in Unix epoch time in milliseconds) that the final response from the Partner is due to the Owner (e.g. 1623495600). 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 current date. For example, if the default finalResponseRequiredWithinHours is 288 and the current date is 01 Jun 2021, the finalResponseDueDate is calculated as 12 Jun 2021.
    finalResponseInformation String The text of the final response from the Partner. Cannot exceed 5000 characters.
    dateSamplesSentToCompany Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are sent to the Owner company.
    dateSamplesReceivedByCompany Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are received by the Owner company.
    dateSamplesSentToPartner Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are sent to the Partner company.
    dateSamplesReceivedByPartner Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are received by the Partner company.
    inventoryImpact String A description of the extent to which the impacted product is affected. Cannot exceed 5000 characters.
    inventoryAnalysisMethod String A description of the method used to determine the extent to which the impacted product is affected. Cannot exceed 5000 characters.
    initialContainmentActions String A description of the first steps to prevent the incident from affecting more product. Cannot exceed 5000 characters.
    recommendationFromOriginatingCompany String A description of what the company that the incident originated from suggests to prevent the issue from occurring again in the future. Cannot exceed 5000 characters.
    immediateCorrectiveActions String A description of the first corrective actions taken by the Partner to fix the issue that caused the incident to occur. Cannot exceed 5000 characters.
    potentialRootCauses String

The possible main issues that directly caused the incident 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.
  • OTHER – The root cause of the incident is user-defined. If this field is OTHER, use the otherPotentialRootCauses to define the potential root cause.
    otherPotentialRootCauses String

If the potentialRootCauses is OTHER, this is the user-defined possible main issue that directly caused the incident to occur.

To prevent corrupted data, the otherPotentialRootCauses should only be included in the request if the potentialRootCauses is OTHER.
    potentialRootCauseNotes String A description explaining how the potential root cause is determined (e.g. which potential root causes were considered) and what the root cause of the issue is believed to be. Cannot exceed 5000 characters.
    finalPreventativeActions String A description of the final corrective actions taken by the Partner to prevent the incident to occurring again after they have performed a root cause analysis. Cannot exceed 5000 characters.
    methodsToProvePreventativeActionsTaken String A description of the measures implemented to prove that the corrective actions have been successfully implemented (e.g. testing, audits). Cannot exceed 5000 characters.
    replacementMaterials Array The products that can replace the products affected by the incident.
      availabilityDateForReplacements Number The date that the substitute is available to replace the affected product.
      transactionIdsForReplacements Array The identifiers of transactions or shipments containing the replacement product.
        replacementsTransactionType Enum

The type of shipping document for the replacement delivery transaction. 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.
  externalManufacturingImpact Object Required. Contains information about the incident's impact to the Owner company.
    businessImpact String A description how the Owner's business is impacted by 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.
    highPriorityReasons String

The one or more reasons that the incident is a high priority for the company. Valid values:

  • DISRUPTION_OR_CUSTOMER_BACKORDER – The incident disrupts the customer's ability to fill orders.
  • EXTENDED_TIME_TO_RESOLVE – The incident cannot be resolved in a timely manner.
  • FIELD_ACTION_REQUIRED – The incident requires additional action to be taken in the field.
  • TOP_PRODUCT_IMPACTED – The incident negatively affects an important product.
  • NEW_PRODUCT_LAUNCH_IMPACTED – The incident interferes with the launch of a new product.
  • MANUFACTURING_DISRUPTION – The incident disrupts manufacturing operations.
  • MANUFACTURING_DOWNTIME – The incident results in manufacturing downtime.
  • MARKET_SUPPLY_IMPACTED – The incident negatively impacts market supply.
  • MEDICALLY_SIGNIFICANT – The incident is medically significant.
  • PATIENT_SAFETY_IMPACTED – The incident negatively affects patient safety.
  • REVENUE_IMPACTED – The incident negatively affects revenue.
  • UNAVAILABLE_TO_CUSTOMERS – The incident results in product being unavailable to customers.
  • OTHER – The incident is a high priority for a user-defined reason. If this field is OTHER, use otherHighPriorityReasons to define the reason.
    otherHighPriorityReasons String If the highPriorityReasons is OTHER, this is the user-defined reason that the incident is a high priority for the company
To prevent corrupted data, the otherHighPriorityReasons should only be included in the request if highPriorityReasons is OTHER.
    financialImpact Number The monetary impact that the incident has on the Owner, entered as a numeric with decimals (e.g. 150000.00). Cannot exceed 255 characters.
    dateSupplyImpacted Number The date and time (in Unix epoch time in milliseconds) that the Owner's supply chain is affected by the incident.
    originatingLocationInvestigationDueDate Number The date and time (in Unix epoch time in milliseconds) that the Partner company's investigation of the location where the incident occurred is due to the Owner.

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 originatingSiteInvestigationRequiredWithinHours is 48 and the current date is 01 Jun 2021, the originatingLocationInvestigationDueDate is calculated as 03 Jun 2021.
    dateResourcesDeployed Number The date and time (in Unix epoch time in milliseconds) that resources, such as people or money, are deployed to start managing the incident.
    dateEscalationReportRequested Number For escalated incidents (isEscalated = true), the date the escalation report for the incident is requested by.
  impactedProducts String Identifiers for the one or more products that are affected by the incident.
  potentiallyImpactedProducts String Identifiers for the one or more products that could be affected by the incident.
  impactedLocations Array One or more internal or external locations that are impacted by the incident.
    locationId String The identifier of the internal or external location that is impacted by the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
    locationType String

Indicates whether the impacted location is internal or external.

Valid values:

  • Internal – The impacted location is an internal location.
  • External – The impacted location is an external location.
    locationContact String The user that is the regulatory contact for the location.
  potentiallyImpactedLocations Array One or more internal or external locations that could be impacted by the incident.
    locationId String The identifier of the internal or external location that is potentially impacted by the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
    locationType Enum

Indicates whether the potentially impacted location is internal or external.

Valid values:

  • Internal – The potentially impacted location is an internal location.
  • External – The potentially impacted location is an external location.
    locationContact String The user that is the regulatory contact for the location.
  aptEscalationReportBox Object For escalated incidents (isEscalated = true), contains the escalation report.
    addAttachment Array The file to attach to the incident as the escalation report. 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.
  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.
  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-external-manufacturing-incident:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "aptBusinessObjectSummary": "Raw materials shortage at Location XYZ",
        "externalManufacturingImpact": {
            "businessPriority": "HIGH"
        }
    }
}
Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-external-manufacturing-incident:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "partnerCompany": {
            "partnerId": "be9c8cea-72bc-459c-97b9-ef3f7c73ccc8",
            "toIdType": "companyMasterData"
        },
        "partnerLocationId": "bb75c388-16f7-4a18-9c77-f418d928359e",
        "aptBusinessObjectSummary": "Missing Shipment",
        "aptBusinessObjectDescription": "Shipment XYZ missing at Location ABC",
        "deviationType": "PLANNED",
        "responsiblePartyAtCompany": "ff060ac0-035d-11eb-8738-0242ac110017",
        "responsibleDepartmentAtCompany": "CUSTOMER_SERVICE",
        "responsiblePartyAtPartner": "bb75c388-16f7-4a18-9c77-f418d928359e",
        "responsibleDepartmentAtPartner": "SUPPLY_CHAIN",
        "currentlyAssignedCompanyUsers": [
            "bb75c388-16f7-4a18-9c77-f418d928359e"
        ],
        "currentlyAssignedPartnerUsers": [
            "ff060ac0-035d-11eb-8738-0242ac110017",
            "feb32fd0-035d-11eb-bb87-0242ac110017"
        ],
        "materialType": "FINISHED_GOOD",
        "materialSubtype": "CHEMICAL_API",
        "materialProblem": "MATERIAL_SHORTAGE",
        "originatingLocation": {
            "originatingLocationId": "524b43f0-0bdb-4221-84d8-fec090151b0a",
            "toIdType": "partnerLocationMasterData"
        },
        "resolutionDueDate": 1651133945000,
        "createdByPartner": false,
        "isSubmittedToPartner": true,
        "referenceIdentifiers": {
            "referenceTransactionType": "BILL_OF_LADING",
            "value": "GTIN-1161187176294956"
        },
        "externalManufacturingMaterialInformation": {
            "companyInternalMaterialInformation": "pim161187176294672",
            "partnerInternalMaterialInformation": "pim161187176294672",
            "materialName": "Material Name",
            "materialDescription": "Material Description",
            "companyLotNumber": "cln161187176294679",
            "partnerLotNumber": "pln161187176294652",
            "defectiveQuantity": 1,
            "defectiveUnitOfMeasure": "CENTILITER",
            "defectiveItemInformation": "Defective Item Information",
            "samplesAvailable": false
        },
        "externalManufacturingResponse": {
            "initialResponseDueDate": 1641133945000,
            "initialResponseInformation": "Initial Response Information",
            "finalResponseDueDate": 1641133945000,
            "finalResponseInformation": "Final Response Information",
            "dateSamplesSentToCompany": 1641133945000,
            "dateSamplesReceivedByCompany": 1641133945000,
            "dateSamplesSentToPartner": 1641133945000,
            "dateSamplesReceivedByPartner": 1641133945000,
            "inventoryImpact": "Inventory Impact",
            "inventoryAnalysisMethod": "Inventory Analysis Method",
            "initialContainmentActions": "Final Containment Actions",
            "recommendationFromOriginatingCompany": "Recommendation From Originating Company",
            "immediateCorrectiveActions": "Immediate Corrective Actions",
            "potentialRootCauses": [
                "DOCUMENTATION"
            ],
            "potentialRootCauseNotes": "Potential Root Cause Notes",
            "finalPreventativeActions": "Final Preventative Actions",
            "methodsToProvePreventativeActionsTaken": "Methods To Prove Preventative Actions Taken",
            "replacementMaterials": [
                {
                        "availabilityDateForReplacements": 1641133945000,
                        "transactionIDsForReplacements": {
                            "referenceTransactionType": "INVOICE_NUMBER",
                            "value": "100"
                        }
                }
            ],
            "externalManufacturingImpact": {
                "businessImpact": "Business Impact",
                "businessPriority": "HIGH",
                "impactedDepartments": [
                    "CUSTOMER_SERVICE"
                ],
                "highPriorityReasons": [
                    "Reason1"
                ],
                "financialImpact": 164113394500,
                "dateSupplyImpacted": 1641133945000,
                "originatingLocationInvestigationDueDate": 1641133945000,
                "dateResourcesDeployed": 1641133945000,
                "dateEscalationReportRequested": 1641133945000
            },
            "impactedProducts": [
                "613ac6ab-2940-45c4-b214-ea84feb4e931"
            ],
            "potentiallyImpactedProducts": [
                "fc58cbf8-1098-4f66-bf37-763922bd36b3",
                "613ac6ab-2940-45c4-b214-ea84feb4e931"
            ],
            "impactedLocations": {
                "locationId": "524b43f0-0bdb-4221-84d8-fec090151b0a",
                "toIdType": "companyLocationMasterData",
                "locationType": "INTERNAL",
                "locationContact": "edavis"
            },
            "potentiallyImpactedLocations": [
                {
                    "locationId": "524b43f0-0bdb-4221-84d8-fec090151b0a",
                    "toIdType": "companyLocationMasterData",
                    "locationType": "INTERNAL",
                    "locationContact": "edavis"
                }
            ],
            "isEscalated": true,
            "aptEscalationReportBox": {
                "addAttachment": [
                    {
                        "fileSize": "5mb",
                        "fileName": "aptEscalationReportBox1",
                        "requestIdentifier": "53e27ae1-6f5b-45c9-a6ab-5e480d652f4e",
                        "visibilityType": "Public"
                    },
                    {
                        "fileSize": "5mb",
                        "fileName": "aptEscalationReportBox2",
                        "requestIdentifier": "83bd02d6-ee59-46b3-ad40-2b5c86888623",
                        "visibilityType": "Public"
                    }
                ]
            },
            "relatedProcesses": [
                {
                    "processId": "c8c2b7ab-fcfd-448e-8964-798e42fb9aea",
                    "processType": "incident"
                }
            ],
            "aptCommentBox": [
                {
                    "aptComment": {
                        "commentText": "add DSI.",
                        "visibilityType": "Public"
                    },
                    "addAttachment": [
                        {
                            "fileSize": "5mb",
                            "fileName": "File1",
                            "requestIdentifier": "fc58cbf8-1098-4f66-bf37-763922bd36b3",
                            "visibilityType": "Public"
                        }
                    ]
                }
            ]
        }
    }
}

Guidelines

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

Required. Indicates whether the request was successful.

Valid values:

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

The exception thrown based on the error code.

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

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-external-manufacturing-incident-response:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "qL0BJs"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a"
    }
}

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.
responsibleDepartmentAtCompany Invalid Responsible Department at [Owning Company], must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
responsibleDepartmentAtPartner Invalid Responsible Department at Partner Company, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
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 not a valid value from the enumeration list.
aptBusinessObjectDescription Incident Description is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
partnerId Partner is not a valid network node. The error occurs if the source is not a valid linked Partner company.
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.
initialResponseDueDate Invalid Initial Response 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.
finalResponseDueDate Invalid Final Response 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.
initialResponseDueDate Partner users are not permitted to set the Initial Response Due Date.

The error occurs if the source is not blank and the user making the request is a process team member from the Partner company.
finalResponseDueDate Partner users are not permitted to set the Final Response Due Date.

The error occurs if the source is not blank and the user making the request is a process team member from the Partner company.
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.
isSubmittedToPartner Submit to Partner value must be True or False. The error occurs if the source does not equal true or false.
isSubmittedToPartner 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.
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 Owner's network.
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.
deviationType Invalid Deviation Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
materialType Invalid Material Type, must be one of the support values. The error occurs if the source is not a valid value from the enumeration list.
materialSubtype Invalid Material Subtype, must be one of the support values. The error occurs if the source is not a valid value from the enumeration list.
materialProblem Invalid Material Problem, must be one of the support values. The error occurs if the source is not a valid value from the enumeration list.
replacementsTransactionType 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.
impactedDepartments Invalid Impacted Department, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
highPriorityReasons Invalid High Priority Reason, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
aptEscalationReportBox | addAttachment | visibilityType Attachment visibility type must be Public or Internal. The error occurs if the source does not equal Public or Internal.
companyInternalMaterialInformation Internal Material Information is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
partnerInternalMaterialInformation Internal Material Information is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
materialName Material Name is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
materialDescription Material Description is greater than max length.

The error occurs if the source exceeds the maximum length of 500 characters.
companyLotNumber Lot Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
partnerLotNumber Lot Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
defectiveQuantity Defective Quantity is greater than max length.

The error occurs if the source exceeds the maximum length of 72 characters.
defectiveItemIds Defective Item IDs is greater than max length.

The error occurs if the source exceeds the maximum length of 1000 characters.
inventoryImpact Inventory Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
inventoryAnalysisMethod Inventory Analysis Method is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
initialContainmentActions Initial Containment Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
recommendationFromOriginatingCompany Recommendation From Originating Company is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
immediateCorrectiveActions Immediate Corrective Actions is greater than max length.

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

Potential Root Causes is greater than max length.

The error occurs if the source is not a valid value from the enumeration list.
potentialRootCauseNotes Potential Root Cause Notes is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
finalPreventativeActions Final Preventative Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
methodsToProvePreventativeActionsTaken Method To Prove Preventative Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
businessImpact Business Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
financialImpact Financial Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
financialImpact Financial Impact contains invalid characters. The error occurs if the source is not numeric with decimal.

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 External Manufacturing Incident

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

  • Modify an existing external manufacturing 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-external-manufacturing-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.
  id String Required. The identifier for the incident to modify.
  partnerCompany Object 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 Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  partnerLocationId String The identifier of the Partner company location associated with the incident. The location must exist in Master Data.
  aptBusinessObjectSummary String 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.
  deviationType String

The way in which the incident varies from standard operating procedure. Valid values: 

  • PLANNED – The deviation that caused the incident was intentional.
  • UNPLANNED – The deviation that caused the incident was not intentional.
  • OTHER – The deviation that caused the incident was user-defined. If this field is OTHER, use the otherDeviationType to define the deviation type.
  otherDeviationType String

If the deviationType is OTHER, this is the user-defined deviation type.

To prevent corrupted data, the otherDeviationType should only be included in the request if the deviationType is OTHER.
  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).
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the incident's resolution. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for resolving the incident is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for resolving the incident is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for resolving the incident is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for resolving the incident is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for resolving the incident is part of a Customer Service team.
  • ENGINEERING – The user responsible for resolving the incident is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for resolving the incident is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for resolving the incident is part of an Operations team.
  • PACKAGING – The user responsible for resolving the incident is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for resolving the incident is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for resolving the incident is part of a Project Management team.
  • PURCHASING – The user responsible for resolving the incident is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for resolving the incident is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for resolving the incident is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for resolving the incident is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for resolving the incident is part of a Supply Chain team.
  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).
  responsibleDepartmentAtPartner String The business area of the Partner company that is responsible for the incident's resolution. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for resolving the incident is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for resolving the incident is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for resolving the incident is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for resolving the incident is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for resolving the incident is part of a Customer Service team.
  • ENGINEERING – The user responsible for resolving the incident is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for resolving the incident is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for resolving the incident is part of an Operations team.
  • PACKAGING – The user responsible for resolving the incident is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for resolving the incident is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for resolving the incident is part of a Project Management team.
  • PURCHASING – The user responsible for resolving the incident is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for resolving the incident is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for resolving the incident is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for resolving the incident is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for resolving the incident is part of a Supply Chain team.
  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).
  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).
  materialType String

The type of the material associated with the incident. Valid values:

  • API – The incident is associated with an active pharmaceutical ingredient (API).
  • FINISHED_GOOD – The incident is associated with a finished good.
  • SERIALIZED_PRODUCT – The incident is associated with a serialized product.
  • SECONDARY_PACKAGING – The incident is associated with packaging that is not in direct contact with the product.
  • EXCIPIENT – The incident is associated with an excipient or inactive substance.
  • FINISHED_GOOD_SAMPLE – The incident is associated with a sample of a finished good.
  • PRIMARY_PACKAGING – The incident is associated with packaging that is in direct contact with the product.
  • DELIVERY_MECHANISM – The incident is associated with the method used to administer a product.
  • LABEL_AND_ARTWORK – The incident is associated with the product label or artwork.
  • CONTACT_MATERIAL_OR_EQUIPMENT – The incident is associated with materials or equipment intended to come in direct contact with a product.
  • SHIPPING_MATERIAL – The incident is associated with materials used in product shipping.
  • BLOOD_PRODUCT – The incident is associated with a substance prepared from human blood.
  • OTHER – The incident is associated with a user-defined material. If this field is OTHER, use the otherMaterialType to define the material type.
  otherMaterialType String

If the materialType is OTHER, this is the user-defined material type associated with the incident.

To prevent corrupted data, the otherMaterialType should only be included in the request if the materialType is OTHER.
  materialSubtype String

The subtype of the selected material type associated with the incident. Valid values depend on the materialType selected, as follows: 

  • BIOLOGICAL_API – The incident is associated with a biological API.
  • CHEMICAL_API – The incident is associated with a chemical API.
  • RELEASED – The incident is associated with a finished product that has been released.
  • SHIPPED – The incident is associated with a finished product that has been shipped.
  • EACH – The incident is associated with a serialized each.
  • INNER_PACK_BUNDLE – The incident is associated with a serialized inner pack.
  • CASE_SHIPPER – The incident is associated with a serialized case.
  • PALLET – The incident is associated with a serialized pallet.
  • CARTON – The incident is associated with a carton.
  • TRAY – The incident is associated with a tray.
  • INNER_PACK_BUNDLE – The incident is associated with an inner pack or bundle.
  • SHELF_PACK – The incident is associated with a shelf pack.
  • ANTI_ADHERENT – The incident is associated with an anti-adherent.
  • BINDER – The incident is associated with a binder.
  • COATING – The incident is associated with a coating product.
  • DISINTEGRANT – The incident is associated with a disintegrant.
  • FILLER – The incident is associated with filler.
  • FLAVOR – The incident is associated with a flavoring product.
  • COLOR – The incident is associated with a coloring product.
  • LUBRICANT – The incident is associated with a lubricant.
  • GLIDANT – The incident is associated with a lubricant glidant.
  • SORBENT – The incident is associated with a sorbent.
  • SWEETENER – The incident is associated with a sweetener.
  • PRESERVATIVE – The incident is associated with a preservative.
  • SAMPLE – The incident is associated with a sample of a finished good.
  • AMPOULE_AND_CLOSURE – The incident is associated with a sealed ampoule.
  • VIAL_AND_CLOSURE – The incident is associated with a sealed vial.
  • BLISTER_PACK_AND_FOIL – The incident is associated with a blister pack.
  • BOTTLE_AND_LID_OR_CAP – The incident is associated with a bottle.
  • SACHET_OR_POUCH – The incident is associated with a sachet or pouch.
  • STRIP_PACKAGE – The incident is associated with a strip.
  • BULK_PACKAGING – The incident is associated with bulk packaging for multiple items.
  • ORAL – The incident is associated with a product administered orally.
  • TRANSDERMAL – The incident is associated with a product administered transdermally.
  • INJECTABLE – The incident is associated with an injectable product.
  • PULMONARY_INHALER – The incident is associated with a product administered through a pulmonary inhaler.
  • IMPLANT – The incident is associated with an implanted medical device.
  • OPHTHALMIC – The incident is associated with a product administered to the eye.
  • PRIMARY_LABEL – The incident is associated with a product's primary label.
  • SECONDARY_LABEL – The incident is associated with a product's secondary label.
  • LEAFLET_OR_INSERT – The incident is associated with the contents of a leaflet or insert accompanying a product.
  • CARTON_ARTWORK – The incident is associated with artwork on a product carton.
  • FORMULATION_EQUIPMENT – The incident is associated with equipment used in product formulation.
  • FILLING_EQUIPMENT – The incident is associated with equipment used in filling packages.
  • BULK_STORAGE_EQUIPMENT – The incident is associated with equipment used in product storage.
  • TRANSFER_EQUIPMENT – The incident is associated with equipment used in product transfer.
  • PALLET – The incident is associated with a pallet used for shipping.
  • PALLET_LABEL – The incident is associated with a label for a pallet used for shipping.
  • CASE_LABEL – The incident is associated with a label for a case used for shipping.
  • STRETCH_WRAP – The incident is associated with stretch wrap packaging.
  • FRESH_FROZEN_PLASMA – The incident is associated with fresh frozen plasma.
  • PLATELETS – The incident is associated with blood platelets.
  • ALBUMIN – The incident is associated with medicinal albumin.
  • CRYOPRECIPITATE – The incident is associated with cryoprecipitate, which is a concentrated frozen blood product.
  • PACKED_RED_BLOOD_CELLS – The incident is associated with packed cells used for blood transfusions.
  • OTHER – The incident is associated with a user-defined material. If this field is OTHER, use the otherMaterialType to define the subtype.
  otherMaterialSubtype String

If the materialSubtype is OTHER, this is the user-defined subtype of the user-defined material associated with the incident.

To prevent corrupted data, the otherMaterialSubtype should only be included in the request if the materialSubtype is OTHER.
  materialProblem String

The problem with the material associated with the incident. Valid values depend on the materialSubtype selected, as follows:

  • MATERIAL_SHORTAGE – A material shortage occurred.
  • NOT_ON_TIME_OR_IN_FULL – The shipment was late or missing product.
  • DAMAGED_PRODUCT – Product was damaged at an undetermined time.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • TEMPERATURE_EXCURSION_DURING_SHIPMENT_OR_STORAGE – The product did not stay within the required temperature range.
  • CONTAMINATION_FROM_FOREIGN_PARTICLE_OR_PARTICULATE – The product was contaminated with an undesired particulate.
  • MANUFACTURING_FACILITY_EXCEPTION – The issue is related to an exception raised by the manufacturing facility.
  • RAW_MATERIAL_QUALITY – The product does not meet quality requirements.
  • IMPURITIES_PRESENT – One or more impurities were found in the product.
  • HANDLING_OR_STORAGE_DEVIATION – An unplanned deviation from current best practices related to product handling or storage occurred.
  • CGMP_SOP_NOT_FOLLOWED – Good manufacturing practices documented in the current standard operating procedure (SOP) were not followed.
  • SHORT_SHIPMENT_RECEIVED – The received shipment does not include all expected contents.
  • MISSING_OR_INCORRECT_DOCUMENTATION – Required product documentation is missing or incorrect.
  • PRODUCT_SHIPPED_BUT_NOT_COMMISSIONED – The product is not in the required state of Commissioned.
  • MISSING_PRODUCT_OR_PARTIAL_LOT – Not all expected product is included in the lot.
  • PRINTED_SERIAL_NUMBER_DOES_NOT_MATCH_DATA – The product serial number does not have the expected value.
  • COMMISSIONED_PRODUCT_NOT_SHIPPED – The commissioned product was not included in the shipment.
  • PRODUCT_SHIPPED_BUT_NOT_QA_RELEASED – The product is not in the required state of QA Released.
  • CANNOT_RECONCILE_SERIAL_NUMBER_WITH_ERP_OR_WMS – The product's serial number could not be reconciled against the appropriate ERP or WMS system.
  • AGGREGATION_ERROR – An aggregation or disaggregation error occurred.
  • PARTIAL_SERIAL_NUMBER_LEGIBLE – The serial number is not legible.
  • SERIAL_NUMBER_COMMISSION_OUTPUT_CHANGE – A commissioning error occurred.
  • VARIABILITY_IN_PARTICLE_SIZE_HARDNESS_DISINTEGRATION_AND_COMPRESSIBILITY – The product does not meet consistency requirements.
  • POOR_CHEMICAL_DURABILITY – An issue occurred with the product's durability, such as weathering, pitted surfaces, or delamination.
  • SILICONE_LUBRICANTS_IMPACTED_PRODUCT_QUALITY – The product's quality has been affected by interaction with silicone lubricants.
  • POTENTIAL_LEACHING_OR_INTERACTION_WITH_PRODUCT – The product has possibly interacted with an undesired contaminant.
  • CLOSURE_ISSUE_WITH_LID_OR_CAP – A problem occurred with the product's lid or cap.
  • PH_SHIFT_DUE_TO_GLASS_DISSOLUTION – The product's pH has changed.
  • 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.
  • DAMAGE_FROM_PACKING_TRANSPORT_OR_FILLING – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage.
  • LABEL_COMPLIANCE_ERROR – The product's label is not in compliance with necessary regulations.
  • 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.
  • MARKET_LANGUAGE_TRANSLATION_ERROR – An error occurred when translating product information for the target market.
  • IMPROPER_ARTWORK_INSPECTION – An error occurred during artwork inspection.
  • DAMAGED_PRODUCT – Product was damaged at an undetermined time.
  • LOT_AND_EXPIRATION_PRINT_ISSUE – An issue occurred related to lot and expiration information.
  • POOR_LABEL_ADHESION – An issue occurred with the product's label.
  • SHORT_SHIPMENT_OR_PRODUCTION_RUN – The shipment or production run does not include all expected contents.
  • OTHER – The problem with the material is user-defined. If this field is OTHER, use otherMaterialProblem to define the material problem.
  otherMaterialProblem String

If the materialProblem is OTHER, this is the user-defined problem with the user-defined material associated with the incident.

To prevent corrupted data, the otherMaterialProblem should only be included in the request if the materialProblem is OTHER.
  isEscalated Boolean

Indicates whether the location affected by the incident has requested the incident to be escalated. Valid values:

  • true – Yes, the location affected by the incident requested the incident to be escalated. The escalation report is provided in the aptEscalationReportBox object.
  • false – No, the incident is not escalated.
  originatingLocation Array The identifier number and type of the originating location of the incident.
    originatingLocationId String The identifier of the internal or external location that caused the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
  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.
  referenceIdentifiers Array One or more identifiers for transactions or shipments related to the incident (e.g. PO Number 1896155149).
    referenceTransactionType String

The type of transaction or shipping document.

Valid values:
  • BILL_OF_LADING – The transaction is identified by a Bill of Lading number.
  • DESTRUCTION_ORDER – The transaction is identified by a destruction order number.
  • INVOICE_NUMBER – The transaction is identified by an invoice number.
  • NOTA_FISCAL – The transaction is identified by a Brazil nota fiscal document number.
  • PACKING_SLIP_NUMBER – The transaction is identified by a packing slip number.
  • PO_NUMBER – The transaction is identified by a purchase order (PO) number.
  • PRO_NUMBER – The transaction is identified by a PRO freight number.
  • RETURN – The transaction is identified by a return authorization number.
  • SALES_ORDER_NUMBER – The transaction is identified by a sales order number.
  • SHIPMENT_NUMBER – The transaction is identified by a shipment notification number.
  • TRANSFER_NUMBER – The transaction is identified by a transfer order number.
  • OTHER – The transaction is identified by another type of identification number.
    value String The value for the selected referenceTransactionType. Cannot exceed 72 characters.
  externalManufacturingMaterialInformation Object Contains information about the material product affected by the incident.
    companyInternalMaterialInformation String The internal material number that the Owner company uses to identify the product. Cannot exceed 255 characters.
    partnerInternalMaterialInformation String The internal material number that the Partner company uses to identify the product. Cannot exceed 255 characters.
    materialName String The name of the product affected by the incident. Cannot exceed 255 characters.
    materialDescription String The description of the product. Cannot exceed 500 characters.
    companyLotNumber String The Owner company's lot number for the product. Cannot exceed 255 characters.
    partnerLotNumber String The Partner company's lot number for the product. Cannot exceed 255 characters.
    defectiveQuantity String The amount of product affected by the incident that is no longer saleable (e.g. 1,500). Cannot exceed 72 characters.
    defectiveUnitOfMeasure String

Conditionally required if the defectiveQuantity value is present. The unit of measure for the specified amount of defective product.

  • AMPOULE – The product is measured in ampoules.
  • BUNDLE – The product is measured in bundles.
  • BAG – The product is measured in bags.
  • BOTTLE – The product is measured in bottles.
  • BOX – The product is measured in boxes.
  • CARD_OR_BLISTER – The product is measured in cards or blisters.
  • CENTILITER – The product is measured in centiliters.
  • CAPSULE – The product is measured in capsules.
  • CASE – The product is measured in cases.
  • CUBIC_CENTIMETER – The product is measured in cubic centimeters.
  • CUBIC_FEET – The product is measured in cubic feet.
  • CUBIC_INCH – The product is measured in cubic inches.
  • CYLINDER – The product is measured in cylinders.
  • CENTIMETER – The product is measured in centimeters.
  • CAN – The product is measured in cans.
  • CRATE – The product is measured in crates.
  • CARTRIDGE – The product is measured in cartridges.
  • CUBIC_METER – The product is measured in cubic meters.
  • CARTON – The product is measured in cartons.
  • KILOMETER – The product is measured in kilometers.
  • DECILITER – The product is measured in deciliters.
  • DISPENSER – The product is measured in dispensers.
  • DECIMETER – The product is measured in decimeters.
  • DRUM – The product is measured in drums.
  • DISPLAY – The product is measured in displays.
  • DOZEN – The product is measured in dozens.
  • EACH – The product is measured in eaches.
  • FLUID_OUNCE_US – The product is measured in US fluid ounces.
  • GALLON_US – The product is measured in US gallons.
  • GRAM – The product is measured in grams.
  • GRAM_OR_LITER – The product is measured in grams or liters.
  • GROSS – The product is measured in grosses of product.
  • HECTOLITER – The product is measured in hectoliters.
  • KILOLITER – The product is measured in kiloliters.
  • KILOGRAM – The product is measured in kilograms.
  • KIT – The product is measured in kits.
  • POUND_US – The product is measured in US pounds.
  • LOT – The product is measured in lots.
  • LITER – The product is measured in liters.
  • METER – The product is measured in meters.
  • MICROGRAM – The product is measured in micrograms.
  • MICROLITER – The product is measured in microliters.
  • MILLIGRAM – The product is measured in milligrams.
  • MILLILITER – The product is measured in milliliters.
  • MILLIMETER – The product is measured in millimeters.
  • OUNCE – The product is measured in ounces.
  • PACK – The product is measured in packs.
  • PACKAGE – The product is measured in packages.
  • PAIR – The product is measured in pairs.
  • PALLET – The product is measured in pallets.
  • PIECE – The product is measured in pieces.
  • PINT – The product is measured in pints.
  • POUCH – The product is measured in pouches.
  • QUART – The product is measured in quarts.
  • ROLL – The product is measured in rolls.
  • SET – The product is measured in sets.
  • SHEET – The product is measured in sheets.
  • SQUARE_CENTIMETER – The product is measured in square centimeters.
  • SQUARE_FOOT – The product is measured in square feet.
  • SQUARE_INCH – The product is measured in square inches.
  • SQUARE_METER – The product is measured in square meters.
  • THOUSAND_PIECE – The product is measured in thousand pieces.
  • THOUSANDS – The product is measured in thousands.
  • TRAY – The product is measured in trays.
  • TUBE – The product is measured in tubes.
  • TABLET – The product is measured in tablets.
  • MILLION – The product is measured in millions.
  • UNIT – The product is measured in units.
  • VIAL – The product is measured in vials.
    defectiveItemInformation String The identifiers associated with the defective product that can no longer be used (e.g. container IDs, bag IDs, serial numbers). Cannot exceed 1000 characters.
    samplesAvailable Boolean

Indicates whether samples of the defective product are available. Valid values:

  • true – Yes, samples of the defective product are available.
  • false – No, samples of the defective product are not available.
  externalManufacturingResponse Object Contains information about the incident response from the Partner.
    initialResponseDueDate Number

The date and time (in Unix epoch time in milliseconds) that the initial response from the Partner is due to the Owner (e.g. 1622631600). 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 initialResponseRequiredWithinHours is 24 and the current date is 01 Jun 2021, the initialResponseDueDate is calculated as 02 Jun 2021.
    initialResponseInformation String The text of the initial response from the Partner. Cannot exceed 5000 characters.
    finalResponseDueDate Number

The date and time (in Unix epoch time in milliseconds) that the final response from the Partner is due to the Owner (e.g. 1623495600). 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 current date. For example, if the default finalResponseRequiredWithinHours is 288 and the current date is 01 Jun 2021, the finalResponseDueDate is calculated as 12 Jun 2021.
    finalResponseInformation String The text of the final response from the Partner. Cannot exceed 5000 characters.
    dateSamplesSentToCompany Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are sent to the Owner company.
    dateSamplesSentToPartner Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are sent to the Partner company.
    dateSamplesReceivedByCompany Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are received by the Owner company.
    dateSamplesReceivedByPartner Number The date and time (in Unix epoch time in milliseconds) that samples of the affected product are received by the Partner company.
    inventoryImpact String A description of the extent to which the impacted product is affected. Cannot exceed 5000 characters.
    inventoryAnalysisMethod String A description of the method used to determine the extent to which the impacted product is affected. Cannot exceed 5000 characters.
    initialContainmentActions String A description of the first steps to prevent the incident from affecting more product. Cannot exceed 5000 characters.
    recommendationFromOriginatingCompany String A description of what the company that the incident originated from suggests to prevent the issue from occurring again in the future. Cannot exceed 5000 characters.
    immediateCorrectiveActions String A description of the first corrective actions taken by the Partner to fix the issue that caused the incident to occur. Cannot exceed 5000 characters.
    potentialRootCauses String

The possible main issues that directly caused the incident 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.
  • OTHER – The root cause of the incident is user-defined. If this field is OTHER, use the otherPotentialRootCauses to define the potential root cause.
    otherPotentialRootCauses String

If the potentialRootCauses is OTHER, this is the user-defined possible main issue that directly caused the incident to occur.

To prevent corrupted data, the otherPotentialRootCauses should only be included in the request if the potentialRootCauses is OTHER.
    potentialRootCauseNotes String A description explaining how the potential root cause is determined (e.g. which potential root causes were considered) and what the root cause of the issue is believed to be. Cannot exceed 5000 characters.
    finalPreventativeActions String A description of the final corrective actions taken by the Partner to prevent the incident to occurring again after they have performed a root cause analysis. Cannot exceed 5000 characters.
    methodsToProvePreventativeActionsTaken String A description of the measures implemented to prove that the corrective actions have been successfully implemented (e.g. testing, audits). Cannot exceed 5000 characters.
    replacementMaterials Array The products that can replace the products affected by the incident.
      availabilityDateForReplacements Number The date that the substitute is available to replace the affected product.
      transactionIdsForReplacements Array The identifiers of transactions or shipments containing the replacement product.
        replacementsTransactionType Enum

The type of shipping document for the replacement delivery transaction. 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.
  externalManufacturingImpact Object Contains information about the incident's impact to the Owner company.
    businessImpact String A description how the Owner's business is impacted by the incident. Cannot exceed 5000 characters.
    businessPriority Enum

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.
    highPriorityReasons String

The one or more reasons that the incident is a high priority for the company. Valid values:

  • DISRUPTION_OR_CUSTOMER_BACKORDER – The incident disrupts the customer's ability to fill orders.
  • EXTENDED_TIME_TO_RESOLVE – The incident cannot be resolved in a timely manner.
  • FIELD_ACTION_REQUIRED – The incident requires additional action to be taken in the field.
  • TOP_PRODUCT_IMPACTED – The incident negatively affects an important product.
  • NEW_PRODUCT_LAUNCH_IMPACTED – The incident interferes with the launch of a new product.
  • MANUFACTURING_DISRUPTION – The incident disrupts manufacturing operations.
  • MANUFACTURING_DOWNTIME – The incident results in manufacturing downtime.
  • MARKET_SUPPLY_IMPACTED – The incident negatively impacts market supply.
  • MEDICALLY_SIGNIFICANT – The incident is medically significant.
  • PATIENT_SAFETY_IMPACTED – The incident negatively affects patient safety.
  • REVENUE_IMPACTED – The incident negatively affects revenue.
  • UNAVAILABLE_TO_CUSTOMERS – The incident results in product being unavailable to customers.
  • OTHER – The incident is a high priority for a user-defined reason. If this field is OTHER, use otherHighPriorityReasons to define the reason.
    otherHighPriorityReasons String If the highPriorityReasons is OTHER, this is the user-defined reason that the incident is a high priority for the company
To prevent corrupted data, the otherHighPriorityReasons should only be included in the request if highPriorityReasons is OTHER.
    financialImpact Number The monetary impact that the incident has on the Owner, entered as a numeric with decimals (e.g. 150000.00). Cannot exceed 255 characters.
    dateSupplyImpacted Number The date and time (in Unix epoch time in milliseconds) that the Owner's supply chain is affected by the incident.
    originatingLocationInvestigationDueDate Number The date and time (in Unix epoch time in milliseconds) that the Partner company's investigation of the location where the incident occurred is due to the Owner.

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 originatingSiteInvestigationRequiredWithinHours is 48 and the current date is 01 Jun 2021, the originatingLocationInvestigationDueDate is calculated as 03 Jun 2021.
    dateResourcesDeployed Number The date and time (in Unix epoch time in milliseconds) that resources, such as people or money, are deployed to start managing the incident.
    dateEscalationReportRequested Number For escalated incidents (isEscalated = true), the date the escalation report for the incident is requested by.
  submitInitialResponse Boolean

Indicates whether to submit the initial response for the incident. The response text is provided in the initialResponseInformation. Valid values:

  • true – Submit the initialResponseInformation value as the initial response. TraceLink automatically captures the current time as the date the initial response is submitted.
  • false – Do not submit the initial response.
  submitFinalResponse Boolean

Indicates whether to submit the final response for the incident. The response text is provided in the finalResponseInformation. Valid values:

  • true – Submit the finalResponseInformation value as the final response. TraceLink automatically captures the current time as the date the final response is submitted.
  • false – Do not submit the final response.
  impactedProducts String Identifiers for the one or more products that are affected by the incident.
  impactedLocations Array One or more internal or external locations that are impacted by the incident.
    locationId String The identifier of the internal or external location that is impacted by the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
    locationType Enum

Indicates whether the impacted location is internal or external.

Valid values:

  • Internal – The impacted location is an internal location.
  • External – The impacted location is an external location.
    locationContact String The user that is the regulatory contact for the location.
  potentiallyImpactedLocations Array One or more internal or external locations that could be impacted by the incident.
    locationId String The identifier of the internal or external location that is potentially impacted by the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
    locationType Enum

Indicates whether the potentially impacted location is internal or external.

Valid values:

  • Internal – The potentially impacted location is an internal location.
  • External – The potentially impacted location is an external location.
    locationContact String The user that is the regulatory contact for the location.
  aptEscalationReportBox Object For escalated incidents (isEscalated = true), contains the escalation report.
    addAttachment Array The file to attach to the incident as the escalation report. 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.
  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.
  newBaseState String

Transitions the base workflow state of the incident from ToDo to UnderInvestigation. This cannot be reversed; incidents in the Under Investigation state can only be transitioned to Closed. The following must be true to update the incident state:

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

Valid value is UnderInvestigation.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-external-manufacturing-incident:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "fd04dd70-c162-43ef-8118-539ca01de471",
        "newBaseState": "UnderInvestigation"
    }
}
Copy 
{
   "header":{
      "headerVersion":1,
      "eventName":"agile-process-teams:edit-external-manufacturing-incident:v5",
      "ownerId":"94f94f37-2772-4b39-8041-9c2dcfcfff82",
      "processNetworkId":"945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
      "appName":"agile-process-teams",
      "dataspace":"default"
   },
   "payload":{
      "id":"fd04dd70-c162-43ef-8118-539ca01de471",
      "partnerCompany":{
         "partnerId":"be9c8cea-72bc-459c-97b9-ef3f7c73ccc8",
         "toIdType":"companyMasterData"
      },
      "partnerLocationId":"bb75c388-16f7-4a18-9c77",
      "responsiblePartyAtPartner":"a67d7261-33b1-4be6-9760-61ae8fe9eed3",
      "currentlyAssignedPartnerUsers":[
         "a67d7261-33b1-4be6-9760-61ae8fe9eed6"
      ],
      "directSupplierImpact":{
         "businessImpact":"Business Impact",
         "businessPriority":"HIGH",
         "impactedDepartments":[
            "CUSTOMER_SERVICE"
         ],
         "highPriorityReasons":[
            "Reason1"
         ],
         "financialImpact":164113394500,
         "dateSupplyImpacted":1641133945000,
         "originatingLocationInvestigationDueDate":1641133945000,
         "dateResourcesDeployed":1641133945000,
         "dateEscalationReportRequested":1641133945000
      },
      "impactedProducts":[
         "613ac6ab-2940-45c4-b214-ea84feb4e931"
      ],
      "potentiallyImpactedProducts":[
         "fc58cbf8-1098-4f66-bf37-763922bd36b3",
         "613ac6ab-2940-45c4-b214-ea84feb4e931"
      ],
      "impactedLocations":{
         "locationId":"524b43f0-0bdb-4221-84d8-fec090151b0a",
         "toIdType":"companyLocationMasterData",
         "locationType":"INTERNAL",
         "locationContact":"edavis"
      },
      "potentiallyImpactedLocations":[
         {
            "locationId":"524b43f0-0bdb-4221-84d8-fec090151b0a",
            "toIdType":"companyLocationMasterData",
            "locationType":"INTERNAL",
            "locationContact":"edavis"
         }
      ],
      "referenceIdentifiers":[
         {
            "referenceTransactionType":"BILL OF LADING",
            "value":"FZ-1896155146"
         }
      ],
      "aptCommentBox":{
         "aptComment":{
            "commentText":"Re-assigning to Jen",
            "visibilityType":"Internal"
         }
      }
   }
}
Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-external-manufacturing-incident:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "fd04dd70-c162-43ef-8118-539ca01de471",
        "externalManufacturingResponse": {
            "initialResponseInformation": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam vehicula vitae metus non facilisis."
        }, 
        "submitInitialResponse": true
    }
}
Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-external-manufacturing-incident:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "fd04dd70-c162-43ef-8118-539ca01de471",
        "externalManufacturingResponse": {
            "finalResponseInformation": "Lorem ipsum dolor sit amet. Nam vehicula vitae metus non facilisis."
        }, 
        "submitFinalResponse": 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:edit-external-manufacturing-incident-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

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

The exception thrown based on the error code.

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

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-external-manufacturing-incident-response:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "qL0BJs"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a"
    }
}

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.
authorization User does not have permission to edit incidents that are in a Closed state. The error occurs if the user does not have the Edit a Closed Incident permission.
processNetworkId Process Network Id is required. The error occurs if the source is empty or null.
id Process ID is required. The error occurs if the source is empty or null.
initialResponseDueDate Invalid Initial Response 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.
finalResponseDueDate Invalid Final Response 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.
initialResponseDueDate Partner users are not permitted to set the Initial Response Due Date.

The error occurs if the source is not blank and the user making the request is a process team member from the Partner company.
finalResponseDueDate Partner users are not permitted to set the Final Response Due Date.

The error occurs if the source is not blank and the user making the request is a process team member from the Partner company.
resolutionDueDate Partner users are not permitted to set Resolution Due Date when the incident has been added by the partner.

The error occurs if the source is not blank and the user making the request is a process team member from the Partner company.
initialResponseInformation Initial Response is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
finalResponseInformation Final Response is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
submitInitialResponse Submit Initial Response value must be True or False. The error occurs if the source does not equal true or false.
submitInitialResponse User does not have permission to submit the initial response.

The error occurs if the user does not have the Submit Initial Response permission.
submitFinalResponse Submit Final Response value must be True or False. The error occurs if the source does not equal true or false.
submitFinalResponse User does not have permission to submit the final response. The error occurs if the user does not have the Submit Final Response permission.
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.
responsibleDepartmentAtCompany Invalid Responsible Department at [Owning Company], must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
responsibleDepartmentAtPartner Invalid Responsible Department at Partner Company, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
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 not a valid value from the enumeration list.
aptBusinessObjectDescription Incident Description is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
partnerId Partner is not a valid network node. The error occurs if the source is not a valid linked Partner company.
partnerId Partner cannot be updated once the incident has been submitted to the partner. The error occurs if the incident is already submitted to the specified Partner and the source is modified.
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.
initialResponseDueDate Invalid Initial Response 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.
finalResponseDueDate Invalid Final Response 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.
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.
isSubmittedToPartner Submit to Partner value must be True or False. The error occurs if the source does not equal true or false.
isSubmittedToPartner User does not have permission to submit the incident to the partner.

The error occurs if the user does not have the Submit Initial Response permission.
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 Owner's network.
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.
deviationType Invalid Deviation Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
materialType Invalid Material Type, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
materialSubtype Invalid Material Subtype, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
materialProblem Invalid Material Problem, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
replacementsTransactionType 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.
impactedDepartments Invalid Impacted Department, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
highPriorityReasons Invalid High Priority Reason, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
aptEscalationReportBox | addAttachment | visibilityType Attachment visibility type must be Public or Internal. The error occurs if the source does not equal Public or Internal.
owningCompanyInternalMaterialNumber Internal Material Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
partnerCompanyInternalMaterialNumber Internal Material Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
materialName Material Name is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
materialDescription Material Description is greater than max length. The error occurs if the source exceeds the maximum length of 500 characters.
owningCompanyLotNumber Lot Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
partnerCompanyLotNumber Lot Number is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
defectiveQuantity Defective Quantity is greater than max length.

The error occurs if the source exceeds the maximum length of 72 characters.
defectiveItemIds Defective Item IDs is greater than max length.

The error occurs if the source exceeds the maximum length of 1000 characters.
inventoryImpact Inventory Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
inventoryAnalysisMethod Inventory Analysis Method is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
initialContainmentActions Initial Containment Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
recommendationFromOriginatingCompany Recommendation From Originating Company is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
immediateCorrectiveActions Immediate Corrective Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
potentialRootCauses Potential Root Causes is greater than max length. The error occurs if the source is not a valid value from the enumeration list.
potentialRootCauseNotes Potential Root Cause Notes is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
finalPreventativeActions Final Preventative Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
methodsToProvePreventativeActionsTaken Method To Prove Preventative Actions is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
businessImpact Business Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 500 characters.
financialImpact Financial Impact is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
financialImpact Financial Impact contains invalid characters. The error occurs if the source is not numeric with decimal.
newBaseState Invalid Base State, only 'UnderInvestigation' is valid. The error occurs if the source does not equal UnderInvestigation.
newBaseState Responsible Party at [Owning Company] must be assigned in order to move the Incident to Under Investigation.

The error occurs if the source equals UnderInvestigation and responsiblePartyAtOwner is blank 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.

Copy External Manufacturing Incident

Owners and Partners use this API to copy an existing external manufacturing incident to the network. Boolean fields determine which section values to copy from the original to the new incident (e.g. copy all values from the General section but not the Reference IDs section of the original 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-external-manufacturing-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 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.
  copyGeneralInfo Boolean

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

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

Required. Indicates whether to copy the Partner section values from the original incident to the new incident.

Valid values:
  • true - Yes, copy all Partner section values to the new incident.
  • false - No, do not copy the Partner section values to the new incident.
  copyMaterialInfo Boolean

Required. Indicates whether to copy the Material section values from the original incident to the new incident.

Valid values:
  • true - Yes, copy all Material section values to the new incident.
  • false - No, do not copy the Material section values to the new incident.
  copyImpactInfo Boolean

Required. Indicates whether to copy the Impact section values from the original incident to the new incident.

Valid values:
  • true - Yes, copy all Impact section values to the new incident.
  • false - No, do not copy the Impact section values to the new incident.
  copyReferenceIds Boolean

Required. Indicates whether all Reference ID values are copied from the original incident to the new incident.

Valid values:
  • true - Yes, copy all Reference ID values to the new incident.
  • false - No, do not copy the Reference ID values to the new incident.
  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-external-manufacturing-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",
        "createdByPartner": false,
        "aptBusinessObjectSummary": "Tracking replacement order",
        "copyGeneralInfo": true,
        "copyPartnerInfo": true,
        "copyMaterialInfo": true,
        "copyImpactInfo": false,
        "copyReferenceIds": true,
        "copyRelatedProcesses": false
    }
}

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-external-manufacturing-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.
  id String Required. The identifier for the new incident.  

Example

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

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.
aptBusinessObjectSummary Summary is required. The error occurs is the source is empty or null.
copyGeneralInfo Copy General Information value must be True or False. The error occurs if the source does not equal true or false.
copyPartnerInfo Copy Partner Information value must be True or False. The error occurs if the source does not equal true or false.
copyMaterialInfo Copy Material Information value must be True or False. The error occurs if the source does not equal true or false.
copyImpactInfo Copy Impact Information value must be True or False. The error occurs if the source does not equal true or false.
copyReferenceIds Copy Reference Identifiers value must be True or False. The error occurs if the source does not equal true or false.
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 External Manufacturing Incident

Owners and Partners use this API to close an existing external manufacturing 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.

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-external-manufacturing-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 close.
  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.
 

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.
  finalRootCause String

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.
  • OTHER – The root cause of the incident is user-defined. If this field is OTHER, use otherFinalRootCause to define the final root cause.
  otherFinalRootCause String

If finalRootCause is OTHER, this is the user-defined issue that directly caused the issue to occur.

To prevent corrupted data, otherFinalRootCause should only be included in the request if finalRootCause is OTHER.
  impactedLocations Array One or more internal or external locations that are impacted by the incident.
    locationId String The identifier of the internal or external location that is impacted by the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
    locationType Enum

Indicates whether the impacted location is internal or external.

Valid values:

  • Internal – The impacted location is an internal location.
  • External – The impacted location is an external location.
    locationContact String The user that is the regulatory contact for the location.
  originatingLocation Array The identifier number and type of the originating location of the incident.
    originatingLocationId String The identifier of the internal or external location that caused the incident. The location must exist in Master Data.
    toIdType Enum

The location identifier type.

Valid values:

  • companyLocationMasterData
  • partnerLocationMasterData
  closingStatement String Any final closing statement about the incident and its closure. Cannot exceed 5000 characters.
  aptCommentBox Object Required. Additional information to include in the closure of the incident.
    aptComment Array Required. The final comment to provide as the closing statement for the incident.
      commentText String Required. The closing statement text. 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:close-external-manufacturing-incident:v3",
        "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",
        "resolutionType": "RESOLVED",
        "originatingLocation": {
            "originatingLocationId": "8b99b7d8-d65b-4333-92fd-9d551ff2c07e",
            "toIdType": "companyLocationMasterData"
        },
        "aptCommentBox":{
            "aptComment":{
                "commentText": "Order received. Signed off by Receiving Manager on 23 Aug 2021",
                "visibilityType": "Public"
               },
            "addAttachment":[
                {
                    "fileName" : "ORDER_1896155146_approved_RECEIVED 23-AUG",
                    "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:close-external-manufacturing-incident-response:v3.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

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

The exception thrown based on the error code.

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

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-external-manufacturing-incident-response:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "message": "Incident closed 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.
aptComment Closing Statement is required. The error occurs if the source is empty or null.
aptComment Closing Statement is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
aptComment Closing Statement 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.

Reopen External Manufacturing Incident

Owners and Partners use this API to reopen a closed external manufacturing 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-external-manufacturing-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-external-manufacturing-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",
        "aptCommentBox": {
            "aptComment": {
                "commentText": "INC-4098 closed prematurely - reopening to finalize record.",
                "visibilityType": "Internal"
            }
        }
    }
}

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-external-manufacturing-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.
  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-external-manufacturing-incident-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "2rw4zz"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "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 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.
adAttachment 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.

Submit External Manufacturing Incident to Partner

Owners use API to submit an existing external manufacturing 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-external-manufacturing-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-external-manufacturing-incident-to-partner:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "d04d3b43-64e5-41d2-87b6-a3b42241b176"
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:submit-external-manufacturing-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.
  id String Required. The identifier for the incident submitted to the associated Partner company.
  message String Required. The message indicating the incident is submitted to the Partner.

Example

Copy 
{
    "header" : {
        "headerVersion" : 1,
        "eventName" : "agile-process-teams:submit-external-manufacturing-incident-to-partner-response:v1",
        "ownerId" : "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr" : false,
        "errCode" : "200_OK",
        "licensePlate" : "ofGzDO"
    },
    "payload" : {
        "id": "d04d3b43-64e5-41d2-87b6-a3b42241b176",
        "message": "Incident successfully 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.
partnerId Partner is not a valid network node. The error occurs if the source does not exist on the Owner company's 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.