Self-Service Metadata API Specifications

Use this API to get all supported timezones and to search a ticket based on ticket number, part of summary, patch number, self-service feature, or last updated date.

Get Supported Timezones

Use this API to get all supported timezones.

API

/selfservice/v1/metadata/timezones

Scope and AuthZ

You must have mcs:oci:api:User scope to access this API.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

This API gets the list of timezones (IANA) supported by the Self-Service Portal.

Verb

GET

Parameters

Name Type Description Mandatory
code Query parameter

Filter the timezones fetched based on the provided code.

The value specified here can be a portion of the code to be matched. Also, the comparison performed is case-insensitive.

Note: If both code and value are specified, the result is those timezones that match either one of the criteria.

No
value Query parameter

Filter the timezones fetched based on the provided value.

The value specified can be a portion of the code to be matched. Also, the comparison performed is case-insensitive.

Note: If both code and value are specified, the result is those timezones that match either one of the criteria.

No
offset Query parameter

Index of the record forming the start of the page

If not specified, the value is defaulted to 0.

No
limit Query parameter

Number of records to be returned within the page.

If not specified, all records available are returned.

No
total Query parameter

Specify true to get the total number of timezones satisfying the given filters.

The default value for this parameter is false.

No

Sample response

[
    {
        "code": "America/Indiana/Indianapolis",
        "value": "(UTC-05:00) Indiana"
    },
    {
        "code": "America/Indianapolis",
        "value": "(UTC-05:00) Indianapolis - Eastern Time"
    },
    {
        "code": "Asia/Calcutta",
        "value": "(UTC+05:30) Calcutta - India Standard Time"
    },
    {
        "code": "Asia/Colombo",
        "value": "(UTC+05:30) Colombo - India Standard Time"
    },
    {
        "code": "Europe/Paris",
        "value": "(UTC+01:00) Paris - Central European Time"
    }
]