DokuWiki

This is an old revision of the document!

payloads:send_payload

The payloads web service is a REST structured service that derives its functionality based on syntax used when calling the web service.

To send a payload to a repository, format the body of the request with the XML data and then call the POST method. When the call completes, the name of the payload formatted with a .tmp file extension will be returned.

Important: This function places the XML that is posted into the specified repository using a .tmp file extension. Once the operation is completed successfully, the finalize function must be called to rename the extension from .tmp to .xml

Purpose: Retrieve A Payload From A Repository.

Request Endpoint

Method	URL
GET	https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name}

Variables:

Variable	Usage	Description
{repository}	Required	The name of the repository

Request Body

The payload formatted as an XML document.

Request Headers

Key	Value
access_token	{soft-token}

JSON Request Parameters

N/A

Notes:

Any condition that results in an unsuccessful call to the payloads web service will produce a JSON formatted response with a code and message property populated.

Sample Request

Endpoint:

https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/send

Sample Response

Status Code: 200

{
"result": "Standard_USER-013-190517122842162-00005.1.1_190723173942045.tmp"
}

OR

Status Code: 500 (When an error occurs.)

{
    "Exception": {
        "Code": "PayloadFileLockError",
        "Message": "The payload standard_testagent1-202007140415-00003.1.1_200723151458170.xml not locked."
    }
}