Jump to

• Request
• Response

Get Standard Usage Identifier

get

/api/utilitiesAdmin/{version}/standardUsageIdentifier/{id}

Gets details of a specific Standard Usage Identifier record by its id field.

Request

Path Parameters

• id(required): string
  Value of resource id field. Example: KW-- (for admin entity 'standardUsageIdentifier')
• version(required): string
  API version. Example: v1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Match One Schema

Show Source

• object standardUsageIdentifier

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/standardUsageIdentifier"
        }
    ]
}

Nested Schema : standardUsageIdentifier

Type: object

Show Source

• active: boolean
  Boolean that is true if active, false if inactive.
• color: string
  Color for display in graphs and charts.
• description(required): string
  Description
• id(required): string
  Id of the Standard Usage Identifier record.
• unitOfMeasure: string
  Unit of Measure
• usageIdentifier(required): string
  Usage Identifier

{
    "type":"object",
    "properties":{
        "color":{
            "type":"string",
            "description":"Color for display in graphs and charts."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of Measure"
        },
        "usageIdentifier":{
            "type":"string",
            "description":"Usage Identifier"
        },
        "active":{
            "type":"boolean",
            "description":"Boolean that is true if active, false if inactive."
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "id":{
            "type":"string",
            "description":"Id of the Standard Usage Identifier record."
        }
    },
    "required":[
        "id",
        "description",
        "usageIdentifier"
    ]
}

Examples

Select an example standardUsageIdentifier

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

500 Response

An internal server error is encountered, due to an unknown reason

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

Back to Top