DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

==== 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:** <color #22b14c>**Retrieve A Payload From A Repository.**</color>

<color #7092be>Request Endpoint</color>

{{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Method ^ URL ^
| GET | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name}</nowiki> |

**Variables:**

{{tablelayout?colwidth="175px,75px,400px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Variable ^ Usage ^ Description ^
| {repository} | Required | The name of the repository |

<color #7092be>Request Body</color>

The payload formatted as an XML document.

<color #7092be>Request Headers</color>

{{tablelayout?colwidth="150px,450px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Key ^ Value ^
| access_token | {soft-token} |

<color #7092be>JSON Request Parameters</color>

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.

<color #7092be>Sample Request</color>

**Endpoint:**

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

<color #7092be>Sample Response</color>

Status Code: 200

<code json>
{
"result": "Standard_USER-013-190517122842162-00005.1.1_190723173942045.tmp"
}

</code>

**OR**

Status Code: 500  (When an error occurs.)

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

----

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International