Jump to

• Request
• Response

Retrieves list of all profile template headers

get

/spms/v1/profileConfigurationHeaders

This is to retrieve a list of all profile template headers

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object List of Profile Configuration Header
  Title: List of Profile Configuration Header

  List of Profile Configuration Header

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/profileConfigurationHeaderList"
    }
}

Nested Schema : List of Profile Configuration Header

Type: object

Title: List of Profile Configuration Header

List of Profile Configuration Header

Show Source

• items(optional): array items

{
    "title":"List of Profile Configuration Header",
    "description":"List of Profile Configuration Header",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProfileConfigurationHeaderResponse
  The Profile Template Header

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
    }
}

Nested Schema : ProfileConfigurationHeaderResponse

Type: object

The Profile Template Header

Show Source

• enabled(optional): boolean
  Example: true
• id(optional): integer
  This is the primary key for profile template category

  Example: 1
• modDate(optional): string
  This is indicates the modified date and time of this header

  Example: 2019-07-22T08:46:58
• name(optional): string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Profile Template Header name

{
    "description":"The Profile Template Header",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":"1",
            "description":"This is the primary key for profile template category"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Profile Template Header name"
        },
        "enabled":{
            "type":"boolean",
            "example":"true"
        },
        "modDate":{
            "type":"string",
            "example":"2019-07-22T08:46:58",
            "description":"This is indicates the modified date and time of this header"
        }
    }
}

204 Response

No Content

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileConfigurationHeadersErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileConfigurationHeadersErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object List of Profile Configuration Header
  Title: List of Profile Configuration Header

  List of Profile Configuration Header

{
    "allOf":[
        {
            "$ref":"#/definitions/profileConfigurationHeaderList"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : List of Profile Configuration Header

Type: object

Title: List of Profile Configuration Header

List of Profile Configuration Header

Show Source

• items(optional): array items

{
    "title":"List of Profile Configuration Header",
    "description":"List of Profile Configuration Header",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProfileConfigurationHeaderResponse
  The Profile Template Header

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
    }
}

Nested Schema : ProfileConfigurationHeaderResponse

Type: object

The Profile Template Header

Show Source

• enabled(optional): boolean
  Example: true
• id(optional): integer
  This is the primary key for profile template category

  Example: 1
• modDate(optional): string
  This is indicates the modified date and time of this header

  Example: 2019-07-22T08:46:58
• name(optional): string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Profile Template Header name

{
    "description":"The Profile Template Header",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":"1",
            "description":"This is the primary key for profile template category"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Profile Template Header name"
        },
        "enabled":{
            "type":"boolean",
            "example":"true"
        },
        "modDate":{
            "type":"string",
            "example":"2019-07-22T08:46:58",
            "description":"This is indicates the modified date and time of this header"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object List of Profile Configuration Header
  Title: List of Profile Configuration Header

  List of Profile Configuration Header

{
    "allOf":[
        {
            "$ref":"#/definitions/profileConfigurationHeaderList"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : List of Profile Configuration Header

Type: object

Title: List of Profile Configuration Header

List of Profile Configuration Header

Show Source

• items(optional): array items

{
    "title":"List of Profile Configuration Header",
    "description":"List of Profile Configuration Header",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProfileConfigurationHeaderResponse
  The Profile Template Header

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProfileConfigurationHeaderResponse"
    }
}

Nested Schema : ProfileConfigurationHeaderResponse

Type: object

The Profile Template Header

Show Source

• enabled(optional): boolean
  Example: true
• id(optional): integer
  This is the primary key for profile template category

  Example: 1
• modDate(optional): string
  This is indicates the modified date and time of this header

  Example: 2019-07-22T08:46:58
• name(optional): string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Profile Template Header name

{
    "description":"The Profile Template Header",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":"1",
            "description":"This is the primary key for profile template category"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Profile Template Header name"
        },
        "enabled":{
            "type":"boolean",
            "example":"true"
        },
        "modDate":{
            "type":"string",
            "example":"2019-07-22T08:46:58",
            "description":"This is indicates the modified date and time of this header"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileConfigurationHeadersErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top