API Parameter Types - Finesse

API Header Parameters

The following sections describe the parameter and data types for the Cisco Finesse APIs.


Name	Type	Description
password	String	The password used in the request header to make any Finesse API request. Finesse supports a "Basic" authorization scheme only and authorization is required for each Finesse API request.
username	String	The username used in the request header to make any Finesse API request. Finesse supports a "Basic" authorization scheme only and authorization is required for each Finesse API request.

Body Parameter

A body parameter (also known as a complex parameter) appears in the body of the message. In the following example, targetMediaAddress and requestedAction are body parameters.

<Dialog>
    <targetMediaAddress>1001001</targetMediaAddress>
    <requestedAction>HOLD</requestedAction>
</Dialog>

Path Parameter

A path parameter is included in the path of the URI. In the following example, dialogId is a path parameter.

https://<FQDN>:<port>/finesse/api/Dialog/<dialogId>

Query Parameter

A query parameter is passed in a query string on the end of the URI you are calling. The query parameter is preceded by a question mark. Multiple query parameters are connected by an ampersand (&). In the following example, category is a query parameter.

https://<FQDN>:<port>/finesse/api/User/<id>/ReasonCodes?category=NOT_READY

Data Types

The following table lists the data types used in API parameters and notification message fields.


Type	Description
Boolean	A logical data type that has one of two values: true or false.
Integer	A 32-bit wide integer.
Long	A 64-bit wide integer.
String	A variable-length string. If a maximum length exists, it is listed with the parameter description.