Rest Request
This is a base object that represents a REST request to run on a schedule.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback)
Sets the async response with selected timeout
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| asyncResponseMaxTimeToWaitCallback | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withBody(restRequestBody)
Sets the body for restRequest
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| restRequestBody | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withHeaders(restRequestHeaders)
Sets the header for restRequest
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| restRequestHeaders | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withIdentifier(identifier)
Sets the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withMethod(restRequestMethod)
Sets the method for restRequest
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| restRequestMethod | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withOrganization(organization)
Set the organization attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withScheduleCronExpression(cronExpression, timezone)
Sets the crontab expression for schedule
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| cronExpression | string |
❌ | |
| timezone | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withScheduleExecuteNow(executeNow)
Sets the executeNow attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| executeNow | boolean |
❌ |
Retorna
Tip
Tipo: RestRequest
withScheduleFrom(from)
Sets the from attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| from | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withScheduleMinutesInterval(interval)
Sets the interval for schedule in minutes
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| interval | number |
❌ | in minutes |
Retorna
Tip
Tipo: RestRequest
withScheduleTo(to)
Sets the to attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| to | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withSyncResponseTimeout(syncResponseTimeout)
Sets the sync response with selected timeout
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| syncResponseTimeout | string |
❌ |
Retorna
Tip
Tipo: RestRequest
withUrl(restRequestUrl)
Sets the url for restRequest
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| restRequestUrl | string |
❌ |
Retorna
Tip
Tipo: RestRequest