Jump to

• Request
• Response

List Event Categories

get

/system/api/v1/events/categories

List the categories for all the events. ## Authorization All logged-in users can search the categories. ## Sorting The default sorting is ascending order. The Id field is sorted in ascending order.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Categories

Type: object

List of Category.

Show Source

• count(optional): integer(int64)
  Total number of resources in the response.

  Example: 10
• hasMore(optional): boolean
  Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

  Example: true
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int64)
  Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

  Example: 10
• links(optional): array links
  Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
• offset(optional): integer(int64)
  Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  Example: 0
• totalResults(optional): integer(int64)
  Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the `totalResults` parameter is supported and is set to `true` by the client.

  Example: 10

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements."
        },
        "offset":{
            "type":"integer",
            "format":"int64",
            "example":0,
            "description":"Actual response offset used. If the request specifies no offset then the actual offset is provided in the response."
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Total number of resources in the response."
        },
        "limit":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used."
        },
        "totalResults":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the `totalResults` parameter is supported and is set to `true` by the client."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Category"
            }
        },
        "links":{
            "type":"array",
            "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"List of Category."
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object Category
  Category Information.

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Category"
    }
}

Nested Schema : links

Type: array

Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: object Link
  REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "type":"array",
    "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Category

Type: object

Category Information.

Show Source

• displayName(optional): string
  The display key of the category.

  Example: Asset Lifecycle
• id(optional): integer(int32)
  The id of the category.

  Example: 123456789
• name(optional): string
  The name of the category.

  Example: ASSET_LIFECYCLE

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32",
            "example":123456789,
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "example":"ASSET_LIFECYCLE",
            "description":"The name of the category."
        },
        "displayName":{
            "type":"string",
            "example":"Asset Lifecycle",
            "description":"The display key of the category."
        }
    },
    "description":"Category Information."
}

Nested Schema : Link

Type: object

REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string
  The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
• mediaType(optional): string
  Link target. Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
• profile(optional): string
  Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel(optional): string
  Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
• templated(optional): boolean
  Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

304 Response

Not Modified

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

400 Response

Bad Request

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

404 Response

Not Found

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

Back to Top