Skip to content

API

The API, or Application Programming Interface, object represents information pertaining to an API request and response.

Attributes

Section titled “Attributes”

operation

  • Type: string_t
  • Requirement: required

Verb/Operation associated with the request

request

  • Type: request
  • Requirement: recommended

Details pertaining to the API request.

response

  • Type: response
  • Requirement: recommended

Details pertaining to the API response.

group

  • Type: group
  • Requirement: optional

The information pertaining to the API group.

service

  • Type: service
  • Requirement: optional

The information pertaining to the API service.

version

  • Type: string_t
  • Requirement: optional

The version of the API service.

Used By

Section titled “Used By”