• Register

Organizations

Resource URI

/organizations

Items in curly braces represent variables.

Description

Organizations allow for group-level Access Control.

Resource Schema

Property Characteristics
id Type string
Sub-type
Create Rule Ignored
Update Rule Required (if not in context)
Fetch Rule Implicit
Description Object identifier (Organization UUID).
name Type string
Sub-type
Create Rule Required
Update Rule Optional
Fetch Rule Implicit
Description Organization name.
created Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was created.
updated Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was last updated.
suborganizations Type array
Sub-type Organization
Create Rule Optional
Update Rule Optional
Fetch Rule Explicit
Description Members that belong to the Organization.

fetch all [GET]

Retrieves collection of Organizations belonging to the given Area.

Note: To ensure a consistent API response (which maintains a proper hierarchical order of Organisations and Sub-organisations) when using the Limit parameter in your API request URI, TIBCO recommends that you always add sort=created:asc in your API Request.

Important!

For this to work properly, the following conditions should be met:

  • User making the call should have complete permissions for both parent and child organisations. 
  • The response would be consistent as long as limit parameter is used in conjunction with sort=created:asc. Usage of any other parameter (offset, filter) in the request URI can lead to an undesirable response.

Refer to the following example:

curl -v -k -H 'Authorization: Bearer 9542akew6qtc4f43rwt4vder' 'https://api.example.com/v3/rest/organizations?limit=2&sort=created:asc'

Parameters

Parameter Required Type Description
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0.

Returns

Success

Array of Organizations for the Area If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

fetch [GET]

Retrieves the identified Organization.

Parameters

Parameter Required Type Description
organizationId true string Organizationidentifier.
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0.

Returns

Success

Array of Organization for the Area If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

create [POST]

Creates a new Organization in the given Area.

Parameters

Parameter Required Type Description
organization true object Organization object

Returns

Success

Organization as created If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

update [PUT]

Updates the identified Organization.

Parameters

Parameter Required Type Description
organizationId true string Organizationidentifier.
member true object Member object

Returns

Success

Organization as persisted If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

delete [DELETE]

Deletes the identified Service Definition.

Parameters

Parameter Required Type Description
organizationId true string Organizationidentifier.

Returns

Success

Empty response

Failure

Array of validation responses

Examples

version 3 as of 2 years ago by jpadre

Docs Navigation