Payload Management Public Service API
* This is a temporary page that will be reformatted and updated in the next several days *
Description: To get available supported repositories with payload counts
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads Methods: GET Return Value: - The JSON which contains the list of file repositories and file counts. Example: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads Return Value: [
{
"Count": 0,
"RepositoryName": "Responses"
},
{
"Count": 49,
"RepositoryName": "Requests"
},
{
"Count": 0,
"RepositoryName": "Processed"
},
{
"Count": 3,
"RepositoryName": "Invalid"
}
]
Description: To get payload file names in repository
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}?filter={filter}&page_size={page size}&page={page index}&order={order} Methods: GET Variables: • {repository} - The name of repository Type: Required Allowed values: “responses”, “requests”, “processed”, “invalid” Arguments: • {filter} - To filter the return values list Type: Optional Syntax: collection of {column_name}:{comparator}:{value} separated by ‘;’ symbol o coumn_name allowed values: file_name, lock_status, date_created, date_modified o comparator allowed values: Equal, Greater, GreaterEqual, Less, LessEqual, Contains, StartsWith, EndsWith o value: the value to use with comparator column_name and comparator allowance table COLUMN NAME ALLOWED VALUES ALLOWED COMPARATORS FILE_NAME Any string data Equals, Contains, StartsWith, EndsWith LOCK_STATUS Locked, Unlocked, All Equals DATE_CREATED Any valid date in format MM-dd-yyyy Equals, Greater, GreaterEqual, Less, LessEqual DATE_MODIFIED Any valid date in format MM-dd-yyyy
• {page_size} – The count of the items in the page returned data Type: Optional Allowed values: Zero and positive integer values (first index is 0) • {page} – The page index of returned data Type: Optional Allowed values: Zero and positive integer values (first index is 0) • {order} – The returned data order Type: Optional Syntax: {column_name}:{order_type} o column_name allowed values: file_name, lock_status, date_created, date_modified
order_type allowed values: Ascending, Descending Example: order=date_created:Descending
Return Value: The JSON which contains the list of file names. Examples: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/processed? filter=date_created:GreaterEqual:7-28-2019;date_created:Less:8-31-2019;date_modified:GreaterEqual:8-25-2019;date_modified:Less:9-28-2019;file_name:Contains:test1;lock_status:Equal:Unlocked&page_size=10&page=1&order=Descending
Return Value: {
"result": [
{
"created": "2019-09-03 16:56:04",
"file_name": "standard_user-033-190903161430419-00001.1.1_190903165601809",
"lock_status": "Unlocked",
"modified": "2019-09-03 16:56:18"
},
{
"created": "2019-09-03 16:56:04",
"file_name": "standard_user-033-190903161430419-00002.1.1_190903165601809",
"lock_status": "Unlocked",
"modified": "2019-09-03 16:56:23"
},
{
"created": "2019-09-03 16:56:04",
"file_name": "standard_user-033-190903161430419-00003.1.1_190903165601809",
"lock_status": "Unlocked",
"modified": "2019-09-03 16:56:24"
},
{
"created": "2019-09-03 16:56:04",
"file_name": "standard_user-033-190903161430419-00004.1.1_190903165601809",
"lock_status": "Unlocked",
"modified": "2019-09-03 16:56:17"
},
{
"created": "2019-09-03 16:58:54",
"file_name": "standard_user-033-190903161430419-00050.1.1_190903165852480",
"lock_status": "Unlocked",
"modified": "2019-09-03 16:59:08"
}
]
}
Description: To retrieve payload from repository
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name} Methods: GET Variables: {repository} - The name of repository Type: Required Allowed values: “responses”, “requests”, “processed”, “invalid” {payload_name} - The name of the payload Return Value: The payload body in xml format. Note: The payload must be locked before retrieval. Examples: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/invalid/Standard_USER-033-190611180112791-00005.1.1_190611180112791_190702152755918.xml Method: GET Return Value: The payload XML
Description: To send payload to repository
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository} Methods: POST Variables: {repository} - The name of repository Type: Required Allowed values: “responses” HTTP Body: Must contain the payload data Return Value: The payload file name. Note: Only works with “responses” repository Examples: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/responses Method: POST Return Value: { “result”: “Standard_USER-013-190517122842162-00005.1.1_190723173942045.tmp” }
Description: To lock, unlock and finalize the payload in repository
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name}?operation={operation} Methods: PATCH Variables: {repository} - The name of repository Type: Required Allowed values: “responses”, “requests”, “processed”, “invalid” {payload_name} - The name of the payload Arguments: {filter} - To filter the return values list Type: Required Allowed values: “lock”, “unlock”, “finalize” Acceptable scope: “lock” and “unlock” values allowed to use only for repositories - “requests”, “invalid”, “finalize” value allowed to use only for repository - “responses” Examples: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/invalid/Standard_USER-033-190611180112791-00005.1.1_190611180112791_190702152755918.xml?operation=lock Return Value: { “result”: “true” }
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/responses/Standard_USER-013-190517122842162-00005.1.1_190723173942045.tmp?operation=finalize Return Value: { “result”: “Standard_USER-013-190517122842162-00005.1.1_190723173942045.xml” }
Description: To delete payload from repository
URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name} Methods: DELETE Variables: {repository} - The name of repository Type: Required Allowed values: “responses”, “requests”, “processed”, “invalid” {payload_name} - The name of the payload Examples: URL: https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/invalid/Standard_USER-033-190611180112791-00005.1.1_190611180112791_190702152755918.xml?operation=lock Return Value: { “result”: “true” }