File Coordinator 1.0.0

Server

/api/v1.0/

https://file-qa.adara.com/api/v1.0/

https://file-prod.adara.com/api/v1.0/

Authentication

oauth2 oauth2

FlowClient Credentials

Token URL/core/v1.0/oauth/token

Pipelines

POST

/executions/{pipeline_id}

Execute a pipeline on demand

Auth

Required Scopes:post:executions

Path Params

pipeline_id string

POST /executions/{pipeline_id}

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//executions/%7Bpipeline_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

204

Sweep initiated

No response body

404

Pipeline not found

Response

xxxxxxxxxx
 
No response
Copy

Get the list of pipeline executions

Auth

Required Scopes:get:executions

Query String

limit	integer	Default: 20
pipeline_id	string
adara_id	string

GET /executions

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//executions' \ --header 'Authorization: Bearer {token}' \ --data limit=20 \ --data pipeline_id={pipeline_id} \ --data adara_id={adara_id}
Copy

Responses

200

Return list of Pipeline executions

object	object
active	boolean
response	array[object]
job_id	string
pipeline_id	string
filename	string
status	string	Enum: `active`,`pending`,`completed`,`failed`
created	integer
updated	integer

400

Bad Request pipeline_id or Adara_id required

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "job_id": "{string}",   "pipeline_id": "{string}",   "filename": "{string}",   "status": "{string}",   "created": "{integer}",   "updated": "{integer}"  } ]}
Copy

Add a managed file pipeline

Auth

Required Scopes:post:pipelines

Request Body

object	object
origin	object
destination	object
adara_id	string
input	object
compression	string
file_type	string	Enum: `json`,`csv`
delimiter	string
file_pattern	string
encryption	object
key	string
type	string

POST /pipelines

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//pipelines' \ --header 'Authorization: Bearer {token}' \ --data '{  "origin": {},  "destination": {},  "adara_id": "{string}",  "input": {    "compression": "gzip",    "file_type": "json",    "delimiter": "|",    "file_pattern": "/input/*.csv",    "encryption": {      "key": "{string}",      "type": "{string}"    }  }}'
Copy

Responses

200

New pipeline created

id	string
origin	object
type	string
parameters	object
destination	object
name	string
parameters	object
adara_id	string
input	object
compression	string
file_type	string	Enum: `json`,`csv`
delimiter	string
file_pattern	string
encryption	string

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Get list of file pipelines

Auth

Required Scopes:get:pipelines

GET /pipelines

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//pipelines' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Return list of existing pipelines

object	object
active	boolean
response	array
id	string
origin	object
type	string
parameters	object
destination	object
name	string
parameters	object
adara_id	string
input	object
compression	string
file_type	string	Enum: `json`,`csv`
delimiter	string
file_pattern	string
encryption	string

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  "{array...}" ]}
Copy

Integrations

Get list of pipeline origin types

Auth

Required Scopes:get:origins

GET /origins

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//origins' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Return list of origins

object	object
active	boolean
response	array[object]
type	string
parameters	object

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "type": "{string}",   "parameters": {}  } ]}
Copy

Get list of pipeline destinations

Auth

Required Scopes:get:destinations

GET /destinations

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//destinations' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Return list of origins

object	object
active	boolean
response	array[object]
name	string
parameters	object

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "name": "onboarding",   "parameters": {}  } ]}
Copy