WoodWing Help Center

Elvis 6 REST API - remove relation

Elvis 6 REST API - remove relation

POST

http://yourserver.com/services/removeRelation
    ?relationIds=<comma-delimited relation ids>

What does it do?

Remove one or more relations between assets.

POST requests only

This REST API only accepts POST requests, not GET requests. Also, the POST request needs to include a cross-site request forgery (csrf) token.

The csrf token is a unique code which, by including it in the request, also makes the POST request unique and therefore much more secure.

The csrf token is obtained by first logging in to Elvis Server through a POST request. The response that is received will include the csrf token which can then be used in subsequent POST requests as a http header:

"X-CSRF-TOKEN: <some_csrf_token>"

For more information including examples, see Elvis 6 REST API - Performing a POST request with a csrf token.

Parameters

relationIds

A comma-delimited list of relation ids to be removed. To find the relation ids, use a relation search.

Required.

Return value

The operation returns an empty 200 OK status.

If the operation fails, an error page with a 500 error status will be returned.

Examples

The following removes two relations:

update

http://demo.elvisdam.com/services/removeRelation
    ?relationIds=Cbg9-_ukKEZARORmuaCsn3,ATT8CDno4QCB59QHmjwnfS

Document history

  • 27 July 2017: Added section 'Post requests only'.
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.