Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint ID:2105
Method:

Status
colourGreen
titlePUT

URL:

/permissions/entity/id/{entityID}/terms/{termsID}/withdraw

/permissions/entity/ext-key/{ext-key}/{ext-type}/terms/{termsID}/withdraw


entityID

dialogportal™ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

termsIDA GUID string identifier for the terms
Request body:
Code Block
{
   "sourceID": 234,
   "reason": "Abc"
}

Response body:
Code Block[ { "isActive": false, "isWithdrawn": true, "terms": { "id": "1f788c79-7dde-407f-a976-6b58b39aa79d", "version": "1.2", "isMostRecentVersion": false }, "acceptance": { "timestamp": "utc timestamp", "sourceID": 123 }, "withdrawal": { "timestamp": "utc timestamp", "

JSON data describing the terms withdrawal

Required fields
 sourceIDThe ID of the withdrawal source

reasonA reason for the withdrawal


Code Block
{
    "sourceID": 234,
   
     "reason": "Abc"
 
    }
   }
]}



Span
stylewhite-space:nowrap

Response body:


None

Status codes:200204Entity permission was withdrawn
404

The entity or terms were not found.

The following sub codes may be returned:

404.1Entity not found
404.2External entity reference could not be found
404.4Terms not found


...