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/json
• application/schema+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
  The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').

  See Supported Language Codes to view the values that are supported.

• languageISO: string
  The ISO language code (for example, 'en-US').
• name(required): string
  The specified name of the property translated to the language code available in the system.

{
    "properties":{
        "language":{
            "description":"The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').<p>See <a href='OFSC_Supported_Language_Codes.html'>Supported Language Codes</a> to view the values that are supported.</p> ",
            "type":"string"
        },
        "languageISO":{
            "description":"The ISO language code (for example, 'en-US').",
            "type":"string"
        },
        "name":{
            "description":"The specified name of the property translated to the language code available in the system.",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

Back to Top