Jump to

• Request
• Response
• Examples

Get an organization by the specified identifier

get

/api/v1/organizations/{orgShortName}

{basePath}/organizations/tfoinc

The API returns details about a specific organization.

Request

Supported Media Types

• application/json

Path Parameters

• orgShortName(required): string
  Organization Identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Organization

Type: object

Title: Organization

An organization is the overarching organizational entity for a specific customer in Oracle Food and Beverage Cloud Products. An organization includes one or more locations.

Show Source

• name(required): string
  The organization name.

  Example: The Food Organization Inc
• orgShortName(required): string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: [A-Za-z0-9]

  The organization identifier.

  Example: tfoinc

{
    "title":"Organization",
    "description":"An organization is the overarching organizational entity for a specific customer in Oracle Food and Beverage Cloud Products. An organization includes one or more locations.\n",
    "required":[
        "orgShortName",
        "name"
    ],
    "type":"object",
    "properties":{
        "orgShortName":{
            "description":"The organization identifier.",
            "example":"tfoinc",
            "type":"string",
            "minLength":1,
            "maxLength":10,
            "pattern":"[A-Za-z0-9]"
        },
        "name":{
            "description":"The organization name.",
            "example":"The Food Organization Inc",
            "type":"string"
        }
    },
    "example":{
        "orgShortName":"tfoinc",
        "name":"The Food Organization Inc"
    }
}

Example:

{
    "orgShortName":"tfoinc",
    "name":"The Food Organization Inc"
}

400 Response

400 Bad Request

Body ()

Root Schema : OrganizationApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).

Show Source

• details: string
  A human-readable explanation specific to this occurrence of the problem.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
• title: string
  A short, human-readable summary of the problem type.
• type: string
  A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

401 Response

401 Unauthorized

403 Response

403 Forbidden

404 Response

404 Requested resource not found

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:

    {
      "orgShortName": "tfoinc",
      "name": "The Food Organization Inc"
    }

Back to Top