This Help Center is a preview of a future release.

Compliance exception incident APIs

Companies that own or link to Agile Process Teams use these APIs to add, update, and resolve supply chain compliance exception incidents on the Owner's network. For example, a Dispenser in the US might receive a shipment of product with the tamper-proof foil seals broken and need to communicate to their supply chain partners that the product may be illegitimate. Partners must be a member of the Owner company's network to collaborate with the Owner on a compliance exception incident.

Add Compliance Exception

Owners and Partners use this API to add a new compliance exception 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.

For Partners adding a compliance exception to an Owner's network, the compliance exception is automatically submitted to the accountableEntity. Partners cannot add a new compliance exception without submitting it to the accountableEntity.

Add Compliance Exception request

Guidelines

Element				Type	Description
header				–	Required. The request header.
	headerVersion			Integer	Required. The version identifier for the request. Valid value is `1`.
	eventName			String	Required. The fully qualified name of the request event. Valid value is `agile-process-teams:add-compliance-exception:v3`.
	ownerId			String	Required. The identifier for the company associated with the request.
	appName			String	Required. The application that owns the event. Valid value is `agile-process-teams`.
	processNetworkId			String	Required. The network that contains the incident process. This must be a valid network at the Owner company.
	dataspace			String	Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is `default`.
payload				–	Required. The request body.
	aptBusinessObjectSummary			String	Required. A brief summary of the incident. Cannot exceed 255 characters.
	aptBusinessObjectDescription			String	A detailed description of the incident. Provides additional context for the incident. Cannot exceed 5000 characters.
	businessPriority			Enum	Required. The urgency with which the incident needs to be resolved. Valid values: `LOW` - The incident has low business priority. `MEDIUM` – The incident has medium business priority. `HIGH` – The incident has high business priority. `CRITICAL` – The incident is critical.
	resolutionDueDate			Number	The date and time that the incident must be resolved. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
	currentlyAssignedUsersReporterCompany			Array	List of email addresses for the one or more users at the company reporting the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	responsibleUserReporterCompany			String	The email address of the user from the company that reported the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	reporterCompany			String	The company, company location, Partner company, or Partner company location that owns that reported the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user). The company, company location, Partner company, or Partner company location entered must exist in Master Data.
		masterDataEntityIdentifier		String	The identifier type and value pairing for the company, company location, Partner company, or Partner company location that reported the incident.
			masterDataEntityIdentifierType	String	The type of identifier associated with the reporter company (e.g. GLN).
			masterDataEntityIdentifierValue	String	The value of the identifier entered for masterDataEntityIdentifierType.
	incidentCategory			String	The main problem that caused the incident. Valid values `DATA_ISSUES` – The product's data is incomplete or incorrect. `DAMAGED_PRODUCT` – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage. `PRODUCT_BUT_NO_DATA` – The product was received without the required supporting product details (e.g. lot number information). `DATA_BUT_NO_PRODUCT` – A product's details were received without also receiving the physical product. `PACKAGING` – The product's packaging is inadequate or contains incorrect information, such as dosage or usage information. `PRODUCT_HOLD` – The product's shipment was delayed or suspended due to quality concerns, safety issues, regulatory compliance, or other reasons. `SUSPECT_PRODUCT` – The product is believed to be potentially counterfeit, diverted, stolen, intentionally adulterated, the subject of a fraudulent transaction, or appears otherwise unfit for distribution. `MISALIGNMENT` – There is a discrepancy between supply chain partners about the product (e.g. product specifications). `TRACING/VERIFICATION` – The product's history cannot be properly traced or verified. `OTHER` – The incident is caused by a user-defined problem. If this element is `OTHER`, use the otherIncidentCategory element to define the incident type.
	otherIncidentCategory			String	If the incidentCategory is `OTHER`, this is the user-defined incident category associated with the incident. To prevent corrupted data, the otherIncidentCategory should only be included in the request if the incidentCategory is `OTHER`.
	incidentSubcategory			String	The subcategory of the selected incident category associated with the incident. Valid values depend on the incidentCategory selected, as follows: If the incidentCategory is `DATA_ISSUES`: `NON-MATCHING_GLN` – The GLN in the SOR (System of Record) does not match the GLN for the delivery. `GTIN_NOT_FOUND` – A GTIN in the delivery cannot be found in the SOR. `INCORRECTLY_FORMATED_EPCIS` – The delivery's EPCIS message is not formatted correctly. `DATA_RECEIVED/BARCODE_DATA_MISALIGNMENT` – The delivery's data is present in the SOR, but it does not match the data retrieved from the delivery's physical barcode. `004-QUARANTINE_PRODUCT/NO_TL_TI_DATA` – The product in the delivery is in quarantine because the delivery’s transaction information is not present. `005-QUARANTINE_PRODUCT/DELIVERY_NUMBER/BARCODE_MISMATCH` – The product in the delivery is in quarantine because the delivery number or barcode does not match the information in the SOR. `006-QUARANTINE_PRODUCT/PRODUCT_NUMBER_AND_BARCODE_MISMATCH` – The product in the delivery is in quarantine because a product number or barcode in the delivery does not match the information in the SOR. `007-QUARANTINE_PRODUCT/MISALIGNMENT_EXCEPTION_AMENDED` – The product in the delivery is in quarantine because a misalignment occured. If the incidentCategory is `DAMAGED_PRODUCT`: `DAMAGED_CASE_OR_CASE_LABEL` – The case or the case label for the product is damaged. `DAMAGED_EACH` – An each-level container for the product is damaged. `001-QUARANTINE_PRODUCT/DAMAGED_BARCODE` – The product in the delivery is in quarantine because the barcode is damaged. `002-QUARANTINE_PRODUCT/NO_BARCODE` – The product in the delivery is in quarantine because a product in the delivery does not have a barcode. `003-QUARANTINE_PRODUCT/BARCODE_MISSING_TI_DATA` – The product in the delivery is in quarantine because the delivery’s transaction information is not present. If the incidentCategory is `PRODUCT_BUT_NO_DATA`: `EPICS_SENT_BUT_NOT_RECEIVED` – The EPCIS message for the delivery was not received with the physical product. `PRODUCT_RECEIVED_BUT_SERIAL_NUMBER_NOT_FOUND/NO_PO_OR_DELIVERY_NUMBER` – The product is received but its serial number was not found or there is no PO number or delivery number for the product in the SOR. `PRODUCT_RECEIVED_BUT_SERIAL_NUMBER_NOT_FOUND/PO_EXISTS` – The product is received with an existing purchase order but its serial number was not found in the SOR. `PRODUCT_OVERAGE_WITH_VALID_PO` – The product has a valid purchase order but there is more product in the delivery than is present in the SOR. `DELIVERY_TO_RIGHT_COMPANY_BUT_WRONG_DC` – The product is delivered to the right company but to the wrong distribution center. `DELIVERY_TO_WRONG_COMPANY` – The product is delivered to the wrong company. `SERIAL_NUMBER_NOT_FOUND_DUE_TO_AGGRIGATION_OR_OVERAGE_DURING_PICK_PACK_SHIP` – The product is received but its serial number was not found in the SOR due to an overage or aggregation error that occurred in the pick, package, and ship process. If the incidentCategory is `DATA_BUT_NO_PRODUCT`: `DATA_SENT_BUT_PRODUCT_NOT_RECEIVED` – A product’s data is received but the product is not received in the associated delivery, possibly due to a product shortage. `DATA_RECEIVED_THEN_SHIPMENT_QUANTITY_CHANGED_OR_CANCELED` – A product’s data is received but either the product is not received or the quantity of product received is incorrect. `DATA_RECEIVED_BUT_SHIPMENT_REFUSED_OR_UNDELIVERABLE` – A product’s data is received but the product is not received because the delivery was refused or was undeliverable. `DATA_RECEIVED_SHIPMENT_LOST_OR_STOLEN` – A product’s data is received but the product is not received because the delivery was lost or stolen. If the incidentCategory is `PACKAGING`: `SCAN_ON_RECEIPT_PRODUCT/DATA_MISMATCH_DUE_TO_BATCH_LABELING_ISSUE` – When the product is scanned on delivery, the information retrieved from the product label does not match the physical product. `NO_HIERARCHY_OF_SERIAL_NUMBERS_ON_LABEL_UPON_RECEIPT` – The product is received without a hierarchy of serial numbers on the label. `SERIALIZED_SHIPPING_CONTAINER_CODE_DAMAGED_OR_UNUSABLE` – The product's SSCC is damaged or unusable. `2D_BARCODE_WILL_NOT_SCAN_OR_IS_ENCODED_INCORRECTLY_OR_HAS_INCOMPLETE_ELEMENTS` – The product's 2D barcode will not scan, is encoded incorrectly, or has incomplete elements. `NO_HIERARCHY_OF_SERIAL_NUMBERS_AT_PICK/PACK/SHIP` – The product's hierarchy of serial numbers was not included on the label during the pick, package, and ship process. If the incidentCategory is `PRODUCT_HOLD`: `EPCIS_EVENTS_OUT_OF_ORDER_OR_DO_NOT_MATCH_PRODUCT_STATUS` – The product is on hold because the events in the delivery's EPICS message are listed out of sequence or do not match the product’s current status. `SERIAL_NUMBER_IN_HOLD_STATUS_DURING_PICK/PACK/SHIP_DUE_TO_RECALL_OR_SUSPECT_OR_ILLEGITIMATE_PRODUCT` – The product's serial number is updated to on hold during the pick, package, and ship process because the product is listed as recalled, suspect, or illegitimate. `DELAYED_SHIPMENT` – The product is on hold because its delivery is delayed. If the incidentCategory is `SUSPECT_PRODUCT`: `INITIAL_NOTIFICATION` – The product is being reported as suspect for the first time. `FOLLOW_UP_NOTIFICATION` – The product is being reported as suspect for at least the second time. `REQUEST_FOR_TERMINATION` – The product is suspect and should be terminated. If the incidentCategory is `OTHER`: `OTHER` – The incident is associated with a user-defined incident category. If this field is `OTHER`, use the otherIncidentSubcategory to define the subtype.
	otherIncidentSubcategory			String	If the incidentSubcategory is `OTHER`, this is the user-defined incident subcategory associated with the incident. To prevent corrupted data, the otherIncidentSubcategory should only be included in the request if the incidentSubcategory is `OTHER`.
	accountableEntity			Array	The identifier for the company, company location, Partner company, or Partner company location that owns the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user). The company, company location, Partner company, or Partner company location entered must exist in Master Data.
		masterDataEntityIdentifier		String	The identifier type and value pairing for the company, company location, Partner company, or Partner company location that owns the incident and is responsible for the incident's resolution.
			masterDataEntityIdentifierType	String	The type of identifier associated with the accountable entity (e.g. GLN).
			masterDataEntityIdentifierValue	String	The value of the identifier entered for masterDataEntityIdentifierType.
	responsibleUserAccountableEntity			String	The email address of the user from the company that is accountable for the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	currentlyAssignedUsersAccountableEntity			Array	List of email addresses for the one or more users at the company that is accountable for the incident and is responsible for taking action to resolve the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	responsibleDepartmentAtCompany			String	The business area of the 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`. Valid values `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. `CORAM` – The user responsible for resolving the incident is part of the Coram 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. `DISTRIBUTION_CENTERS` – The user responsible for resolving the incident is part of the Distribution Centers 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. `MINUTE_CLINIC` – The user responsible for resolving the incident is part of the Minute Clinic team. `OMNICARE` – The user responsible for resolving the incident is part of the Omnicare 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. `PBM_MAIL_ORDER` – The user responsible for resolving the incident is part of the PBM Mail Order team. `PBM_SPECIALTY_MAIL` – The user responsible for resolving the incident is part of the PBM Specialty Mail 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. `RETAIL` – The user responsible for resolving the incident is part of the Retail team. `SALES_OR_MARKETING` – The user responsible for resolving the incident is part of a Sales team or Marketing team. `SPECIALTY_PHARMACY_OR_CAREPLUS` – The user responsible for resolving the incident is part of the Specialty Pharmacy or CarePlus team. `SPECIALTY_WHOLESALE` – The user responsible for resolving the incident is part of the Specialty Wholesale team. `SUPPLY_CHAIN` – The user responsible for resolving the incident is part of a Supply Chain team. `VANGAURD` – The user responsible for resolving the incident is part of the Vanguard team.
	associatedEntities			Object	List of identifiers for the supply chain entities associated with the incident throughout the supply chain.
		shippedFromBusiness		Object	The location that the product associated with the incident was initially shipped from.
			entityIdentifierValue	String	The value of the identifier for the location that the product associated with the incident was initially shipped from.
			entityIdentifierType	String	The identifier type for the location that the product associated with the incident was initially shipped from.
		fromBusiness		Object	The company that the product associated with the incident was ordered from.
			entityIdentifierValue	String	The value of the identifier for the company that the product associated with the incident was ordered from.
			entityIdentifierType	String	The identifier type for the company that the product associated with the incident was ordered from.
		shippedToBusiness		Object	The location that the product associated with the incident was shipped to.
			entityIdentifierValue	String	The value of the identifier for the location that the product associated with the incident was shipped to.
			entityIdentifierType	String	The identifier type for the location that the product associated with the incident was shipped to.
		toBusiness		Object	The company that the product associated with the incident was ordered by.
			entityIdentifierValue	String	The value of the identifier for the company that the product associated with the incident was ordered by.
			entityIdentifierType	String	The identifier type for the company that the product associated with the incident was ordered by.
		notes		String	General notes or comments about the entities associated with the incident.
	issueDetail			Array	The product and transaction details associated with the incident.
		referenceTransactions		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 associated with the incident. 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. `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 5000 characters.
		productIdentifier		Array	The identifier for the product affected by the compliance exception. The product must exist in Master Data.
			productIdentifierType	String	The type of identifier for the product used by the relevant regulatory agency (i.e. NDC or GTIN).
			productIdentifierValue	String	The value of the identifier entered for productIdentifierType.
		issueProductDetails		String	Any additional details about the product impacted by the incident.
		scanDate		Date	The date and time that the physical product was scanned in as received by the entity at its current location. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
		quantity		Array	The state and amount of each product associated with the incident.
			quantityType	String	The state of the product in relation to its Purchase Order status. Valid values: `ORDER` `ITEM` `NET` `GROSS` `PRICING_UNIT` `COMMITTED` `DAMAGED` `DELIVERED` `DELIVERY` `HOLD` `IN_TRANSIT` `INVOICE` `LADING` `MINIMUM_TO_MAKE_ORDER` `MINIMUM_DELIVERY` `MINIMUM_ORDER` `ON_HAND` `ON_HOLD` `ON_ORDER` `OUTSTANDING` `OVER` `PACKAGED` `PURCHASE_ORDER` `QUESTIONED` `RECEIVED` `REJECTED` `RETURNED` `SCRAP` `SHIPPED_TO_DATE` `SHORT` `STOCK_KEEPING` `UNUSABLE`
			quantityValue	String	The amount of product affected by the incident (e.g. 1,500). Cannot exceed 12 characters.
			quantityUnitOfMeasurement	String	The unit of measure for the specified amount of impacted product. Valid values `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.
		productCodeInformation		Array	The company that the product associated with the incident was initially shipped from.
			serialNumber	String	The serial number impacted by the incident.
			lotNumber	String	The lot number associated with the serial number.
			expirationDate	String	The date that all serial numbers in the lot expire. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
		additionalInformation		Object	Additional information about the product's makeup and use. This element should only be entered if the incidentCategory is `SUSPECT_PRODUCT`.
			drugComposition	String	The product's primary ingredients.
			drugUse	String	The intended type of end user for the drug. Valid values: `HUMAN` – The product is intended to be consumed by humans. `OTHER` - The product is not intended to be consumed humans.
			drugDescription	String	The classification of the drug. Valid values: `Finished Prescription Drug` – The drug is classified as a finished prescription drug. `Vaccine` – The drug is classified as a vaccine. `Plasma Derivative (coagulation factors, immunoglobulins, albumin)` – The drug is classified as a plasma derivative. `Allergenic (standardized and non standardized)` – The drug is classified as an allergenic. `Multiple` – The drug is classified in more than one way.
			eventIssueDescription	String	The reason that the product was labeled as suspect. Cannot exceed 5000 characters. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in the description
			requestForNotificationTermination	String	The reason that the previous compliance exception notification submitted to a regulatory agency is void and is being withdrawn. Cannot exceed 5000 characters. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in addition to the reason why the previous compliance exception is being withdrawn.
			submittedThroughAlternateMechanism	String	Conditionally required if requestForNotificationTermination is present. The method used if the incident was previously submitted to the regulatory agency. Valid values: `BPDR-BIOLOGICAL_PRODUCT_DEVIATION_REPORT` – A drug notification was previously submitted to the FDA for this product using a BDPR (Biological Product Deviation Report). `FAR-FIELD_ALTER_REPORT` – A drug notification was previously submitted to the FDA for this product using a FAR (Field Alert Report). `MEDWATCH_3500` – A drug notification was previously submitted to the FDA for this product using the Medwatch 3500 form. `MEDWATCH_3500A` – A drug notification was previously submitted to the FDA for this product using the Medwatch 3500 form. `OTHER` – A drug notification was previously submitted to the FDA for this product using a method not listed here. `NONE` – Indicates was not previously submitted to the FDA for this product. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in the requestForNotificationTermination.
			otherSubmittedThroughAlternateMechanism	String	Conditionally required if submittedThroughAlternateMechanism is `OTHER`. The alternative method used to initially submit the notification to a regulatory agency.
			incidentNumber	String	Conditionally required if requestForNotificationTermination is present. The incident number that has been provided by the regulatory agency for the incident.
			initialNotificationDateToFDA	String	The date that the FDA was initially notified of the incident. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
			dateProductIdentifiedAsIllegitimate	String	The date that the product was identified as illegitimate. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
			notificationClassification	String	The reason the product was identified as illegitimate. Valid values: `COUNTERFEIT` – The product is determined to be counterfeit or has a high risk of being counterfeit. `DIVERTED` – The product is determined to be a diverted product or has a high risk of being a diverted product. `STOLEN` – The product is determined to be a stolen product or has a high risk of being a stolen product. `INTENTIONAL ADULTERATION` – The product is determined to be intentionally adulterated such that use of the product has a high risk of resulting in serious adverse health consequences or death to humans. `UNFIT FOR DISTRIBUTION` – The product appears unfit for distribution such that use of the product has a high risk resulting in serious adverse health consequences or death to humans. `FRAUDULENT TRANSACTION` – The product is determined to be or has a high risk of being the subject of a fraudulent transaction.
			businessType	String	The business role of the company that identified the product as suspect. Valid values: `DISPENSER` – The company responsible for dispensing the product identified it as suspect. `MANUFACTURER` – The company responsible for producing the product identified it as suspect. `REPACKAGER` – The company responsible for repackaging the product identified it as suspect. `WHOLESALE DISTRIBUTOR` – The company responsible for distributing the product identified it as suspect. This element maps to Company Category for FDA Drug Notifications.
	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. Valid values: `incident` `change` `directSupplierIncident` `externalManufacturingIncident` `documentReview` `task` `complianceException`
		relationshipType		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			Array	Contains any comments or files to attach to the incident.
		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	String	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.
		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	String	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.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-compliance-exception:v3",
        "ownerId": "d25ab887-247f-4147-b8f1-36ff70ccd594",
        "processNetworkId": "{{comp1Pni}}",
        "appName": "2154f852-02eb-4725-b521-047df60bbbff",
        "dataspace": "default"
    },
    "payload": {
        "aptBusinessObjectSummary": "Kendall Pharma | ACME Inc | INC-2023-01 | No EPCIS Data for 1 package",
        "aptBusinessObjectDescription": "Shipment quarantined due to T1 reflecting incomplete data|SO 3027209239|PO 5201019344|Transaminase enzyme, CDX-017 (ACS-4007466). EPCIS shows 48 pallets and receiving called out 50 received ",
        "businessPriority": "HIGH",
        "createdByPartner": false,
        "resolutionDueDateISO": "2023-04-15T01:30:00.000-05:00",
        "currentlyAssignedUsersReporterCompany": {
            "userEmails":[
                "johndoe@tracelink.com",
                "janedoe@tracelink.com"
            ]
        },
        "responsibleUserReporterCompany":{
            "userEmail":"johndoe@tracelink.com"
        },
        "currentlyAssignedUsersAccountableEntity": {
            "userEmails":[
                "jasondoe@tracelink.com",
                "jananiedoe@tracelink.com"
            ]
        },
        "responsibleUserAccountableEntity":{
            "userEmail":"jasondoe@tracelink.com"
        },
        "incidentCategory": "Product, No Data",
        "incidentSubCategory": "Product Overage with valid PO",
        "accountableEntity":{
            "masterDataEntityIdentifier":{
                "masterDataEntityIdentifierType": "GLN",
                "masterDataEntityIdentifierValue": "9263497412690"
            }
        },
        "reporterCompany": {
            "masterDataEntityIdentifier":{
                "masterDataEntityIdentifierType": "GLN",
                "masterDataEntityIdentifierValue": "9263497412690"
            }
        },
        "issueDetail": [
            {
                "productIdentifier":{
                  "productIdentifierType": "NDC",
                  "productIdentifierValue": "9263497410"
                },
                "issueProductDetails": {
                    "quantityDetails": [
                        {
                            "quantityType": "ORDER",
                            "quantityValue": "100",
                            "quantityUnitOfMeasure": "Pallet"
                        }
                    ],
                    "productDetailInformation": [
                        {
                            "lotNumber": "123123",
                            "expirationDateISO": "2023-04-15T01:30:00.000-05:00",
                        }
                    ],
                    "impactedSerialNumber":"1234567895,12346734534,123124555",
                    "referenceTransactions": [
                        {
                            "referenceTransactionType": "Bill of Lading",
                            "value": "INV-233455"
                        }
                    ],
                }
            }
        ],
        "relatedProcesses": [
            {
                "abtBusinessObjectId":"INC-123",
                "processType": "incident"
            }
        ],
        "associatedEntities": [
            {
                "shippedFromBusiness": {
                    "entityIdentifierValue": "2023202120222",
                    "entityIdentifierType": "GLN",
                },
                "fromBusiness": {
                    "entityIdentifierValue": "2023202120222",
                    "entityIdentifierType": "GLN",
                },
        "aptCommentBox": [
            {
                "aptComment": {
                    "commentText": "Please review PO and let us know if you have any questions",
                    "isDeleted": false,
                    "visibilityType": "Public"
                }
            }
        ],
    }
}

Add Compliance Exception response

Guidelines

Element		Type	Description
header		–	Required. The response header.
	headerVersion	Integer	Required. The version identifier for the response. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the response event. Valid value is `agile-process-teams:add-compliance-exception-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 new incident.
	aptBusinessObjectId	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-compliance-exception-response:v3",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "jVgjkz-FC0reR"
    },
    "payload": {
        "aptBusinessObjectId": "SRJCMP-3178",
        "id": "907324d0-6630-4780-b98d-5450af0e9498"
    }
}

Edit Compliance Exception

Owners and Partners use this API to edit an existing compliance exception incident on the Owner company's network, including any responses, comments, or file attachments.

Edit Compliance Exception request

Guidelines

Element				Type	Description
header				–	Required. The request header.
	headerVersion			Integer	Required. The version identifier for the request. Valid value is `1`.
	eventName			String	Required. The fully qualified name of the request event. Valid value is `agile-process-teams:edit-compliance-exception:v3`.
	ownerId			String	Required. The identifier for the company associated with the request.
	appName			String	Required. The application that owns the event. Valid value is `agile-process-teams`.
	processNetworkId			String	Required. The network that contains the incident process. This must be a valid network at the Owner company.
	dataspace			String	Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is `default`.
payload				–	Required. The request body.
	aptBusinessObjectSummary			String	Required. A brief summary of the incident. Cannot exceed 255 characters.
	aptBusinessObjectDescription			String	A detailed description of the incident. Provides additional context for the incident. Cannot exceed 5000 characters.
	businessPriority			Enum	Required. The urgency with which the incident needs to be resolved. Valid values: `LOW` - The incident has low business priority. `MEDIUM` – The incident has medium business priority. `HIGH` – The incident has high business priority. `CRITICAL` – The incident is critical.
	resolutionDueDate			Number	The date and time that the incident must be resolved. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
	currentlyAssignedUsersReporterCompany			Array	List of email addresses for the one or more users at the company reporting the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	responsibleUserReporterCompany			String	The email address of the user from the company that reported the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	reporterCompany			String	The company, company location, Partner company, or Partner company location that owns that reported the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user). The company, company location, Partner company, or Partner company location entered must exist in Master Data.
		masterDataEntityIdentifier		String	The identifier type and value pairing for the company, company location, Partner company, or Partner company location that reported the incident.
			masterDataEntityIdentifierType	String	The type of identifier associated with the reporter company (e.g. GLN).
			masterDataEntityIdentifierValue	String	The value of the identifier entered for masterDataEntityIdentifierType.
	incidentCategory			String	The main problem that caused the incident. Valid values `DATA_ISSUES` – The product's data is incomplete or incorrect. `DAMAGED_PRODUCT` – The product was damaged during the packing, transportation, or filling process. This includes breakage, scratches, or particles resulting from damage. `PRODUCT_BUT_NO_DATA` – The product was received without the required supporting product details (e.g. lot number information). `DATA_BUT_NO_PRODUCT` – A product's details were received without also receiving the physical product. `PACKAGING` – The product's packaging is inadequate or contains incorrect information, such as dosage or usage information. `PRODUCT_HOLD` – The product's shipment was delayed or suspended due to quality concerns, safety issues, regulatory compliance, or other reasons. `SUSPECT_PRODUCT` – The product is believed to be potentially counterfeit, diverted, stolen, intentionally adulterated, the subject of a fraudulent transaction, or appears otherwise unfit for distribution. `MISALIGNMENT` – There is a discrepancy between supply chain partners about the product (e.g. product specifications). `TRACING/VERIFICATION` – The product's history cannot be properly traced or verified. `OTHER` – The incident is caused by a user-defined problem. If this element is `OTHER`, use the otherIncidentCategory element to define the incident type.
	otherIncidentCategory			String	If the incidentCategory is `OTHER`, this is the user-defined incident category associated with the incident. To prevent corrupted data, the otherIncidentCategory should only be included in the request if the incidentCategory is `OTHER`.
	incidentSubcategory			String	The subcategory of the selected incident category associated with the incident. Valid values depend on the incidentCategory selected, as follows: If the incidentCategory is `DATA_ISSUES`: `NON-MATCHING_GLN` – The GLN in the SOR (System of Record) does not match the GLN for the delivery. `GTIN_NOT_FOUND` – A GTIN in the delivery cannot be found in the SOR. `INCORRECTLY_FORMATED_EPCIS` – The delivery's EPCIS message is not formatted correctly. `DATA_RECEIVED/BARCODE_DATA_MISALIGNMENT` – The delivery's data is present in the SOR, but it does not match the data retrieved from the delivery's physical barcode. `004-QUARANTINE_PRODUCT/NO_TL_TI_DATA` – The product in the delivery is in quarantine because the delivery’s transaction information is not present. `005-QUARANTINE_PRODUCT/DELIVERY_NUMBER/BARCODE_MISMATCH` – The product in the delivery is in quarantine because the delivery number or barcode does not match the information in the SOR. `006-QUARANTINE_PRODUCT/PRODUCT_NUMBER_AND_BARCODE_MISMATCH` – The product in the delivery is in quarantine because a product number or barcode in the delivery does not match the information in the SOR. `007-QUARANTINE_PRODUCT/MISALIGNMENT_EXCEPTION_AMENDED` – The product in the delivery is in quarantine because a misalignment occured. If the incidentCategory is `DAMAGED_PRODUCT`: `DAMAGED_CASE_OR_CASE_LABEL` – The case or the case label for the product is damaged. `DAMAGED_EACH` – An each-level container for the product is damaged. `001-QUARANTINE_PRODUCT/DAMAGED_BARCODE` – The product in the delivery is in quarantine because the barcode is damaged. `002-QUARANTINE_PRODUCT/NO_BARCODE` – The product in the delivery is in quarantine because a product in the delivery does not have a barcode. `003-QUARANTINE_PRODUCT/BARCODE_MISSING_TI_DATA` – The product in the delivery is in quarantine because the delivery’s transaction information is not present. If the incidentCategory is `PRODUCT_BUT_NO_DATA`: `EPICS_SENT_BUT_NOT_RECEIVED` – The EPCIS message for the delivery was not received with the physical product. `PRODUCT_RECEIVED_BUT_SERIAL_NUMBER_NOT_FOUND/NO_PO_OR_DELIVERY_NUMBER` – The product is received but its serial number was not found or there is no PO number or delivery number for the product in the SOR. `PRODUCT_RECEIVED_BUT_SERIAL_NUMBER_NOT_FOUND/PO_EXISTS` – The product is received with an existing purchase order but its serial number was not found in the SOR. `PRODUCT_OVERAGE_WITH_VALID_PO` – The product has a valid purchase order but there is more product in the delivery than is present in the SOR. `DELIVERY_TO_RIGHT_COMPANY_BUT_WRONG_DC` – The product is delivered to the right company but to the wrong distribution center. `DELIVERY_TO_WRONG_COMPANY` – The product is delivered to the wrong company. `SERIAL_NUMBER_NOT_FOUND_DUE_TO_AGGRIGATION_OR_OVERAGE_DURING_PICK_PACK_SHIP` – The product is received but its serial number was not found in the SOR due to an overage or aggregation error that occurred in the pick, package, and ship process. If the incidentCategory is `DATA_BUT_NO_PRODUCT`: `DATA_SENT_BUT_PRODUCT_NOT_RECEIVED` – A product’s data is received but the product is not received in the associated delivery, possibly due to a product shortage. `DATA_RECEIVED_THEN_SHIPMENT_QUANTITY_CHANGED_OR_CANCELED` – A product’s data is received but either the product is not received or the quantity of product received is incorrect. `DATA_RECEIVED_BUT_SHIPMENT_REFUSED_OR_UNDELIVERABLE` – A product’s data is received but the product is not received because the delivery was refused or was undeliverable. `DATA_RECEIVED_SHIPMENT_LOST_OR_STOLEN` – A product’s data is received but the product is not received because the delivery was lost or stolen. If the incidentCategory is `PACKAGING`: `SCAN_ON_RECEIPT_PRODUCT/DATA_MISMATCH_DUE_TO_BATCH_LABELING_ISSUE` – When the product is scanned on delivery, the information retrieved from the product label does not match the physical product. `NO_HIERARCHY_OF_SERIAL_NUMBERS_ON_LABEL_UPON_RECEIPT` – The product is received without a hierarchy of serial numbers on the label. `SERIALIZED_SHIPPING_CONTAINER_CODE_DAMAGED_OR_UNUSABLE` – The product's SSCC is damaged or unusable. `2D_BARCODE_WILL_NOT_SCAN_OR_IS_ENCODED_INCORRECTLY_OR_HAS_INCOMPLETE_ELEMENTS` – The product's 2D barcode will not scan, is encoded incorrectly, or has incomplete elements. `NO_HIERARCHY_OF_SERIAL_NUMBERS_AT_PICK/PACK/SHIP` – The product's hierarchy of serial numbers was not included on the label during the pick, package, and ship process. If the incidentCategory is `PRODUCT_HOLD`: `EPCIS_EVENTS_OUT_OF_ORDER_OR_DO_NOT_MATCH_PRODUCT_STATUS` – The product is on hold because the events in the delivery's EPICS message are listed out of sequence or do not match the product’s current status. `SERIAL_NUMBER_IN_HOLD_STATUS_DURING_PICK/PACK/SHIP_DUE_TO_RECALL_OR_SUSPECT_OR_ILLEGITIMATE_PRODUCT` – The product's serial number is updated to on hold during the pick, package, and ship process because the product is listed as recalled, suspect, or illegitimate. `DELAYED_SHIPMENT` – The product is on hold because its delivery is delayed. If the incidentCategory is `SUSPECT_PRODUCT`: `INITIAL_NOTIFICATION` – The product is being reported as suspect for the first time. `FOLLOW_UP_NOTIFICATION` – The product is being reported as suspect for at least the second time. `REQUEST_FOR_TERMINATION` – The product is suspect and should be terminated. If the incidentCategory is `OTHER`: `OTHER` – The incident is associated with a user-defined incident category. If this field is `OTHER`, use the otherIncidentSubcategory to define the subtype.
	otherIncidentSubcategory			String	If the incidentSubcategory is `OTHER`, this is the user-defined incident subcategory associated with the incident. To prevent corrupted data, the otherIncidentSubcategory should only be included in the request if the incidentSubcategory is `OTHER`.
	accountableEntity			Array	The identifier for the company, company location, Partner company, or Partner company location that owns the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user). The company, company location, Partner company, or Partner company location entered must exist in Master Data.
		masterDataEntityIdentifier		String	The identifier type and value pairing for the company, company location, Partner company, or Partner company location that owns the incident and is responsible for the incident's resolution.
			masterDataEntityIdentifierType	String	The type of identifier associated with the accountable entity (e.g. GLN).
			masterDataEntityIdentifierValue	String	The value of the identifier entered for masterDataEntityIdentifierType.
	responsibleUserAccountableEntity			String	The email address of the user from the company that is accountable for the incident and is responsible for the incident's resolution. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	currentlyAssignedUsersAccountableEntity			Array	List of email addresses for the one or more users at the company that is accountable for the incident and is responsible for taking action to resolve the incident. If omitted, defaults to `null` (i.e. the system `Unassigned` user).
	responsibleDepartmentAtCompany			String	The business area of the 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`. Valid values `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. `CORAM` – The user responsible for resolving the incident is part of the Coram 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. `DISTRIBUTION_CENTERS` – The user responsible for resolving the incident is part of the Distribution Centers 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. `MINUTE_CLINIC` – The user responsible for resolving the incident is part of the Minute Clinic team. `OMNICARE` – The user responsible for resolving the incident is part of the Omnicare 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. `PBM_MAIL_ORDER` – The user responsible for resolving the incident is part of the PBM Mail Order team. `PBM_SPECIALTY_MAIL` – The user responsible for resolving the incident is part of the PBM Specialty Mail 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. `RETAIL` – The user responsible for resolving the incident is part of the Retail team. `SALES_OR_MARKETING` – The user responsible for resolving the incident is part of a Sales team or Marketing team. `SPECIALTY_PHARMACY_OR_CAREPLUS` – The user responsible for resolving the incident is part of the Specialty Pharmacy or CarePlus team. `SPECIALTY_WHOLESALE` – The user responsible for resolving the incident is part of the Specialty Wholesale team. `SUPPLY_CHAIN` – The user responsible for resolving the incident is part of a Supply Chain team. `VANGAURD` – The user responsible for resolving the incident is part of the Vanguard team.
	associatedEntities			Object	List of identifiers for the supply chain entities associated with the incident throughout the supply chain.
		shippedFromBusiness		Object	The location that the product associated with the incident was initially shipped from.
			entityIdentifierValue	String	The value of the identifier for the location that the product associated with the incident was initially shipped from.
			entityIdentifierType	String	The identifier type for the location that the product associated with the incident was initially shipped from.
		fromBusiness		Object	The company that the product associated with the incident was ordered from.
			entityIdentifierValue	String	The value of the identifier for the company that the product associated with the incident was ordered from.
			entityIdentifierType	String	The identifier type for the company that the product associated with the incident was ordered from.
		shippedToBusiness		Object	The location that the product associated with the incident was shipped to.
			entityIdentifierValue	String	The value of the identifier for the location that the product associated with the incident was shipped to.
			entityIdentifierType	String	The identifier type for the location that the product associated with the incident was shipped to.
		toBusiness		Object	The company that the product associated with the incident was ordered by.
			entityIdentifierValue	String	The value of the identifier for the company that the product associated with the incident was ordered by.
			entityIdentifierType	String	The identifier type for the company that the product associated with the incident was ordered by.
		notes		String	General notes or comments about the entities associated with the incident.
	issueDetail			Array	The product and transaction details associated with the incident.
		referenceTransactions		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 associated with the incident. 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. `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 5000 characters.
		productIdentifier		Array	The identifier for the product affected by the compliance exception. The product must exist in Master Data.
			productIdentifierType	String	The type of identifier for the product used by the relevant regulatory agency (i.e. NDC or GTIN).
			productIdentifierValue	String	The value of the identifier entered for productIdentifierType.
		issueProductDetails		String	Any additional details about the product impacted by the incident.
		scanDate		Date	The date and time that the physical product was scanned in as received by the entity at its current location. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
		quantity		Array	The state and amount of each product associated with the incident.
			quantityType	String	The state of the product in relation to its Purchase Order status. Valid values: `ORDER` `ITEM` `NET` `GROSS` `PRICING_UNIT` `COMMITTED` `DAMAGED` `DELIVERED` `DELIVERY` `HOLD` `IN_TRANSIT` `INVOICE` `LADING` `MINIMUM_TO_MAKE_ORDER` `MINIMUM_DELIVERY` `MINIMUM_ORDER` `ON_HAND` `ON_HOLD` `ON_ORDER` `OUTSTANDING` `OVER` `PACKAGED` `PURCHASE_ORDER` `QUESTIONED` `RECEIVED` `REJECTED` `RETURNED` `SCRAP` `SHIPPED_TO_DATE` `SHORT` `STOCK_KEEPING` `UNUSABLE`
			quantityValue	String	The amount of product affected by the incident (e.g. 1,500). Cannot exceed 12 characters.
			quantityUnitOfMeasurement	String	The unit of measure for the specified amount of impacted product. Valid values `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.
		productCodeInformation		Array	The company that the product associated with the incident was initially shipped from.
			serialNumber	String	The serial number impacted by the incident.
			lotNumber	String	The lot number associated with the serial number.
			expirationDate	String	The date that all serial numbers in the lot expire. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
		additionalInformation		Object	Additional information about the product's makeup and use. This element should only be entered if the incidentCategory is `SUSPECT_PRODUCT`.
			drugComposition	String	The product's primary ingredients.
			drugUse	String	The intended type of end user for the drug. Valid values: `HUMAN` – The product is intended to be consumed by humans. `OTHER` - The product is not intended to be consumed humans.
			drugDescription	String	The classification of the drug. Valid values: `Finished Prescription Drug` – The drug is classified as a finished prescription drug. `Vaccine` – The drug is classified as a vaccine. `Plasma Derivative (coagulation factors, immunoglobulins, albumin)` – The drug is classified as a plasma derivative. `Allergenic (standardized and non standardized)` – The drug is classified as an allergenic. `Multiple` – The drug is classified in more than one way.
			eventIssueDescription	String	The reason that the product was labeled as suspect. Cannot exceed 5000 characters. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in the description
			requestForNotificationTermination	String	The reason that the previous compliance exception notification submitted to a regulatory agency is void and is being withdrawn. Cannot exceed 5000 characters. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in addition to the reason why the previous compliance exception is being withdrawn.
			submittedThroughAlternateMechanism	String	Conditionally required if requestForNotificationTermination is present. The method used if the incident was previously submitted to the regulatory agency. Valid values: `BPDR-BIOLOGICAL_PRODUCT_DEVIATION_REPORT` – A drug notification was previously submitted to the FDA for this product using a BDPR (Biological Product Deviation Report). `FAR-FIELD_ALTER_REPORT` – A drug notification was previously submitted to the FDA for this product using a FAR (Field Alert Report). `MEDWATCH_3500` – A drug notification was previously submitted to the FDA for this product using the Medwatch 3500 form. `MEDWATCH_3500A` – A drug notification was previously submitted to the FDA for this product using the Medwatch 3500 form. `OTHER` – A drug notification was previously submitted to the FDA for this product using a method not listed here. `NONE` – Indicates was not previously submitted to the FDA for this product. If submittedThroughAlternateMechanism is `OTHER`, include the alternative method used to initially submit the notification to a regulatory agency in the requestForNotificationTermination.
			otherSubmittedThroughAlternateMechanism	String	Conditionally required if submittedThroughAlternateMechanism is `OTHER`. The alternative method used to initially submit the notification to a regulatory agency.
			incidentNumber	String	Conditionally required if requestForNotificationTermination is present. The incident number that has been provided by the regulatory agency for the incident.
			initialNotificationDateToFDA	String	The date that the FDA was initially notified of the incident. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
			dateProductIdentifiedAsIllegitimate	String	The date that the product was identified as illegitimate. Enter the date in either of the following formats: YYYY-MM-DDTHH:MM:SS.SSS-Z (e.g. 2022-10-26T17:30:00.000-00:00 for 26th Oct 2022, 17:30:00.000 GMT). Unix epoch time in milliseconds (e.g. 1656338327000 for 27th Jun 2022 13:58:47.000 GMT).
			notificationClassification	String	The reason the product was identified as illegitimate. Valid values: `COUNTERFEIT` – The product is determined to be counterfeit or has a high risk of being counterfeit. `DIVERTED` – The product is determined to be a diverted product or has a high risk of being a diverted product. `STOLEN` – The product is determined to be a stolen product or has a high risk of being a stolen product. `INTENTIONAL ADULTERATION` – The product is determined to be intentionally adulterated such that use of the product has a high risk of resulting in serious adverse health consequences or death to humans. `UNFIT FOR DISTRIBUTION` – The product appears unfit for distribution such that use of the product has a high risk resulting in serious adverse health consequences or death to humans. `FRAUDULENT TRANSACTION` – The product is determined to be or has a high risk of being the subject of a fraudulent transaction.
			businessType	String	The business role of the company that identified the product as suspect. Valid values: `DISPENSER` – The company responsible for dispensing the product identified it as suspect. `MANUFACTURER` – The company responsible for producing the product identified it as suspect. `REPACKAGER` – The company responsible for repackaging the product identified it as suspect. `WHOLESALE DISTRIBUTOR` – The company responsible for distributing the product identified it as suspect. This element maps to Company Category for FDA Drug Notifications.
	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. Valid values: `incident` `change` `directSupplierIncident` `externalManufacturingIncident` `documentReview` `task` `complianceException`
		relationshipType		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			Array	Contains any comments or files to attach to the incident.
		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	String	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.
		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	String	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.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-compliance-exception:v3",
        "ownerId": "d25ab887-247f-4147-b8f1-36ff70ccd594",
        "processNetworkId": "{{comp1Pni}}",
        "appName": "2154f852-02eb-4725-b521-047df60bbbff",
        "dataspace": "default"
    },
    "payload": {
        "aptBusinessObjectSummary": "Kendall Pharma | ACME Inc | INC-2023-01 | No EPCIS Data for 1 package",
        "aptBusinessObjectDescription": "Shipment quarantined due to T1 reflecting incomplete data|SO 3027209239|PO 5201019344|Transaminase enzyme, CDX-017 (ACS-4007466). EPCIS shows 48 pallets and receiving called out 50 received ",
        "businessPriority": "HIGH",
        "createdByPartner": false,
        "resolutionDueDateISO": "2023-04-15T01:30:00.000-05:00",
        "currentlyAssignedUsersReporterCompany": {
            "userEmails":[
                "johndoe@tracelink.com",
                "janedoe@tracelink.com"
            ]
        },
        "responsibleUserReporterCompany":{
            "userEmail":"johndoe@tracelink.com"
        },
        "currentlyAssignedUsersAccountableEntity": {
            "userEmails":[
                "jasondoe@tracelink.com",
                "jananiedoe@tracelink.com"
            ]
        },
        "responsibleUserAccountableEntity":{
            "userEmail":"jasondoe@tracelink.com"
        },
        "incidentCategory": "Product, No Data",
        "incidentSubCategory": "Product Overage with valid PO",
        "accountableEntity":{
            "masterDataEntityIdentifier":{
                "masterDataEntityIdentifierType": "GLN",
                "masterDataEntityIdentifierValue": "9263497412690"
            }
        },
        "reporterCompany": {
            "masterDataEntityIdentifier":{
                "masterDataEntityIdentifierType": "GLN",
                "masterDataEntityIdentifierValue": "9263497412690"
            }
        },
        "issueDetail": [
            {
                "productIdentifier":{
                  "productIdentifierType": "NDC",
                  "productIdentifierValue": "9263497410"
                },
                "issueProductDetails": {
                    "quantityDetails": [
                        {
                            "quantityType": "ORDER",
                            "quantityValue": "100",
                            "quantityUnitOfMeasure": "Pallet"
                        }
                    ],
                    "productDetailInformation": [
                        {
                            "lotNumber": "123123",
                            "expirationDateISO": "2023-04-15T01:30:00.000-05:00",
                        }
                    ],
                    "impactedSerialNumber":"1234567895,12346734534,123124555",
                    "referenceTransactions": [
                        {
                            "referenceTransactionType": "Bill of Lading",
                            "value": "INV-233455"
                        }
                    ],
                }
            }
        ],
        "relatedProcesses": [
            {
                "abtBusinessObjectId":"INC-123",
                "processType": "incident"
            }
        ],
        "associatedEntities": [
            {
                "shippedFromBusiness": {
                    "entityIdentifierValue": "2023202120222",
                    "entityIdentifierType": "GLN",
                },
                "fromBusiness": {
                    "entityIdentifierValue": "2023202120222",
                    "entityIdentifierType": "GLN",
                },
        "aptCommentBox": [
            {
                "aptComment": {
                    "commentText": "Please review PO and let us know if you have any questions",
                    "isDeleted": false,
                    "visibilityType": "Public"
                }
            }
        ],
    }
}

Edit Compliance Exception response

Guidelines

Element		Type	Description
header		–	Required. The response header.
	headerVersion	Integer	Required. The version identifier for the response. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the response event. Valid value is `agile-process-teams:edit-compliance-exception-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 new incident.
	aptBusinessObjectId	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-compliance-exception-response:v3",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "aDXe0m-xgpqzM"
    },
    "payload": {
        "id": "26a61063-3222-48c4-8abc-f58265a46f1b",
        "aptBusinessObjectId": "SRJCMP-3170"
    }
}

Close Compliance Exception Incident

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

Close Compliance Exception Incident request

Guidelines

Element			Type	Description
header			–	Required. The request header.
	headerVersion		Integer	Required. The version identifier for the request. Valid value is `1`.
	eventName		String	Required. The fully qualified name of the request event. Valid value is `agile-process-teams:close-compliance-exception-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.
	aptBusinessObjectId		String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).
	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`.
	closingStatement		String	Any final closing statement about the incident and its closure. Cannot exceed 5000 characters.
		dispositionType	String	The product action taken as a result of the incident. Valid values: `APPROVE_(RELEASE)` – The compliance exception is within acceptable business standards. The product is approved for release. `REJECT_(OV_RETURN)` – The compliance exception is not within acceptable business standards. The product is returned to an outside vendor. `REJECT_(NSR_RETURN)` – The compliance exception is not within acceptable business standards. The product is returned as non-saleable. `REJECT_(OTHER)` – The compliance exception is not within acceptable business standards. The product is returned for an unspecified reason.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-compliance-exception:v3",
        "ownerId": "{{comp1}}",
        "processNetworkId": "{{comp1Pni}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "907324d0-6630-4780-b98d-5450af0e9498",
        "aptBusinessObjectId": "SRJCMP-3170",
        "resolutionType": "DUPLICATE",
        "isReoccuring": false,
        "finalRootCause": "Documentation",
        "closingStatement": "Closing as non incident - Duplicate "
        "dispositionType": "Approve, Release"
    }
}

Close Compliance Exception Incident response

Guidelines

Element		Type	Description
header		–	Required. The response header.
	headerVersion	Integer	Required. The version identifier for the response. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the response event. Valid value is `agile-process-teams:close-compliance-exception-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.The unique identifier TraceLink assigns to the incident (e.g. APT-12345).
	aptBusinessObjectId	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-compliance-exception-response:v3",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "aUjSqx-ijaRev"
    },
    "payload": {
        "id": "907324d0-6630-4780-b98d-5450af0e9498",
        "aptBusinessObjectId": "SRJCMP-3178",
        "message": "complianceException 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.

Submit Compliance Exception Incident to Accountable Entity

Owners use the API to submit an existing compliance exception incident to the accountable entity specified in the incident accountableEntity. This cannot be undone.

Upon successful response:

The Partner is notified of the incident on their network.
The incident becomes visible to the Partner.

Submit Compliance Exception Incident to Accountable Entity request

Guidelines

Element		Type	Description
header		–	Required. The request header.
	headerVersion	Integer	Required. The version identifier for the request. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the request event. Valid value is `agile-process-teams:submit-compliance-exception-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 accountable entity specified in accountableEntity.
	aptBusinessObjectID	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345)..

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:submit-to-entity:v1",
         "ownerId": "66e73280-747d-4d5e-9dea-d20df3f3ff2b",
         "processNetworkId": "014c005d-7c06-4613-8456-d0d58be49fab",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
     //"aptBusinessObjectId": "aptDR-2732"
      "id": "10f06c77-729b-4fa3-8168-bd99432fdbd2"
  
    }
}

Submit Compliance Exception Incident to Accountable Entity response

Guidelines

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

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:submit-to-entity:v1",
         "ownerId": "66e73280-747d-4d5e-9dea-d20df3f3ff2b",
         "processNetworkId": "014c005d-7c06-4613-8456-d0d58be49fab",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
     //"aptBusinessObjectId": "aptDR-2732"
      "id": "10f06c77-729b-4fa3-8168-bd99432fdbd2"
  
    }
}

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 is not associated to 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.

Reopen Compliance Exception Incident

Owners and Partners use this API to reopen a closed compliance exception 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.

Reopen Compliance Exception Incident request

Guidelines

Element		Type	Description
header		–	Required. The request header.
	headerVersion	Integer	Required. The version identifier for the request. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the request event. Valid value is `agile-process-teams:reopen-compliance-exception-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 closed incident to reopen.
	aptBusinessObjectID	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-compliance-exception-incident:v3",
        "ownerId": "{{comp1}}",
        "processNetworkId": "{{comp1Pni}}",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "907324d0-6630-4780-b98d-5450af0e9498",
        "aptBusinessObjectId": "SRJCMP-3178"
    }
}

Reopen Compliance Exception Incident response

Guidelines

Element		Type	Description
header		–	Required. The response header.
	headerVersion	Integer	Required. The version identifier for the response. Valid value is `1`.
	eventName	String	Required. The fully qualified name of the response event. Valid value is `agile-process-teams:reopen-compliance-exception-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 reopened incident.
	aptBusinessObjectID	String	The unique identifier TraceLink assigns to the incident (e.g. APT-12345).
	message	String	Required. The message indicating the incident is reopened.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-compliance-exception-incident-response:v3",
        "ownerId": "62858857-a04e-4b90-9355-c51861160b69",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "oL788H-1aZH4z"
    },
    "payload": {
        "id": "907324d0-6630-4780-b98d-5450af0e9498",
        "aptBusinessObjectId": "SRJCMP-3178",
        "message": "complianceException 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.
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.