Document review APIs

Companies that own or link to Agile Process Teams use these APIs to add, evaluate, share, and close reviews of general documents that might need review and approval (e.g. audit reports, compliance reports, certificates). Partners must be a member of the Owner company's network to collaborate with the Owner on a document review.

Document reviews can be in one of three base workflow states:

  • To Do – The document review is new and has not been assigned. Can be transitioned to In Review or Closed.
  • In Review – The submitted document is ready for evaluation by assigned users. This state can be manually applied. It is automatically applied when the document review is assigned and when a closed review is reopened. Can be transitioned to Closed.
  • Closed – The document review is complete. This state is applied when the resolution is submitted. Can be transitioned back to In Review.

Add Document Review

Owners and Partners use this API to add a new general document review request on the Owner company's network. The request includes the uploaded general document as well as any initial comments or additional attachments. The response returns a generated identifier for the new document review.

New document reviews are assigned the ToDo base state by default.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:add-document-review:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the document review process. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  partnerCompany Object The identifier number and type for the Partner company associated with the document review.
    partnerId String The identifier for the Partner company.
    toIdType Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
  aptBusinessObjectSummary String Required. A brief summary of the document review. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the document review request. Provides additional information to help the responsible parties complete the document review. Cannot exceed 5000 characters.
  responsiblePartyAtCompany String The identifier for the person from the Owner company that owns the document review from the Owner's side and is responsible for the completing the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the completing the document review. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the document review is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for the document review is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for the document review is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the document review is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the document review is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the document review is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the document review is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the document review is part of an Operations team.
  • PACKAGING – The user responsible for completing the document review is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the document review is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the document review is part of a Project Management team.
  • PURCHASING – The user responsible for completing the document review is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the document review is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the document review is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the document review is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the document review is part of a Supply Chain team.
  responsiblePartyAtPartner String The identifier for the person from the Partner company that owns the document review from the Partner's side and is responsible for the completing the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  responsibleDepartmentAtPartner String The business area of the Partner company that is responsible for the completing the document review. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the document review is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for the document review is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for the document review is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the document review is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the document review is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the document review is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the document review is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the document review is part of an Operations team.
  • PACKAGING – The user responsible for completing the document review is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the document review is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the document review is part of a Project Management team.
  • PURCHASING – The user responsible for completing the document review is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the document review is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the document review is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the document review is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the document review is part of a Supply Chain team.
  currentlyAssignedCompanyUsers Array List of one or more users at the Owner company assigned to the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of one or more users at the Partner company assigned to the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  businessPriority Enum

Required. The urgency with which the document review needs to be resolved.

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

Required.The date and time (in Unix epoch time in milliseconds) that the review process must be completed.

If omitted, the date is calculated by adding the default time (in hours) configured for the network to the time the review was added. For example, if the default approvalRequiredWithinHours is 336 and the current date is 01 Jun 2021, the approvalDueDate is calculated as 14 Jun 2021.
  initiatingCompany String The identifier number and type for the company initiating the request.
  documentReviewType Enum

The type of document being reviewed. Valid values:

  • AUDIT_REPORT – The document is an audit report.
  • COMPLIANCE_REPORT – The document is a compliance report.
  • STANDARD_OPERATING_PROCEDURE – The document is a standard operating procedure (SOP).
  • QUALITY_REVIEW – The document is a quality review.
  • PARTNER_COMPLIANCE_REPORT – The document is a partner compliance report.
  • PRODUCTION_PLANNING_DOCUMENT – The document is a production planning document.
  • LABEL_OR_ARTWORK – The document is a product label or artwork.
  • IMPLEMENTATION_PLAN – The document is an implementation plan.
  • MATERIAL_QUALITY_DOCUMENT – The document is related to the quality of materials.
  • SUPPLIER_CERTIFICATE – The document is a supplier certificate.
  • OTHER – The document type is user-defined. If this field is OTHER, use the otherDocumentReviewType to define the document type.
  otherDocumentReviewType String

If the documentReviewType is OTHER, this is the user-defined document type.

To prevent corrupted data, the otherDocumentReviewType should only be included in the request if the documentReviewType is OTHER.
  documentReviewImpacts Object Contains information about the ways in which the review impacts production.
    impactedLots String The identifiers for one or more lots of product associated with the review Cannot exceed 255 characters.
    impactedProductId String The identifier for one or more products associated with the review.
    locationId String The identifier for the location associated with the review. This must exist in Master Data and be linked to the current network.
    reviewReferenceIdentifier Array The internal reference identifiers used by the Owner or Partner's external system of record to identify the document review (e.g. Partner Review Number: QMS123).
      reviewTransactionType Enum

The type of the reference identifier. Valid values:

  • INTERNAL_REVIEW_NUMBER – The reference ID is an internal review number.
  • PARTNER_REVIEW_NUMBER – The reference ID is a partner review number.
      value String

The value for the selected reviewTransactionType. Cannot exceed 72 characters.
  createdByPartner Boolean

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

Valid values:

  • true – Yes, the new document review is created by a user from the Partner.
  • false – No, the new document review is created by a user from the Owner.
  addDocumentBox Object

Contains the document to be reviewed.
    addAttachment Array One or more relevant files to attach to the incident. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String Required. The name of the file to attach. Cannot exceed 255 characters.
      fileSize String Required.The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the incident can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the incident can view the attached file.
      requestIdentifier String

Required. The identifier for the upload request provided by File Import and Export Manager.

  relatedProcesses Array

One or more processes to link to the document review request as a related process (e.g. the document relates to a change request currently being implemented).

This must be an existing process (e.g. incident, change request, or document review) in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current document review.

Valid values:

  • RELATES_TO – The linked process is related to the current document review.
  • BLOCKS – The linked process prevents the current document review’s resolution.
  • BLOCKED_BY – The current document review prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current document review.
  • CONTAINED_BY – The current document review is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current document review's resolution.
  • DEPENDENCY_FOR – The current document review affects the linked process's resolution.
  aptCommentBox Object Contains any comments or files to attach to the document review being added.
    aptComment Array One or more initial comments about the document review or explanations for the attachments that the user who is adding the review wants to provide.
      commentText String Required. The text of the comment. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the incident can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the incident can view the comment.
    addAttachment Array One or more relevant files to attach to the incident. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String Required. The name of the file to attach. Cannot exceed 255 characters.
      fileSize String Required.The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the incident can view the attached file.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the attached file.

  • public – Yes, users from the Partner company associated with the incident can view the attached file.
      requestIdentifier String

Required. The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-document-review:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "partnerId": "ValidPartnerId",
        "aptBusinessObjectSummary": "PN3161193783831918",
        "aptBusinessObjectDescription": "APT-INCSummary161193783832157",
        "businessPriority": "MEDIUM",
        "documentReviewImpacts": [
            {
                "impactedProductId": "132-PRODId",
                "impactedLots": "Lot123",
                "locationId": "GLN-1234567"
            }
        ],
        "documentReviewType": "COMPLIANCE_REPORT",
        "approvalDueDate": 1611997828936,
        "createdByPartner": true,
        "currentlyAssignedPartnerUsers": [
            "dab0a960-01d3-4fe1-aad2-696875beeea9"
        ],
        "currentlyAssignedCompanyUsers": [
            "dab0a960-01d3-4fe1-aad2-696875beeea9"
        ],
        "responsiblePartyAtCompany": "Random-Text161193783832151",
        "responsiblePartyAtPartner": "Random-Text161193783832151",
        "relatedProcesses": [
            "efb513dc-e9e6-4d37-909e-a9deddaca2af"
        ],
        "referenceIdentifiers": {
            "referenceTransactionType": "BILL_OF_LADING",
            "value": "GTIN-1161187176294956"
        },
        "aptDocumentBox": {
            "addAttachment": [
                {
                    "fileName": "fileName",
                    "fileSize": "fileSize",
                    "requestIdentifier": "requestIdentifier",
                    "visibilityType": "Public"
                }
            ],
            "aptComment": {
                "commentText": "This Comment is for testing custom action.",
                "visibilityType": "Public"
            },
            "removeAttachment": [
                "9d84028a-abcd-11eb-90b4-e933a8e8da5e"
            ]
        }
    }
}

Guidelines

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

Required. Indicates whether the request was successful.

Valid values:

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

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload –

Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The identifier for the new document review.  

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:add-document-review-response:v5",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "MPAIAJ"
    },
    "payload": {
        "id": "25ea02b4-8bdb-4197-b32c-925fe359abea"
    }
}

Errors

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

The error occurs if the source exceeds the maximum length of 255 characters.
responsiblePartyAtCompany Invalid user, must be a user of the owning company and a member of the specified process network. The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
responsiblePartyAtPartner Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
responsibleDepartmentAtCompany Invalid Responsible Department at [Owning Company], must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
responsibleDepartmentAtPartner Invalid Responsible Department at Partner Company, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
currentlyAssignedCompanyUsers Invalid user, must be a user of the owning company and a member of the specified process network. The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
currentlyAssignedPartnerUsers Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
businessPriority Business Priority is required. The error occurs if the source is empty or null.
businessPriority Invalid Business Priority, must be one of the supported values. The error occurs if not a valid value from the enumeration list.
aptBusinessObjectDescription Document Review Description is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
partnerId Partner is not a valid network node. The error occurs if the source is not a valid linked Partner company.
approvalDueDate Invalid approval Due Date, must be a valid date in the future. The error occurs if the source is a date that occurs before the document review was created.
relatedProcesses Invalid Process ID, must be a valid process ID within the specified process network. The error occurs if the source is not a valid process identifier within the Owner's network.
aptComment Comment is greater than max length.

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

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

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

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

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

Edit Document Review

Owners and Partners use this API to do the following:

  • Modify an existing document review with new, updated, or corrected information and documentation (e.g. adding an assigned user, fixing a typo).
  • Update the workflow state (e.g. manually transitioning the base state from ToDo to InReview to indicate that the document review has started).
Use the shared comment APIs to add, edit, or delete comments and file attachments. These APIs are shared across all document review process types.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:edit-document-review:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the document review 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 document review to modify.
  partnerCompany Object The identifier number and type for the Partner company associated with the document review.
    partnerId String The identifier for the Partner company.
    toIdType Enum

The Partner identifier type.

Valid values:

  • partnerMasterData
  • partnerLocationMasterData
  • companyMasterData
  • companyLocationMasterData
 

aptBusinessObjectSummary

 String A brief summary of the document review. Cannot exceed 255 characters.
  aptBusinessObjectDescription String A description of the document review request. Provides additional information to help the responsible parties complete the document review. Cannot exceed 5000 characters.
  responsiblePartyAtCompany String The identifier for the person from the Owner company that owns the document review from the Owner's side and is responsible for the completing the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  responsibleDepartmentAtCompany String The business area of the Owner company that is responsible for the completing the document review. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the document review is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for the document review is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for the document review is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the document review is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the document review is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the document review is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the document review is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the document review is part of an Operations team.
  • PACKAGING – The user responsible for completing the document review is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the document review is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the document review is part of a Project Management team.
  • PURCHASING – The user responsible for completing the document review is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the document review is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the document review is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the document review is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the document review is part of a Supply Chain team.
  responsiblePartyAtPartner String The identifier for the person from the Partner company that owns the document review from the Partner's side and is responsible for the completing the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  responsibleDepartmentAtPartner String The business area of the Partner company that is responsible for the completing the document review. If omitted, defaults to the job function of the responsible party, if defined for the user; otherwise is null.
  • BUSINESS_DEVELOPMENT – The user responsible for completing the document review is part of a Business Development team.
  • CLINICAL_RESEARCH – The user responsible for the document review is part of a Clinical Research team.
  • CONTRACT_MANAGEMENT – The user responsible for the document review is part of a Contract Management team.
  • CORPORATE_MANAGEMENT – The user responsible for completing the document review is part of a Corporate Management team.
  • CUSTOMER_SERVICE – The user responsible for completing the document review is part of a Customer Service team.
  • ENGINEERING – The user responsible for completing the document review is part of an Engineering team.
  • INFORMATION_TECHNOLOGY – The user responsible for completing the document review is part of an Information Technology (IT) team.
  • OPERATIONS – The user responsible for completing the document review is part of an Operations team.
  • PACKAGING – The user responsible for completing the document review is part of a Packaging team.
  • PRODUCTION_OR_MANUFACTURING – The user responsible for completing the document review is part of a Production team or Manufacturing team.
  • PROJECT_MANAGEMENT – The user responsible for completing the document review is part of a Project Management team.
  • PURCHASING – The user responsible for completing the document review is part of a Purchasing team.
  • QUALITY_ASSURANCE_CONTROL_OR_VALIDATION – The user responsible for completing the document review is part of a Quality Assurance (QA) team, Control team, or Validation team.
  • RESEARCH_DEVELOPMENT_OR_FORMULATION – The user responsible for completing the document review is part of a Research team, Development team, or Formulation team.
  • SALES_OR_MARKETING – The user responsible for completing the document review is part of a Sales team or Marketing team.
  • SUPPLY_CHAIN – The user responsible for completing the document review is part of a Supply Chain team.
  currentlyAssignedCompanyUsers Array List of one or more users at the Owner company assigned to the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  currentlyAssignedPartnerUsers Array List of one or more users at the Partner company assigned to the document review. If omitted, defaults to null (i.e. the system Unassigned user).
  businessPriority Enum

Required. The urgency with which the document review needs to be resolved.

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

Required.The date and time (in Unix epoch time in milliseconds) that the review process must be completed.

If omitted, the date is calculated by adding the default time (in hours) configured for the network to the time the review was added. For example, if the default approvalRequiredWithinHours is 336 and the current date is 01 Jun 2021, the approvalDueDate is calculated as 14 Jun 2021.
  initiatingCompany String The identifier number and type for the company initiating the request.
  documentReviewType Enum

The type of document being reviewed. Valid values:

  • AUDIT_REPORT – The document is an audit report.
  • COMPLIANCE_REPORT – The document is a compliance report.
  • STANDARD_OPERATING_PROCEDURE – The document is a standard operating procedure (SOP).
  • QUALITY_REVIEW – The document is a quality review.
  • PARTNER_COMPLIANCE_REPORT – The document is a partner compliance report.
  • PRODUCTION_PLANNING_DOCUMENT – The document is a production planning document.
  • LABEL_OR_ARTWORK – The document is a product label or artwork.
  • IMPLEMENTATION_PLAN – The document is an implementation plan.
  • MATERIAL_QUALITY_DOCUMENT – The document is related to the quality of materials.
  • SUPPLIER_CERTIFICATE – The document is a supplier certificate.
  • OTHER – The document type is user-defined. If this field is OTHER, use the otherDocumentReviewType to define the document type.
  otherDocumentReviewType String

If the documentReviewType is OTHER, this is the user-defined document type.

To prevent corrupted data, the otherDocumentReviewType should only be included in the request if the documentReviewType is OTHER.
  documentReviewImpacts Object

Contains information about the ways in which the review impacts production.
    impactedLots String The identifiers for the one or more lots of product associated with the review Cannot exceed 255 characters.
    impactedProductId String The identifier for the one or more products associated with the review.
    locationId String The identifier of the internal or external location that is impacted by the document review. The location must exist in Master Data.
    reviewReferenceIdentifier Array The internal reference identifiers used by the Owner or Partner's external system of record to identify the document review (e.g. Partner Review Number: QMS123).
     

 

reviewTransactionType

 Enum

The type of the reference identifier. Valid values:

  • INTERNAL_REVIEW_NUMBER – The reference ID is an internal review number.
  • PARTNER_REVIEW_NUMBER – The reference ID is a partner review number.
      value String

The value for the selected reviewTransactionType. Cannot exceed 72 characters.
  createdByPartner Boolean

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

Valid values:

  • true – Yes, the new document review is created by a user from the Partner.
  • false – No, the new document review is created by a user from the Owner.
  addDocumentBox Object

Conditionally required if newBaseState is InReview. Contains the document to be reviewed.
    addAttachment Array The file to attach to the incident as the escalation report. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String The name of the file to attach. Cannot exceed 255 characters.
      fileSize String The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the attached file. Determines whether process team members from the Partner company associated with the document review 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 document review can view the attached file.
      requestIdentifier String The identifier for the upload request provided by File Import and Export Manager.
  relatedProcesses Array

One or more processes to link to the document review as a related process (e.g. a change request that caused an incident, a previously occurring incident).

This must be an existing process in the Owner's network. Process team members from the Partner company can only view and link processes associated to their company.

    processId String The identifier for the related process.
    processType String The process type of the related process (e.g. incident).
    relationship String

The type of relationship the linked process has to the current document review.

Valid values:

  • RELATES_TO – The linked process is related to the current document review.
  • BLOCKS – The linked process prevents the current document review’s resolution.
  • BLOCKED_BY – The current document review prevents the linked process's resolution.
  • CONTAINS – The linked process is the parent of the current document review.
  • CONTAINED_BY – The current document review is the parent of the linked process.
  • DEPENDENT_ON – The linked process affects the current document review's resolution.
  • DEPENDENCY_FOR – The current document review affects the linked process's resolution.
  newBaseState String

Transitions the base workflow state of the document review from To Do to In Review. This cannot be reversed; requests in the In Review state can only be transitioned to Closed using the Close Document Review request.

The following must be true to update the document review state:

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

Valid value is InReview.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-document-review:v5",
         "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
         "appName": "agile-process-teams",
         "dataspace": "default"
    },
    "payload": {
        "id": "4ec1229a-d46f-4fc0-878f-188d318db55a",
        "responsiblePartyAtCompany": "a67d7261-33b1-4be6-9760-61ae8fe9eed3",
        "currentlyAssignedCompanyUsers": [
            "a67d7261-33b1-4be6-9760-61ae8fe9eed6"
        ],
        "referenceIdentifiers":[
            {
                "referenceTransactionType":"BILL OF LADING",
                "value": "FZ-1896155146"
            }
        ],
        "aptCommentBox":{
            "aptComment":{
                "commentText": "Re-assigning to Jen",
                "visibilityType": "InternalOnly"
            }
        }
    }
}

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-document-review-response:v5.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload –

Required. Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Conditionally required if the call is successful. The identifier for the edited document review.

Example

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

Errors

Element Error Message Description
authorization User does not have permission to edit Document Review. The error occurs if the user does not have the Add permission.
authorization User does not have permission to edit Document Review that are in a Closed state. The error occurs if the user does not have the Edit a Closed Review permission.
processNetworkId Process Network Id is required. The error occurs if the source is empty or null.
aptBusinessObjectSummary Incident summary is required. The error occurs if the source is empty or null.
aptBusinessObjectSummary Document Review summary is greater than max length.

The error occurs if the source exceeds the maximum length of 255 characters.
responsiblePartyAtCompany Invalid user, must be a user of the owning company and a member of the specified process network. The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
responsiblePartyAtPartner Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
responsibleDepartmentAtCompany Invalid Responsible Department at [Owning Company], must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
responsibleDepartmentAtPartner Invalid Responsible Department at Partner Company, must be one of the supported values. The error occurs if the source is not a valid value from the enumeration list.
currentlyAssignedCompanyUsers Invalid user, must be a user of the owning company and a member of the specified process network. The error occurs if the source is not a process team member from the Owner company of the network specified in the request.
currentlyAssignedPartnerUsers Invalid user, must be a user of the partner company and a member of the specified process network. The error occurs if the source is not a process team member from the Partner company of the network specified in the request.
businessPriority Invalid Business Priority, must be one of the supported values. The error occurs if not a valid value from the enumeration list.
aptBusinessObjectDescription Document Incident Description is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
approvalDueDate Invalid approval Due Date, must be a valid date in the future. The error occurs if the source is a date that occurs before the document review was created.
relatedProcesses Invalid Process ID, must be a valid process ID within the specified process network. The error occurs if the source is not a valid process identifier within the Owner's network.
newBaseState

Responsible Party at [Owning Company] must be assigned in order to move the Document Review to In Review.

The error occurs if the source equals InReview and responsiblePartyAtOwner is blank or null.
newBaseState Invalid Base State, only 'InReview' is valid.

The error occurs if the source does not equal InReview.

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

Close Document Review

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

The closed review transitions from its current state (either To Do or In Review) to a Closed state. Closed reviews can be edited or reopened by users with the requisite permissions.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:close-document-review: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 document review 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 document review to close.
  resolutionType Enum

Required. The type of resolution to assign to the closed quality document review. If this field is OTHER, use the otherResolutionType to define the resolution type.

  • If currentBaseState = InReview, valid values:
    • APPROVED – The document does not have any issues and the results of the document are accepted.
    • REJECTED – The document is not acceptable and the results are rejected.
    • OTHER – The resolution is user-defined in otherResolutionType.
  • If currentBaseState = ToDo, valid value:
    • NOT_APPLICABLE – The review was created in error.
    • OTHER – The resolution 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.
  closingStatement String Any final closing statement about the document review and its closure. Cannot exceed 5000 characters.
  aptCommentBox Object Required. Additional information to include in the closure of the document review.
    aptComment Array Required. The final comment to provide as the closing statement for the document review.
      commentText String Required. The closing statement text. Cannot exceed 5000 characters.
      visibilityType Enum

Conditionally required to submit the comment. Determines whether process team members from the Partner company associated with the incident can view the comment.

Valid values:

  • ownerOnly – No, only users from the Owner company can view the comment.

  • public – Yes, users from the Partner company associated with the incident can view the comment.
    addAttachment Array One or more relevant files to attach to the incident. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String Required. The name of the file. Cannot exceed 255 characters.
      fileSize String Required. The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the 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

Required. The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-document-review:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "762ee89b-b860-47ee-8d49-a042f46a3fc1",
        "reviewResolutionType": "NOT_APPLICABLE",
        "aptCommentBox": {
            "aptComment": {
                "isDeleted": false,
                "commentText": "PN3161189596322858",
                "visibilityType": "Public"
            },
            "addAttachment": [
                {
                    "fileSize": "fileSize",
                    "visibilityType": "Public",
                    "fileName": "fileName",
                    "requestIdentifier": "requestIdentifier"
                }
            ]
        }
    }
}

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-document-review-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. Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Conditionally required if the call is successful. The identifier for the closed document review.
  successMessage String Conditionally required if the call is successful. The message confirming that the document review is closed.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:close-document-review-response:v3",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "DQh24n"
    },
    "payload": {
        "id": "762ee89b-b860-47ee-8d49-a042f46a3fc1",
        "successMessage": "Document review closed successfully."
    }
}

Errors

Element Error Message Description
authorization User does not have permission to close document reviews. 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.
aptComment Closing Statement is required. The error occurs if the source is empty or null.
aptComment Closing Statement is greater than max length.

The error occurs if the source exceeds the maximum length of 5000 characters.
aptComment Closing Statement visibility type must be Public or Internal. The error occurs if the source is populated and visibilityType does not equal Public or Internal.
addAttachment Attachment file size is greater than max size.

The error occurs if the source exceeds the maximum file size of 25MB.
addAttachment Attachment visibility type must be Public or Internal. The error occurs if the source is populated and visibilityType does not equal Public or Internal.

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

Reopen Document Review

Owners and Partners with the Reopen Incident permission use this API to reopen a closed document review (the base state updates from Closed to In Review).

The response returns the identifier for the reopened review with all information intact. Reopened document reviews can only be returned to the In Review state. They cannot be transitioned to To Do.

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-document-review: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 document review 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 document review to reopen.
  aptCommentBox Object Any additional information about the document review being reopened.
    aptComment Array One or more comments about the document review or explanations of the attachments that the user reopening the document review wants to include.
      commentText String Required. The comment 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.
    addAttachment Array One or more relevant files to attach to the incident. Supported file formats are DOC, TXT, CSV, JPEG, PNG, and PDF.
      fileName String Required. The name of the file. Cannot exceed 255 characters.
      fileSize String Required. The size of the file. Cannot exceed 25MB.
      visibilityType Enum

Conditionally required to submit the 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

Required. The identifier for the upload request provided by File Import and Export Manager.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-document-review:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "a70ca41a-ef4d-4b5a-b243-26cff72434ce",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "id": "762ee89b-b860-47ee-8d49-a042f46a3fc1",
        "aptCommentBox": {
            "aptComment": {
                "commentText": "PN3161189596322858",
                "visibilityType": "Public"
            },
            "addAttachment": [
                {
                    "fileSize": "fileSize",
                    "visibilityType": "Public",
                    "fileName": "fileName",
                    "requestIdentifier": "requestIdentifier"
                }
            ]
        }
    }
}

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-document-review-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload –

Required. Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Conditionally required if the call is successful. The identifier for the reopened document review.
  successMessage String Conditionally required if the call is successful. The message indicating the review is reopened document review.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:reopen-document-review:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "p7BC3X"
    },
    "payload": {
        "id": "762ee89b-b860-47ee-8d49-a042f46a3fc1",
        "successMessage": "Document review reopened successfully."
    }
}

Errors

Element Error Message Description
authorization User does not have permission to reopen document reviews. 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.