DokuWiki

This is an old revision of the document!

payloads:delete_payload

The payloads web service is a REST structured service that derives its functionality based on syntax used when calling the web service. To delete a payload from a repository, call the payloads web service with a repository name and the payload file name.

Important: The payload must be locked prior to retrieving it. Please note that the method being used is DELETE.

Purpose: Delete A Payload From A Repository.

Request Endpoint

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

Variables:

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

Request Body

N/A

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/retrieve/standard_testagent1-202007140415-00025.1.1_200723151419729.xml

Sample Response (Note: Most of the Base64 image text was removed for readability.)

Status Code: 200

{
    "result": "true"
}

OR

Status Code: 500 (When an error occurs.)

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