Loading Api Documentation...

{{topic.resource}}

{{topic.note}}

{{topic.associatedLicensedFeature}}

Deprecated: {{topic.deprecated}}

Methods

{{method}}

{{value.note}}
Examples
{{example}}
Example Request Body
{{value.exampleBody}}
Example Response Body
{{value.exampleOutput}}
Error Codes

{{errorCode.name}} {{errorCode.desc}}

Query Parameters
Name Type Default Description Req.
{{parameter.name}} {{parameter.type}} {{parameter.defValue}}

{{parameter.desc}}

Values: {{parameter.values}}

Deprecated: {{parameter.deprecated}}

{{isRequired(parameter.required)}}
{{bodyValue.name}} {{bodyValue.type}} {{bodyValue.defValue}}

{{bodyValue.desc}}

Values: {{bodyValue.values}}

Deprecated: {{bodyValue.deprecated}}

{{isRequired(bodyValue.required)}}
Output Values

{{outputValue.name}} <{{outputValue.type}}>

{{outputValue.desc}}

Values: {{outputValue.values}}

Deprecated: {{outputValue.deprecated}}