Delete typeOneResource

DELETE 
https://apis.<domain>/resources/typeOneResources/:ids/

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Delete typeOneResource.

Authorization Action:

resource:typeOneResources:delete

Request

Path Parameters

ids stringrequired

Comma-separated globally unique ids (UUID4)

Responses

200

OK

application/vnd.api+json

Schema

Schema

meta object
property name* any

Example (from schema)

{
  "meta": {}
}

202

Accepted for asynchronous processing

application/vnd.api+json

Schema

Schema

data object
type typerequired
The type member is used to describe resource objects that share common attributes and relationships.
id idrequired
Each resource object’s type and id pair MUST identify a single, unique resource.
attributes object
relationships object
links object
oneOf
title
meta object
property name* any

Example (from schema)

{
  "data": {
    "type": "string",
    "id": "string",
    "attributes": {},
    "relationships": {},
    "links": {},
    "meta": {}
  }
}

204

no content

401

not authorized

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
id string
status string
links object
oneOf
title
code string
title string
detail string
source object
pointer string
A JSON Pointer to the associated entity in the request document [e.g. /data for a primary data object, or /data/attributes/title for a specific attribute.
parameter string
A string indicating which query parameter caused the error.
meta object
property name* any
]
meta object
property name* any
jsonapi object
The server's implementation
version string
meta object
property name* any
links object
oneOf
title

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "status": "string",
      "links": {},
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string",
        "meta": {}
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "string",
    "meta": {}
  },
  "links": {}
}

404

Resource does not exist

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
id string
status string
links object
oneOf
title
code string
title string
detail string
source object
pointer string
A JSON Pointer to the associated entity in the request document [e.g. /data for a primary data object, or /data/attributes/title for a specific attribute.
parameter string
A string indicating which query parameter caused the error.
meta object
property name* any
]
meta object
property name* any
jsonapi object
The server's implementation
version string
meta object
property name* any
links object
oneOf
title

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "status": "string",
      "links": {},
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string",
        "meta": {}
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "string",
    "meta": {}
  },
  "links": {}
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X DELETE 'https://apis.<domain>/resources/typeOneResources/:ids/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

ids — pathrequired