Branches
Execute a frozen entity extraction plan
POST
/
project
/
{projectId}
/
branch
/
{branchId}
/
extractions
Execute a frozen entity extraction plan
curl --request POST \
--url https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_name": "<string>"
}
'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions"
payload = {
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_name": "<string>"
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', destination_name: '<string>'})
};
fetch('https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"created_at": "2023-11-07T05:31:56Z",
"destination": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_seq_id": "<string>"
},
"diff_count": 123,
"entity_count": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reverted_at": "2023-11-07T05:31:56Z",
"source": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_seq_id": "<string>"
},
"status": "completed",
"undo": {
"eligible": true,
"reason": "<string>"
}
}Authorizations
api-keybearer
Headers
Workspace identifier
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
completed, reverted Show child attributes
Show child attributes
⌘I
Execute a frozen entity extraction plan
curl --request POST \
--url https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_name": "<string>"
}
'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions"
payload = {
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_name": "<string>"
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', destination_name: '<string>'})
};
fetch('https://backend.branch.flowengineering.com/project/{projectId}/branch/{branchId}/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"created_at": "2023-11-07T05:31:56Z",
"destination": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_seq_id": "<string>"
},
"diff_count": 123,
"entity_count": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reverted_at": "2023-11-07T05:31:56Z",
"source": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_seq_id": "<string>"
},
"status": "completed",
"undo": {
"eligible": true,
"reason": "<string>"
}
}