Skip to main content

DELETE Wrapper

Overview


The following table contains important information about the DELETE method for managing the process of removing the specific wrapper.

DELETE Wrapper
MethodDELETE
URL or Endpoint/api/projects/projectId/wrappers/id
HeadersAuthorization
Parametersid,projectId
Request BodyNot applicable

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter NameId
MandatoryYes
Typestring
DescriptionUnique Id of the wrapper.
projectId Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

The DELETE method doesn't contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": true,
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[]Indicates if there was an error
messagesarray[]Returns the response message from back-end
resultbooleanReturns the response object
resultInfostringReturns extra information about the result
statusCodeinteger($int32)Returns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed