Jump to

• Request
• Response

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

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Organizations

Type: object

The collection of organizations.

Show Source

• items: array items
• totalResults: integer
  The total number of organizations retrieved.

{
    "description":"The collection of organizations.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Organization"
            }
        },
        "totalResults":{
            "description":"The total number of organizations retrieved.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Organization
  Title: Organization

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Organization"
    }
}

Nested Schema : Organization

Type: object

Title: Organization

Show Source

• 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.

{
    "type":"object",
    "title":"Organization",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Label",
            "description":"The organization label specified in the request."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the organization in the user's preferred language. This field is returned only by using the GET method."
        },
        "type":{
            "type":"string",
            "enum":[
                "contractor",
                "inhouse"
            ],
            "title":"Type",
            "description":"The type of the organization."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"An array of translations associated with the name of the organization."
        }
    },
    "required":[
        "label",
        "type",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

An array of translations associated with the name of the organization.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"An array of translations associated with the name of the organization."
}

Nested Schema : Translation

Type: object

Show Source

• 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

{
    "properties":{
        "language":{
            "description":"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.",
            "type":"string"
        },
        "languageISO":{
            "description":"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)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• 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.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top