REST API for Oracle Digital Experience for Communications Industry Fabric

Get a feature flag.

get

/admin/featureFlags/{flag}

Retrieves the feature flag identified by the path parameter.

Request

Path Parameters

flag(required): string

The flag of the FeatureFlag.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : FeatureFlag

Type: object

Represents the state and metadata of a feature flag.

Show Source

allowed-parties: array allowed-parties
description: string
eligible-for-production-workspaces: boolean
eligible-for-test-workspaces: boolean
enabled: string
feature-description: string
links: array links
ticket: string

{
    "description":"Represents the state and metadata of a feature flag.",
    "type":"object",
    "properties":{
        "feature-description":{
            "type":"string",
            "nullable":false
        },
        "ticket":{
            "type":"string",
            "nullable":false
        },
        "allowed-parties":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "SaaSOps",
                    "tenant"
                ]
            }
        },
        "eligible-for-production-workspaces":{
            "type":"boolean"
        },
        "eligible-for-test-workspaces":{
            "type":"boolean"
        },
        "enabled":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureFlagLink"
            }
        }
    }
}

Nested Schema : allowed-parties

Type: array

Show Source

Array of: string

Allowed Values: [ "SaaSOps", "tenant" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "SaaSOps",
            "tenant"
        ]
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object FeatureFlagLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FeatureFlagLink"
    }
}

Nested Schema : FeatureFlagLink

Type: object

Show Source

href: string
rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): 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.
reason(required): string

Explanation of the reason for 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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can 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"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): 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.
reason(required): string

Explanation of the reason for 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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can 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"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): 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.
reason(required): string

Explanation of the reason for 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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can 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"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): 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.
reason(required): string

Explanation of the reason for 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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can 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"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): 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.
reason(required): string

Explanation of the reason for 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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can 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"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Examples

The following example shows how to get a feature flag by submitting a get request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X GET https://{FABRIC_HOST}/admin/featueFlags/{flag} -H "Content-Type: application/json" | json_pp

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "enabled": true,
    "description": "When enabled FA adapter invokes self-registation api after contact is created or updated in FA",
    "links": [
        {
            "rel": "self",
            "href": "https://144.25.34.150/admin//01/featureFlags/self-registration"
        }
    ]
}