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 TopResponse
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Organizations
Type:
object
The collection of organizations.
Show Source
-
items:
array items
-
totalResults:
integer
The total number of organizations retrieved.
Nested Schema : Organization
Type:
object
Title:
Show Source
Organization
-
label(required):
string
Title:
Label
Minimum Length:1
Maximum Length:255
The organization label specified in the request. -
name:
string
Title:
Name
The name of the organization in the user's preferred language. This field is returned only by using the GET method. -
translations(required):
array Translations
Title:
Translations
An array of translations associated with the name of the organization. -
type(required):
string
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:
Show Source
object
-
language(required):
string
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.
-
languageISO:
string
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)
-
name(required):
string
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.