Jump to

• Request
• Response

Get a list of system registry keys.

get

/learn.rest/v1/systemRegistryKeys

Request

Query Parameters

• totalResults(optional): boolean
  If set to true, payload includes the total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

200 Response

Metadata-catalog collection fetched.

Body ()

Root Schema : SystemRegistryKeysResponse

Type: object

Response object for System registry keys.

Show Source

• items(optional): array items
  array of items
• links(optional): array links
  Array of links

{
    "type":"object",
    "description":"Response object for System registry keys.",
    "properties":{
        "items":{
            "type":"array",
            "description":"array of items",
            "items":{
                "$ref":"#/definitions/SystemRegistryKeyResponse"
            }
        },
        "links":{
            "type":"array",
            "description":"Array of links",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "id":"GeneratePassword",
                "value":"1",
                "category":"RestApiSettings",
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
                    }
                ]
            },
            {
                "id":"TriggerUserMessages",
                "value":"0 or 1",
                "category":"RestApiSettings",
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/systemRegistryKeys/TriggerUserMessages"
                    }
                ]
            }
        ],
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/systemRegistryKeys"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "id":"GeneratePassword",
            "value":"1",
            "category":"RestApiSettings",
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
                }
            ]
        },
        {
            "id":"TriggerUserMessages",
            "value":"0 or 1",
            "category":"RestApiSettings",
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/systemRegistryKeys/TriggerUserMessages"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/systemRegistryKeys"
        }
    ]
}

Nested Schema : items

Type: array

array of items

Show Source

• Array of: object User
  Response object for system registry.

{
    "type":"array",
    "description":"array of items",
    "items":{
        "$ref":"#/definitions/SystemRegistryKeyResponse"
    }
}

Nested Schema : links

Type: array

Array of links

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Array of links",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : User

Type: object

Response object for system registry.

Show Source

• category(optional): string
  Category of the key.
• id(optional): string
  Name of the key.
• links(optional): array links
  Array of System Registry links.
• value(optional): string
  Value of the key.

{
    "type":"object",
    "description":"Response object for system registry.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Name of the key."
        },
        "value":{
            "type":"string",
            "description":"Value of the key."
        },
        "category":{
            "type":"string",
            "description":"Category of the key."
        },
        "links":{
            "type":"array",
            "description":"Array of System Registry links.",
            "items":{
                "$ref":"#/definitions/SystemRegistryKeyLinkItems"
            }
        }
    },
    "example":{
        "id":"GeneratePassword",
        "value":"1",
        "category":"RestApiSettings",
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
            }
        ]
    },
    "xml":{
        "name":"User"
    }
}

Example:

{
    "id":"GeneratePassword",
    "value":"1",
    "category":"RestApiSettings",
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
        }
    ]
}

Nested Schema : links

Type: array

Array of System Registry links.

Show Source

• Array of: object SystemRegistryKeyLinkItems

{
    "type":"array",
    "description":"Array of System Registry links.",
    "items":{
        "$ref":"#/definitions/SystemRegistryKeyLinkItems"
    }
}

Nested Schema : SystemRegistryKeyLinkItems

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

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

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top