ION functions

IONAddRequestContent

Declaration

void IONAddRequestContent(IONRequestMessage request, string content)

Description

Adds json content to the given ION API request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add JSON content.`
`content`	`Json content.`

Return Value

Does not return a value.

IONAddRequestContent

Declaration

void IONAddRequestContent(IONRequestMessage request, BinaryData data)

Description

Adds binary data content to the given ION API request as HTTP content type "application/octet-stream".

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add JSON content.`
`data`	`Binary data content.`

Return Value

Does not return a value.

IONAddRequestContentFormUrlEncoded

Declaration

void IONAddRequestContentFormUrlEncoded(IONRequestMessage request, StringDictionary content)

Description

Adds form URL encoded content in a form of key/value pairs to the given ION API request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add form URL encoded content.`
`content`	`Content data.`

Return Value

Does not return a value.

IONAddRequestContentPlain

Declaration

void IONAddRequestContentPlain(IONRequestMessage request, string text)

Description

Adds plain text content to the given ION API request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add plain text content.`
`text`	`Plain text content.`

Return Value

Does not return a value.

IONAddRequestContentWithContentType

Declaration

void IONAddRequestContentWithContentType(IONRequestMessage request, string text, string contentType)

Description

Adds string content to the given ION API request with a specific HTTP content type (for example, "application/json").

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add string content.`
`text`	`String content.`
`contentType`	`HTTP content type.`

Return Value

Does not return a value.

IONAddRequestContentWithContentType

Declaration

void IONAddRequestContentWithContentType(IONRequestMessage request, BinaryData data, string contentType)

Description

Adds binary data content to the given ION API request with a specific HTTP content type (for example, "application/octet-stream").

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to add binary data content.`
`data`	`Binary data content.`
`contentType`	`HTTP content type.`

Return Value

Does not return a value.

IONAddRequestParameter

Declaration

void IONAddRequestParameter(RequestParameterType type, IONRequestMessage request, string name, string value)

Description

Adds a parameter to the given ION API request.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`type`	`Parameter type.`
`request`	`Request to add a parameter.`
`name`	`Parameter name.`
`value`	`Parameter value.`

Return Value

Does not return a value.

IONAddRequestParameter

Declaration

void IONAddRequestParameter(RequestParameterType type, IONRequestMessage request, string name, BinaryData value, string fileName)

Description

Adds a parameter to the given ION API request. The HTTP content type will be automatically detected from the filename extension.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`type`	`Parameter type.`
`request`	`Request to add a parameter.`
`name`	`Parameter name.`
`value`	`Parameter value.`
`fileName`	`Filename for the binary data.`

Return Value

Does not return a value.

IONAddRequestParameterWithContentType

Declaration

void IONAddRequestParameterWithContentType(RequestParameterType type, IONRequestMessage request, string name, string contentType, string value)

Description

Adds a parameter to the given ION API request with a specific HTTP content type (for example, "application/xml").

Supported Runtime Versions

5.0


`Parameters`	`Description`
`type`	`Parameter type.`
`request`	`Request to add a parameter.`
`name`	`Parameter name.`
`contentType`	`Parameter contentType defines the HTTP content type of the form data value.`
`value`	`Parameter value.`

Return Value

Does not return a value.

IONAddRequestParameterWithContentType

Declaration

void IONAddRequestParameterWithContentType(RequestParameterType type, IONRequestMessage request, string name, string contentType, BinaryData value, string fileName)

Description

Adds a parameter to the given ION API request with a specific HTTP content type (for example, "application/xml").

Supported Runtime Versions

5.0


`Parameters`	`Description`
`type`	`Parameter type.`
`request`	`Request to add a parameter.`
`name`	`Parameter name.`
`contentType`	`Parameter contentType defines the HTTP content type of the form data value.`
`value`	`Parameter value.`
`fileName`	`Filename for the binary data.`

Return Value

Does not return a value.

IONCreateRequestMessage

Declaration

IONRequestMessage IONCreateRequestMessage(string serviceAccount, RequestMethodType methodType, string suite, string product, string restPath)

Description

Creates a new ION API request instance.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`serviceAccount`	`Name of the service account on behalf of which the request will be called.`
`methodType`	`Type of request method.`
`suite`	`Name of the ION API suite.`
`product`	`Name of product in the ION API suite.`
`restPath`	`Path of the ION API operation.`

Return Value

New IONRequestMessage instance.

IONCreateRequestMessageWithProxyPath

Declaration

IONRequestMessage IONCreateRequestMessageWithProxyPath(string serviceAccount, RequestMethodType methodType, string suite, string proxyPath, string restPath)

Description

Creates a new ION API request instance.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`serviceAccount`	`Name of the service account on behalf of which the request will be called.`
`methodType`	`Type of request method.`
`suite`	`Name of the ION API suite.`
`proxyPath`	`Proxy path of the ION API operation.`
`restPath`	`Path of the ION API operation.`

Return Value

New IONRequestMessage instance.

IONGetResponseBinaryContent

Declaration

BinaryData IONGetResponseBinaryContent(IONResponse response)

Description

Gets the content of a response as the binary data.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`response`	`Response of which content should be returned.`

Return Value

Content of a response.

IONGetResponseContent

Declaration

string IONGetResponseContent(IONResponse response)

Description

Gets the content of a response as a string.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`response`	`Response of which content should be returned.`

Return Value

Content of a response.

IONGetResponseFileName

Declaration

string IONGetResponseFileName(IONResponse response)

Description

Gets the filename of the content from the response. Empty if the response was not a file.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`response`	`Response of which content should be returned.`

Return Value

Content of a response.

IONGetResponseStatus

Declaration

int IONGetResponseStatus(IONResponse response)

Description

Gets the status code of a response.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`response`	`Response of which status code should be returned.`

Return Value

Status code of a response.

IONGetResponseSuccess

Declaration

bool IONGetResponseSuccess(IONResponse response)

Description

Returns the success of a response.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`response`	`Response of which success should be returned.`

Return Value

Success of a response.

IONPublishMessage

Declaration

void IONPublishMessage(string message)

Description

Publishes custom message through ION Messaging Service as AnyDocument type.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`message`	`Message to publish.`

Return Value

void

IONPublishMessage

Declaration

void IONPublishMessage(string documentType, string message)

Description

Publishes custom message through ION Messaging Service.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`documentType`	`Document type.`
`message`	`Message to publish.`

Return Value

void

IONPublishMessage

Declaration

void IONPublishMessage(string documentType, string message, string lid)

Description

Publishes custom message through ION Messaging Service.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`documentType`	`Document type.`
`message`	`Message to publish.`
`lid`	`Logical ID identifying message publisher.`

Return Value

void

IONSendRequestMessage

Declaration

IONResponse IONSendRequestMessage(IONRequestMessage request)

Description

Sends given request to ION API.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`request`	`Request to send.`

Return Value

Instance of IONResponse.