ApiResponseMetadata#

class ApiResponseMetadata(flags=None, links=None, total_available_results=None, messages=None, extra_info=None, *args, **kwargs)#

Bases: object

The metadata associated with an API response. This value is always present and minimally contains the self-link for the API request that produced this response. It also contains pagination data for the paginated requests.

Parameters:

  • flags – (flags) An array of flags that may indicate the status of the response. For example, a flag with the name ‘isPaginated’ and value ‘false’, indicates that the response is not paginated.

  • links – (links) An array of HATEOAS style links for the response that may also include pagination links for list operations.

  • total_available_results – (total_available_results) The total number of entities that are available on the server for this type.

  • messages – (messages) Information, Warning or Error messages that might provide additional contextual information related to the operation.

  • extra_info – (extra_info) An array of entity-specific metadata

property extra_info#

An array of entity-specific metadata

Type:

list[ KVPair ]

property flags#

An array of flags that may indicate the status of the response. For example, a flag with the name ‘isPaginated’ and value ‘false’, indicates that the response is not paginated.

Type:

list[ Flag ]

An array of HATEOAS style links for the response that may also include pagination links for list operations.

Type:

list[ ApiLink ]

property messages#

Information, Warning or Error messages that might provide additional contextual information related to the operation.

Type:

list[ Message ]

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property total_available_results#

The total number of entities that are available on the server for this type.

Type:

int