Rest Request

RestRequest

RestRequest Objects

class RestRequest()

This is a base object that contains all you can do about Bundles.

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
toJson
function toJson() -> '*'

Returns:

  • *
update
function update()
withAsyncResponseMaxTimeToWaitCallback
function withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string) -> 'RestRequest'

Sets the async response with selected timeout

Arguments:

  • asyncResponseMaxTimeToWaitCallback string

Returns:

  • RestRequest
withBody
function withBody(restRequestBody: string) -> 'RestRequest'

Sets the body for restRequest

Arguments:

  • restRequestBody string

Returns:

  • RestRequest
withHeaders
function withHeaders(restRequestHeaders: string) -> 'RestRequest'

Sets the header for restRequest

Arguments:

  • restRequestHeaders string

Returns:

  • RestRequest
withIdentifier
function withIdentifier(identifier: string) -> 'RestRequest'

Sets the identifier attribute

Arguments:

  • identifier string

Returns:

  • RestRequest
withMethod
function withMethod(restRequestMethod: string) -> 'RestRequest'

Sets the method for restRequest

Arguments:

  • restRequestMethod string

Returns:

  • RestRequest
withOrganization
function withOrganization(organization: string) -> 'Channels'

Set the organization attribute

Arguments:

  • organization string

Returns:

  • Channels
withScheduleCronExpression
function withScheduleCronExpression(cronExpression: string) -> 'RestRequest'

Sets the crontab expression for schedule

Arguments:

  • cronExpression string

Returns:

  • RestRequest
withScheduleImmediateExecution
function withScheduleImmediateExecution(isImmediateExecution: boolean) -> 'RestRequest'

Sets the isImmediateExecution attribute for schedule

Arguments:

  • isImmediateExecution boolean

Returns:

  • RestRequest
withSyncResponseTimeout
function withSyncResponseTimeout(syncResponseTimeout: string) -> 'RestRequest'

Sets the sync response with selected timeout

Arguments:

  • syncResponseTimeout string

Returns:

  • RestRequest
withUrl
function withUrl(restRequestUrl: string) -> 'RestRequest'

Sets the url for restRequest

Arguments:

  • restRequestUrl string

Returns:

  • RestRequest