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

Compliance Exception APIs

Companies that own or link to Agile Process Teams use these APIs to add, update, and close compliance exceptions. Compliance Exceptions function as a sub-type of the Work Item base object, ensuring efficient tracking and resolution. Compliance exceptions help Owners and Partners of Agile Process Teams to collaborate with relevant upstream or downstream partners, and resolve issues quickly.

Add compliance exception

Owners and Partners use this API to add a compliance exception to the Owner's company network, including any initial comments or file attachments. The response returns a generated identifier for the new compliance exception.

New tasks are assigned the Draft base state by default.

Contact your TraceLink Services representative for more information about using this API.

Add compliance exception request

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
105
106
107
mutation WorkItemNew {
  workItem {
    new(
      input: {
        workItem: {
          payload: {
            subType: "ext_TRACELINK_dscsaComplianceException"
            id: "TLGUID-1"
            currentBaseState: "Draft"
            data: {
              assigneeCompany: {
                businessName: "QAPartnerCorp2202409240834283621"
                primaryIdentifierType: "GLN"
                primaryIdentifierValue: "5640375601379"
              }
              workItemTitle: "Packaging information is missing"
              dueDate: 1741564800000
              comments: [
                { commentText: "Please provide the respective details" }
              ]
              additionalProperties: {
                ext_TRACELINK_referenceTransactionsTypeDefinition: [
                  {
                    referenceTransactionIdentifierValue: "5432123456"
                    referenceTransactionIdentifierType: "PURCHASEORDER"
                  }
                ]
                ext_TRACELINK_category: "SUSPECT_PRODUCT"
                ext_TRACELINK_businessUnit: "PACKAGING"
                ext_TRACELINK_subCategory: "Other"
                ext_TRACELINK_businessPriority: "MEDIUM"
                ext_TRACELINK_description: "Suspecting product is missing more information"
                ext_TRACELINK_toBusiness: {
                  businessName: "qaownercorp202409240834253301-Loc6"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  ext_TRACELINK_primaryIdentifierValue: "4700421771713"
                }
                ext_TRACELINK_fromBusiness: {
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  businessName: "qaownercorp202409240834253301-Loc1"
                  ext_TRACELINK_primaryIdentifierValue: "4700421764197"
                }
                ext_TRACELINK_shippedToBusiness: {
                  ext_TRACELINK_primaryIdentifierValue: "4700421754228"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  businessName: "qaownercorp202409240834253301-Loc10"
                }
                ext_TRACELINK_shippedFromBusiness: {
                  ext_TRACELINK_primaryIdentifierValue: "5640375601379"
                  businessName: "QAPartnerCorp2202409240834283621"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                }
                ext_TRACELINK_dscsaDocuments: [
                  "{\"fileName\":\"Screenshot 2024-07-01 at 7\",\"fileExtension\":\"png\",\"mimeType\":\"image/png\",\"fileSize\":213878,\"s3FileReference\":\"attachments/workItem/6adb77e3-e6a9-47bb-bcc8-d8ccdaefa70e\",\"fileStatus\":\"UPLOADED\"}"
                  "{\"fileName\":\"Screenshot 2024-07-03 at 6\",\"fileExtension\":\"png\",\"mimeType\":\"image/png\",\"fileSize\":3474602,\"s3FileReference\":\"attachments/workItem/ced0bd7b-c683-452b-bf65-6cc0d9a0fbb2\",\"fileStatus\":\"UPLOADED\"}"
                ]
                ext_TRACELINK_supplementaryProductDetailInformationTypeDefinition: {
                  requestForNotificationTermination: "FF544343"
                  drugUse: "HUMAN_USE"
                  reportType: "INITIAL_NOTIFICATION"
                  incidentNumber: "1345"
                  drugDescription: "FINISHED_PRESCRIPTION_DRUG"
                  epochInitialNotificationDateToFDA: 1743420720000
                  notificationClassification: "UNFIT_FOR_DISTRIBUTION"
                  businessType: "CHEMIST"
                  drugComposition: "TEST"
                  submittedThroughAlternateMechanism: "[\"FAR\",\"MEDWATCH_3500A\",\"BPDR\",\"MEDWATCH_3500\"]"
                  productLabelName: "FLUE MED"
                  epochDateProductIdentifiedAsIllegitimate: 1743420720000
                }
                ext_TRACELINK_responsibleUserAtAssigneeCompany: {
                  userEmail: "qeauto+qapartnercorp1202409240834280621-coa@tracelink.com"
                }
                ext_TRACELINK_responsibleUserAtInitiatingCompany: {
                  userEmail: "qeauto+qapartnercorp2202409240834283621-coa@tracelink.com"
                }
                ext_TRACELINK_dscsaImpactedProductDetailsTypeDefinition: [
                  {
                    epochExpirationDate: 1743420660000
                    primaryItemCodeValue: "12649-920-54"
                    lotNumber: "5432123456"
                    packagingInformationDerivedField: "DFGHRDCV"
                    primaryItemCodeType: "US_NDC532"
                    productName: "Flu Med"
                    impactedSerialNumbers: [
                      {
                        serialNumber: "5432123456"
                        purchaseOrderNumber: "GTINFF2434SDSD"
                      }
                    ]
                  }
                ]
              }
            }
          }
          objectAction: "CREATE"
        }
      }
    ) {
      created {
        id
        objectTypeName
        dataVersion
      }
    }
  }
}

Add compliance exception response

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "data": {
        "workItem": {
            "new": {
                "created": [
                    {
                        "id": "8424cd23-6a3d-44a6-bf9a-cc395c346f07",
                        "objectTypeName": "workItem",
                        "dataVersion": 1
                    }
                ]
            }
        }
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Edit compliance exception

Owners and Partners use this API to modify an existing compliance exception with new, updated, or corrected information (e.g. adding a description, updating the assignee company details, fixing a typo) and to update the workflow state (e.g. manually transitioning the base state from Draft to ToDo to indicate that the work assigned in the compliance exception has started).

Contact your TraceLink Services representative for more information about using this API.

Edit compliance exception request

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
105
106
mutation WorkItemEdit {
  workItem {
    edit(
      input: {
        workItem: {
          payload: {
            id: "7582d951-485d-45f1-bcd1-bef3b06848ed"
            currentBaseState: "ToDo"
            currentSubState: ""
            data: {
              assigneeCompany: {
                businessName: "QAPartnerCorp2202409240834283621"
                primaryIdentifierType: "GLN"
                primaryIdentifierValue: "5640375601379"
              }
              workItemTitle: "Packaging information is missing"
              dueDate: 1741564800000
              comments: [
                { commentText: "Please provide the respective details" }
              ]
              additionalProperties: {
                ext_TRACELINK_referenceTransactionsTypeDefinition: [
                  {
                    referenceTransactionIdentifierValue: "5432123456"
                    referenceTransactionIdentifierType: "PURCHASEORDER"
                  }
                ]
                ext_TRACELINK_category: "SUSPECT_PRODUCT"
                ext_TRACELINK_businessUnit: "PACKAGING"
                ext_TRACELINK_subCategory: "Other"
                ext_TRACELINK_businessPriority: "MEDIUM"
                ext_TRACELINK_description: "Suspecting product is missing more information"
                ext_TRACELINK_toBusiness: {
                  businessName: "qaownercorp202409240834253301-Loc6"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  ext_TRACELINK_primaryIdentifierValue: "4700421771713"
                }
                ext_TRACELINK_fromBusiness: {
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  businessName: "qaownercorp202409240834253301-Loc1"
                  ext_TRACELINK_primaryIdentifierValue: "4700421764197"
                }
                ext_TRACELINK_shippedToBusiness: {
                  ext_TRACELINK_primaryIdentifierValue: "4700421754228"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                  businessName: "qaownercorp202409240834253301-Loc10"
                }
                ext_TRACELINK_shippedFromBusiness: {
                  ext_TRACELINK_primaryIdentifierValue: "5640375601379"
                  businessName: "QAPartnerCorp2202409240834283621"
                  ext_TRACELINK_primaryIdentifierType: "GLN"
                }
                ext_TRACELINK_dscsaDocuments: [
                  "{\"fileName\":\"Screenshot 2024-07-01 at 7\",\"fileExtension\":\"png\",\"mimeType\":\"image/png\",\"fileSize\":213878,\"s3FileReference\":\"attachments/workItem/6adb77e3-e6a9-47bb-bcc8-d8ccdaefa70e\",\"fileStatus\":\"UPLOADED\"}"
                  "{\"fileName\":\"Screenshot 2024-07-03 at 6\",\"fileExtension\":\"png\",\"mimeType\":\"image/png\",\"fileSize\":3474602,\"s3FileReference\":\"attachments/workItem/ced0bd7b-c683-452b-bf65-6cc0d9a0fbb2\",\"fileStatus\":\"UPLOADED\"}"
                ]
                ext_TRACELINK_supplementaryProductDetailInformationTypeDefinition: {
                  requestForNotificationTermination: "FF544343"
                  drugUse: "HUMAN_USE"
                  reportType: "INITIAL_NOTIFICATION"
                  incidentNumber: "1345"
                  drugDescription: "FINISHED_PRESCRIPTION_DRUG"
                  epochInitialNotificationDateToFDA: 1743420720000
                  notificationClassification: "UNFIT_FOR_DISTRIBUTION"
                  businessType: "CHEMIST"
                  drugComposition: "TEST"
                  submittedThroughAlternateMechanism: "[\"FAR\",\"MEDWATCH_3500A\",\"BPDR\",\"MEDWATCH_3500\"]"
                  productLabelName: "FLUE MED"
                  epochDateProductIdentifiedAsIllegitimate: 1743420720000
                }
                ext_TRACELINK_responsibleUserAtAssigneeCompany: {
                  userEmail: "qeauto+qapartnercorp1202409240834280621-coa@tracelink.com"
                }
                ext_TRACELINK_responsibleUserAtInitiatingCompany: {
                  userEmail: "qeauto+qapartnercorp2202409240834283621-coa@tracelink.com"
                }
                ext_TRACELINK_dscsaImpactedProductDetailsTypeDefinition: [
                  {
                    epochExpirationDate: 1743420660000
                    primaryItemCodeValue: "12649-920-54"
                    lotNumber: "5432123456"
                    packagingInformationDerivedField: "DFGHRDCV"
                    primaryItemCodeType: "US_NDC532"
                    productName: "Flu Med"
                    impactedSerialNumbers: [
                      {
                        serialNumber: "5432123456"
                        purchaseOrderNumber: "GTINFF2434SDSD"
                      }
                    ]
                  }
                ]
              }
            }
          }
          objectAction: "UPDATE"
        }
      }
    ) {
      updated {
        id
        objectTypeName
        dataVersion
      }
  }
}

Edit compliance exception response

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "data": {
        "workItem": {
            "new": {
                "updated": [
                    {
                        "id": "8424cd23-6a3d-44a6-bf9a-cc395c346f07",
                        "objectTypeName": "workItem",
                        "dataVersion": 1
                    }
                ]
            }
        }
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Close compliance exception

Owners use this API to close a compliance exception that is resolved. Provide the compliance exception identifier in the input field and the current base state to close a compliance exception.

Contact your TraceLink Services representative for more information about using this API.

Close compliance exception request

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
mutation WorkItemEdit {
  workItem {
    edit(
      input: {
        workItem: {
          payload: {
            id: "32176da9-2db0-45c6-b9fc-3fd339927f97"
            currentBaseState: "Done"
            currentSubState: ""
            data: {}
          }
          objectAction: "UPDATE"
        }
      }
    ) {
      updated {
        id
        objectTypeName
        dataVersion
      }
    }
  }
}

Close compliance exception response

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "data": {
        "workItem": {
            "edit": {
                "updated": [
                    {
                        "id": "32176da9-2db0-45c6-b9fc-3fd339927f97",
                        "objectTypeName": "workItem",
                        "dataVersion": 9
                    }
                ]
            }
        }
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.