Data Factory Projects API
Introduction
A project is a folder in which you can organize your Data Factory jobs.
The Data Factory Projects API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Create a Data Factory Project
Request URL
Path parameters
None
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
json
{
"displayName": "Sub Folder",
"parentId": "68123ad00f6c1ec60b63dea3"
}1
2
3
4
2
3
4
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/data_factory/projects' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "Sub Folder",
"parentId": "68123ad00f6c1ec60b63dea3"
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response Example
json
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Sub Folder",
"depth": 1,
"parentId": "68123ad00f6c1ec60b63dea3",
"accountId": "28"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Get a Data Factory Project by Id
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| projectId | string | A project id |
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/data_factory/projects/68123ada0f6c1ec60b63dea4' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
json
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Sub Folder",
"depth": 1,
"parentId": "68123ad00f6c1ec60b63dea3",
"accountId": "28"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Find a Data Factory Project
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
See more details on the find request body in the dedicated page Find request.
"createdAt" "displayName" "depth" "parentId"
json
{
"type": "search",
"caseSensitive": true,
"field": "displayName",
"value": "Sub Folder"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "displayName",
"value": "Sub Folder"
},
{
"type": "eq",
"caseSensitive": true,
"field": "parentId",
"value": "68123ad00f6c1ec60b63dea3"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/data_factory/projects/find?size=10&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'Content-Type: application/json' \
-d '{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "displayName",
"value": "Sub Folder"
},
{
"type": "eq",
"caseSensitive": true,
"field": "parentId",
"value": "68123ad00f6c1ec60b63dea3"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Response example
json
{
"object": "list",
"data": [
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Sub Folder",
"depth": 1,
"parentId": "68123ad00f6c1ec60b63dea3",
"accountId": "28"
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
List Data Factory Projects
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/data_factory/projects?size=1&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
json
{
"object": "list",
"data": [
{
"object": "project",
"id": "68123ad00f6c1ec60b63dea3",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Folder",
"depth": 1,
"accountId": "28"
},
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:28.408Z",
"displayName": "Sub Folder",
"depth": 0,
"parentId": "68123ad00f6c1ec60b63dea3",
"accountId": "28"
}
],
"totalElements": 2
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Update a Data Factory Project
Updating a project enables to update a project. The name is mandatory, and the parent project is optional.
Request URL
Path parameters
| Paramter | Type | Description |
|---|---|---|
| projectId | string | The project id |
Request parameters
None
Request Headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
json
{
"displayName": "Child Folder",
"parentId": "68123ad00f6c1ec60b63dea3"
}1
2
3
4
2
3
4
Request Example
bash
curl -X 'PUT' \
'https://api.product-live.com/v1/data_factory/projects/68123ada0f6c1ec60b63dea4' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "Child Folder",
"parentId": "68123ad00f6c1ec60b63dea3"
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response Example
json
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Child Folder",
"depth": 1,
"parentId": "68123ad00f6c1ec60b63dea3",
"accountId": "28"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Patch a Data Factory Project
Patching a project enables to update a project. The name and the parent project are optional.
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| projectId | string | A project id |
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | string | multipart/form-data |
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
json
{
"parentId": null
}1
2
3
2
3
Request Example
bash
curl -X 'PATCH' \
'https://api.product-live.com/v1/data_factory/projects/68123ada0f6c1ec60b63dea4' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'Content-Type: application/json' \
-d '{
"parentId": null
}'1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Response Example
json
{
"object": "project",
"id": "68123ada0f6c1ec60b63dea4",
"createdAt": "2025-04-30T14:59:38.920Z",
"displayName": "Child Folder",
"depth": 0,
"accountId": "28"
}1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Delete a Data Factory Project
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| projectId | string | A project id |
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'DELETE' \
'https://api.product-live.com/v1/data_factory/projects/68123ada0f6c1ec60b63dea4' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
None. Only the HTTP status code informs of the completion of the request.