Get organizations

get

/rest/ofscMetadata/v1/organizations

This operation retrieves a collection of organizations.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Organizations
Type: object
The collection of organizations.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Organization
Type: object
Title: Organization
Show Source
  • Title: Label
    Minimum Length: 1
    Maximum Length: 255
    The organization label specified in the request.
  • Title: Name
    The name of the organization in the user's preferred language. This field is returned only by using the GET method.
  • Translations
    Title: Translations
    An array of translations associated with the name of the organization.
  • Title: Type
    Allowed Values: [ "contractor", "inhouse" ]
    The type of the organization.
Nested Schema : Translations
Type: array
Title: Translations
An array of translations associated with the name of the organization.
Show Source
Nested Schema : Translation
Type: object
Show Source
  • This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
  • This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top