Gigya Job Openings

idx.setDataflow REST

Skip to end of metadata
Go to start of metadata

Description

This method modifies an existing dataflow.

Request URL

Where <Data_Center> is:

  • us1.gigya.com for the US data center (default)
  • eu1.gigya.com for the European data center
  • au1.gigya.com for the Australian data center
  • ru1.gigya.com for the Russian data center
  • cn1.gigya-api.cn for the Chinese data center

Parameters

RequiredNameTypeDescription
dataObject

A dataflow object. The object has to include the id of an existing dataflow to modify.

The object passed in this parameter will replace the existing dataflow. Any fields in the existing dataflow that are not included in this parameter will be lost.

For example, if you have the following dataflow in the system: {"id": "mydataflow","steps": "..." }

And you call idx.setDataflow with the following object in the data parameter: {"id": "mydataflow","description": "Just a dataflow"}

The result will be a dataflow with a description but no steps.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

See Authorization Parameters Overview for details. 

Response Data

FieldTypeDescription
errorCodeintegerThe result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessagestringA short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetailsstringThis field will appear in the response only in case of an error and will contain the exception info, if available.
callIdstringUnique identifier of the transaction, for debugging purposes.
timestringThe time of the response represented in ISO 8601 format. i.e., yyyy.mm.dd.Thh.MM.ss.SSSZ

A field that does not contain data will not appear in the response.

Response Example

{
	"statusCode": 200,
	"errorCode": 0,
	"statusReason": "OK",
	"callId": "ddb3f8e144c84cb5b1bc5f010bddab2b",
	"time": "2015-03-22T11:42:25.943Z"
}

 

Save

Save

  • No labels