JobTimeline
Quick Reference
Method |
Endpoint |
Description |
|---|---|---|
GET |
/api/job/{jobDisplayId}/timeline |
|
POST |
/api/job/{jobDisplayId}/timeline |
|
PATCH |
/api/job/{jobDisplayId}/timeline/{timelineTaskId} |
|
DELETE |
/api/job/{jobDisplayId}/timeline/{timelineTaskId} |
|
GET |
/api/job/{jobDisplayId}/timeline/{timelineTaskIdentifier} |
|
GET |
/api/job/{jobDisplayId}/timeline/{taskCode}/agent |
GET /api/job/{jobDisplayId}/timeline
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/timeline"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/timeline \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/timeline'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
POST /api/job/{jobDisplayId}/timeline
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Query Parameters:
createEmail (boolean, query): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/timeline"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/timeline \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/timeline'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
PATCH /api/job/{jobDisplayId}/timeline/{timelineTaskId}
Parameters:
Path Parameters:
timelineTaskId (integer, path) (required): No description available
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.patch(
"/api/job/{jobDisplayId}/timeline/{timelineTaskId}"
,
timelineTaskId="789e0123-e89b-12d3-a456-426614174002"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw patch /api/job/{jobDisplayId}/timeline/{timelineTaskId} \
timelineTaskId=789e0123-e89b-12d3-a456-426614174002 \
jobDisplayId=2000000
curl -X PATCH \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/timeline/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "status": "updated",
4 "message": "Resource updated successfully"
5}
DELETE /api/job/{jobDisplayId}/timeline/{timelineTaskId}
Parameters:
Path Parameters:
timelineTaskId (integer, path) (required): No description available
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.delete(
"/api/job/{jobDisplayId}/timeline/{timelineTaskId}"
,
timelineTaskId="789e0123-e89b-12d3-a456-426614174002"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw delete /api/job/{jobDisplayId}/timeline/{timelineTaskId} \
timelineTaskId=789e0123-e89b-12d3-a456-426614174002 \
jobDisplayId=2000000
curl -X DELETE \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/timeline/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{
2 "status": "success",
3 "message": "Resource deleted successfully"
4}
GET /api/job/{jobDisplayId}/timeline/{timelineTaskIdentifier}
Parameters:
Path Parameters:
timelineTaskIdentifier (string, path) (required): No description available
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/timeline/{timelineTaskIdentifier}"
,
timelineTaskIdentifier="789e0123-e89b-12d3-a456-426614174002"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/timeline/{timelineTaskIdentifier} \
timelineTaskIdentifier=789e0123-e89b-12d3-a456-426614174002 \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/timeline/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
GET /api/job/{jobDisplayId}/timeline/{taskCode}/agent
Parameters:
Path Parameters:
taskCode (string, path) (required): No description available
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/timeline/{taskCode}/agent"
,
taskCode="CODE-001"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/timeline/{taskCode}/agent \
taskCode=CODE-001 \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/timeline/CODE-001/agent'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}