post https://{hostname}/api/v1/work/team_segments/audits/multi_read
This operation returns audits for activity team segments or activity team segment results according to the specified date range.
Service limit
A service limit constrains the number of teams and date range that can be processed in a single request.
-
The Number of Teams cannot exceed 100.
-
The Date Range cannot exceed 14.
Refer to the Limits topic for more information.
The associated Access Control Point is WFA_WORK_INTEGRATION_API.
Example call
Example request
The select property auditType allows for three possible options:
-
TEAM_SEGMENT- return only a team segment's audits -
TEAM_RESULT_SEGMENT- return only a team result segment's audits -
TEAM_SEGMENT,TEAM_RESULT_SEGMENT- return both a team segment's and a team result segment's audits
The teams property contains an array of teams for which team segments are retrieved.
The startDateTime and endDateTime dateRange properties constain by date and time the returned team segments. During request processing the dates are recalculated for each team. New values are dependent on a team's timezone.
{
"select": {
"auditType": [
"TEAM_SEGMENT",
"TEAM_SEGMENT_RESULT"
]
},
"where": {
"teams": [
{
"id": 775577
},
{
"qualifier": "JumTQCjGzBI"
}
],
"startDateTime": "2021-10-20T06:00:00",
"endDateTime": "2021-11-10T19:00:00"
}
}
Example response
[
{
"team": {
"id": 1,
"qualifier": "A"
},
"segments": [
{
"id": 4,
"type": "ADD",
"startDateTime": "2021-09-27T01:00:00",
"endDateTime": "2021-09-27T02:00:00",
"closable": false,
"direct": true,
"accepted": false,
"updatedDateTime": "2021-09-27T12:58:02",
"revisionId": 2031721,
"revisionDateTime": "2021-09-27T12:58:02",
"revisionUser": {
"id": 1451,
"qualifier": "Deleted User"
},
"team": {
"id": 1,
"qualifier": "A"
},
"activity": {
"id": 205,
"qualifier": "TADumpActivity1"
},
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
},
"startTimezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"endTimezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"laborCategories": [
{
"laborCategoryDef": {
"id": 9,
"qualifier": "Contract Code"
},
"laborCategoryEntry": {
"id": 56,
"qualifier": "Fed-101"
}
},
{
"laborCategoryDef": {
"id": 10,
"qualifier": "Project Code"
},
"laborCategoryEntry": {
"id": 63,
"qualifier": "Cargo 1"
}
},
{
"laborCategoryDef": {
"id": 11,
"qualifier": "Shift"
},
"laborCategoryEntry": {
"id": 151,
"qualifier": "Afternoon Shift"
}
}
],
"costCenter": {
"id": 1,
"qualifier": "CC_Production"
},
"workRule": {
"id": 67,
"qualifier": "Admin Assistant"
},
"orgJob": {
"id": 514,
"qualifier": "Acme Company/System Administrator"
},
"auditKey": 1,
"eventType": {
"id": 0,
"qualifier": "Start-Stop Transaction"
},
"hoursAllocatedType": {
"id": 0,
"qualifier": "EVEN"
},
"createdDateTime": "2021-09-27T12:58:02"
}
],
"results": [
{
"id": 15,
"type": "ADD",
"textResult": "1",
"groupIndex": 1,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T12:58:02",
"revisionId": 2031721,
"revisionDateTime": "2021-09-27T12:58:02",
"revisionUser": {
"id": 1451,
"qualifier": "Deleted User"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 51,
"qualifier": "TADump ALPHA NUMERIC"
},
"auditKey": 1,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 16,
"type": "ADD",
"textResult": "2",
"groupIndex": 2,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T12:58:02",
"revisionId": 2031721,
"revisionDateTime": "2021-09-27T12:58:02",
"revisionUser": {
"id": 1451,
"qualifier": "Deleted User"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 52,
"qualifier": "TADump ALPHA NUMERIC with slash"
},
"auditKey": 1,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 17,
"type": "ADD",
"dateResult": "2021-09-27",
"groupIndex": 3,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T12:58:02",
"revisionId": 2031721,
"revisionDateTime": "2021-09-27T12:58:02",
"revisionUser": {
"id": 1451,
"qualifier": "Deleted User"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 53,
"qualifier": "TADump DATE"
},
"auditKey": 1,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 17,
"type": "MOD",
"dateResult": "2021-10-01",
"groupIndex": 2,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T13:51:21",
"revisionId": 2031722,
"revisionDateTime": "2021-09-27T13:51:22",
"revisionUser": {
"id": 1501,
"qualifier": "1"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 53,
"qualifier": "TADump DATE"
},
"auditKey": 2,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 16,
"type": "DEL",
"textResult": "2",
"groupIndex": 2,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T13:51:22",
"revisionId": 2031722,
"revisionDateTime": "2021-09-27T13:51:22",
"revisionUser": {
"id": 1501,
"qualifier": "1"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 52,
"qualifier": "TADump ALPHA NUMERIC with slash"
},
"auditKey": 2,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 18,
"type": "ADD",
"groupIndex": 1,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T14:23:48",
"createdDateTime": "2021-09-27T14:23:57",
"updatedDateTime": "2021-09-27T14:23:57",
"revisionId": 2031723,
"revisionDateTime": "2021-09-27T14:23:58",
"revisionUser": {
"id": 1501,
"qualifier": "1"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 51,
"qualifier": "TADump ALPHA NUMERIC"
},
"resultCode": {
"id": 51,
"qualifier": "TADump RC1"
},
"auditKey": 1,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
},
{
"id": 15,
"type": "DEL",
"textResult": "1",
"groupIndex": 1,
"childIndex": 0,
"effectiveDateTime": "2021-09-27T12:57:53",
"createdDateTime": "2021-09-27T12:58:02",
"updatedDateTime": "2021-09-27T14:23:58",
"revisionId": 2031723,
"revisionDateTime": "2021-09-27T14:23:58",
"revisionUser": {
"id": 1501,
"qualifier": "1"
},
"teamSegmentId": 4,
"fieldDefinition": {
"id": 51,
"qualifier": "TADump ALPHA NUMERIC"
},
"auditKey": 2,
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor"
}
}
]
}
]