 |
API Documentation
|
|
API Documentation
|
where {orgGroupId} is the ID of an organisation.
POST - adds a new plan to an organisation (specified by orgGroupId).GET - retrieves a list of information for all plans configured within an organisation (specified by orgGroupId).Note: The
GETmethod takes no parameters.
This API endpoint serves a number of purposes:
orgGroupId). orgGroupId).This API endpoint supports requests utilizing Cocoon Data user accounts with the following roles (as described in the Organisation Administrator's Guide) and conditions:
{orgGroupId} in the request's URL.The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.
The appropriate access token as the Bearer token:
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...The following header is required if the body of the request has a JSON object:
Content-Type: application/jsonThe following required parameters must be sent in the body of the POST request, each as individual members of a JSON object:
{orgGroupId} in the request's URL. The following optional parameters can also be sent in the body of the POST request, each as individual members of the JSON object that includes the Required POST-request parameters above:
true) or not (false) the new plan being added to the organisation (specified by {orgGroupId} in the URL) will be flagged as the default plan for this organisation. The following optional parameters can be sent in the URL of the GET request:
0 to 100, representing the maximum number of items to be returned in the response, where an individual item is information about a plan configured in the organisation (specified by {orgGroupId} in the request's URL). If this parameter is omitted, then its value is 0 by default, which does not apply restrictions to the number of items returned in the response. {orgGroupId} in the URL) returned in the response. Calls to this API endpoint may amount to potentially large numbers of items being returned from the Cocoon Data Platform. Since the order of these items in the response could differ significantly, based on the values of the orderBy and sortBy parameters below, this offset parameter provides pagination for items returned in responses, allowing items to be retrieved from any count greater than 0 (i.e. the first item returned in a response). If this parameter is omitted, then its value is 0 by default. {orgGroupId} in the URL) are returned in the response. This parameter orders items according to the value of the sortBy parameter specified below. Ordering items can be in either ascending alphanumeric order (by specifying the value ASC for this parameter) or descending order (by specifying the value DESC). If this parameter is omitted, then its value is ASC by default. {orgGroupId} in the URL) returned in the response will be sorted. Valid field values for this parameter include: name - the name of the plan and description - the description of the plan. quota - the description of the plan. Note: Due to a bug, if the limit URL parameter above is not specified with a value >
0, then none of the other parameters submitted in theGETrequest have any impact on items returned in the response.
If the request succeeded, then an HTTP response status 200 OK is returned.
For successful requests only, a JSON-formatted response containing the following members is also returned:
{orgGroupId} in the request's URL), where these groups have been filtered by any parameters submitted in the request. Each element of this array contains information about one of these plans (represented as an object containing the following members unless otherwise stated). true) or not (false) this plan is flagged as the default plan for this organisation. {orgGroupId} in the request's URL) that can be returned in the response. 