Delivering a Regulatory Submission Acknowledgement to the Acknowledgement Interpreter for Processing
The ProcessAcknowledgement action processes an acknowledgement received from a regulatory agency for a non-revisable or revisable regulatory submission. The action can deliver the acknowledgement content either in a stream type or String type format. The raw content that the action delivers is processed in the default acknowledgement interpreter in the Windchill instance.
Example: Delivering a Generic Regulatory Submission Acknowledgement
This example shows you how to deliver a stream type of regulatory submission acknowledgement received for a revisable regulatory submission. The following example shows you how to deliver the regulatory submission acknowledgement, “Acknowledgement 1”.
Step 1: To retrieve the details such as Name, Number, RemoteIdentifier, and type of the existing regulatory submission to which you want to upload the “Acknowledgement 1” content, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256705')
Step 2: Specify the attribute values retrieved in Step 1 in the Acknowledgement1Body.json file. The format of the “Acknowledgement 1” JSON file is as follows:
Acknowledgement 1:
{
"ackNumber": 1,
"typeName": "PTC.RegMstr.RPSType",
"name": "RPS_1704980304",
"number": "00203",
"remoteIdentifier": "RI_1704980304"
}
Step 3: To upload the content to the regulatory submission, use the following POST request along with the request body:
URI
POST /Windchill/servlet/odata/RegMstr/ProcessAcknowledgement
Request Headers
Content-Type: form-data
Request Body
-----------------------------boundary
Content-Disposition: form-data; name="SubmissionType" PTC.RegMstr.RPSType
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementName" Acknowledgement1.json
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementBody"; filename="Acknowledgement1Body.json"
----------------------------boundary
The request returns the 201 status code.
The Acknowledgement1 file of the ACKNOWLEDGEMENT1 category is added to the Regulatory Content table of the regulatory submission. The table is available in the Details tab on the information page of the regulatory submission.
The latest version of the regulatory submission is updated with the remote identifier that is specified in the Acknowledgement1.json file.
Step 4: To retrieve the regulatory content for the revisable regulatory submission, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256705')/RegulatoryContent
The request returns the regulatory content associated with the specified regulatory submission, including the content of the ACKNOWLEDGEMENT1 category.
Example: Delivering a Successful Regulatory Submission Acknowledgement
The following example shows you how to deliver a successful “Acknowledgement 2” for a revisable regulatory submission.
Step 1: To retrieve the details such as RemoteIdentifier and type of the existing regulatory submission to which you want to upload the “Acknowledgement 2” content, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256725')
Step 2: Specify the attribute values retrieved in Step 1 in the Acknowledgement2SuccessBody.json file. The format of the “Acknowledgement 2” JSON file is as follows:
Acknowledgement 2 ("Success"):
{
"ackNumber": 2,
"typeName": "PTC.RegMstr.RPSSite",
"remoteIdentifier": "RI_1704984853",
"certificationNumber": "CN-1704984853",
"expirationDate": "2024-01-30 00:00:00",
"result": "SUCCESS"
}
Step 3: To upload the content to the regulatory submission, use the following POST request along with the request body:
URI
POST /Windchill/servlet/odata/RegMstr/ProcessAcknowledgement
Request Headers
Content-Type: form-data
Request Body
-----------------------------boundary
Content-Disposition: form-data; name="SubmissionType" PTC.RegMstr.RPSSite
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementName" Acknowledgement2.json
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementBody"; filename="Acknowledgement2SuccessBody.json"
----------------------------boundary
The request returns the 201 status code.
The Acknowledgement2 of the ACKNOWLEDGEMENT2 category is added to the Regulatory Content table of the regulatory submission.
The latest version of the regulatory submission is updated with the remote identifier, certificate number, and expiration date specified in the Acknowledgement2.json file.
Step 4: To retrieve the regulatory content for the revisable regulatory submission, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256725')/RegulatoryContent
The request returns the regulatory content associated with the specified regulatory submission, including the content of the ACKNOWLEDGEMENT2 category.
Example: Delivering a Failed Regulatory Submission Acknowledgement
The following example shows you how to deliver the acknowledgement if a failed “Acknowledgement 2” is received for the revisable regulatory submission.
Step 1: To retrieve the details such as RemoteIdentifier and type of the existing regulatory submission to which you want to upload the “Acknowledgement 2” content, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256725')
Step 2: Specify the retrieved attribute values in the Acknowledgement2FailureBody.json file. The format of the “Acknowledgement 2” JSON file is as follows:
Acknowledgement 2 ("Failure"):
{
"ackNumber": 2,
"typeName": "PTC.RegMstr.RPSSite",
"remoteIdentifier": "RI_1704985272",
"certificationNumber": "CN-1704985272",
"expirationDate": "2024-01-30 00:00:00",
"result": "FAILURE",
"errorCodes": [
{
"errorCode": "400",
"errorMessage": "A regulatory submission error has occurred."
},
{
"errorCode": "500",
"errorMessage": "One or more regulatory submission attributes exceed."
}
]
}
Step 3: To upload the content to the regulatory submission, use the following POST request along with the request body:
URI
POST /Windchill/servlet/odata/RegMstr/ProcessAcknowledgement
Request Headers
Content-Type: form-data
Request Body
-----------------------------boundary
Content-Disposition: form-data; name="SubmissionType" PTC.RegMstr.RPSSite
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementName" Acknowledgement2.json
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementBody"; filename="Acknowledgement2FailureBody.json"
----------------------------boundary
The request returns the 201 status code.
The Acknowledgement2 of the ACKNOWLEDGEMENT2 category is added to the Regulatory Content table of the regulatory submission.
The 400 and 500 error codes along with their corresponding messages are added to the Acknowledgement Messages table available in the Details tab.
The latest version of the regulatory submission is updated with the remote identifier, certificate number, and expiration date specified in the Acknowledgement2.json file.
Step 4: To retrieve the regulatory content for the revisable regulatory submission, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256725')/RegulatoryContent
The request returns the regulatory content associated with the specified regulatory submission, including the content of the ACKNOWLEDGEMENT2 category.
Similarly, a String type of regulatory submission acknowledgement received for a non-revisable or revisable regulatory submission can be delivered using the ProcessAcknowledgement action.
Example: Delivering a String type of Regulatory Submission Acknowledgement
The following example shows you how to deliver a String type of regulatory submission acknowledgement “Acknowledgement 1”, received for a revisable regulatory submission.
Step 1: To retrieve the details such as Name, Number, RemoteIdentifier, and type of the existing regulatory submission to which you want to upload the “Acknowledgement 1” content, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256777')
Step 2: Specify the attribute values retrieved in Step 1 in the Acknowledgement1Body.json file. The format of the “Acknowledgement 1” JSON file is as follows:
Acknowledgement 1:
{
"ackNumber": 1,
"typeName": "PTC.RegMstr.RPSType",
"name": "RPS_1704980364",
"number": "00208",
"remoteIdentifier": "RI_1704980364"
}
Step 3: To upload the content to the regulatory submission, use the following POST request along with the request header and request body:
URI
POST /Windchill/servlet/odata/RegMstr/ProcessAcknowledgement
Request Headers
Content-Type: form-data
Request Body
-----------------------------boundary
Content-Disposition: form-data; name="SubmissionType" PTC.RegMstr.RPSType
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementName" Acknowledgement1.json
----------------------------boundary
Content-Disposition: form-data; name="AcknowledgementBody"
{
"ackNumber": 1,
"typeName": "PTC.RegMstr.RPSType",
"name": "RPS_1704980364",
"number": "00208",
"remoteIdentifier": "RI_1704980364"
}
----------------------------boundary
Optionally, you can upload the content to the regulatory submission using the following request header and request body:
Request Headers
Content-Type: raw
Request Body
{
"AcknowledgementName": "Acknowledgement 1",
"SubmissionType": "PTC.RegMstr.RPSType",
"AcknowledgementBody": "{\"ackNumber\": 1,\"typeName\": \"PTC.RegMstr.RPSType\",\"name\": \"RPS_1704980364\",\"number\": \"00208\",\"remoteIdentifier\": \"RI_1704980364\"}"
}
The request returns the 201 status code.
The “Acknowledgement 1” of the ACKNOWLEDGEMENT1 category is added to the Regulatory Content table of the regulatory submission. The table is available in the Details tab on the information page of the regulatory submission.
Step 4: To retrieve the regulatory content for the revisable regulatory submission, use the following GET request:
URI
GET /Windchill/servlet/odata/RegMstr/RegSubmission2('OR:com.ptc.qualitymanagement.regmstr.RegSubmission2:256777')/RegulatoryContent
The request returns the regulatory content associated with the specified regulatory submission, including the content of the ACKNOWLEDGEMENT1 category.
The action also delivers a successful or failed String type of acknowledgement similar to a stream type of acknowledgement.