Skip to main content

contexts (POST)

Overview

 

  • REST Method: POST
  • Method Access: public

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 Read access to the page is required
Not Found 404 The requested page could not be found

Message Format

Input

<contexts>
	<context>
		<id>{text}</id>
		<description>{text}</description>
	</context>
	...
</contexts>

Output

Returns the added context IDs

<contexts>
	<context>
		<id>{text}</id>
		<description>{text}</description>
	</context>
	...
</contexts>

Implementation Notes

If the context ID already exists, then the description is updated.

You can add multiple Context ID / Description pairs at the same time

Description is not required

  • Was this article helpful?