post https://{hostname}/api/v1/work/team_segments/multi_read
This operation returns activity team segments by teams or by activity team segment identifiers.
Service limit
A service limit constrains the multiplier of days and teams or number of identifiers that can be processed in a single request.
-
The Multiplier of Days and Teams cannot exceed 6000.
-
The Number of Identifiers cannot exceed 300.
Refer to the Limits topic for more information.
The associated Access Control Points are WFA_WORK_INTEGRATION_API and WFA_VIEW_TEAM_ACTIVITY_EVENTS.
Example call
In this operation's request, the segments property is mutually exclusive with teams, startDate and endDate, or symbolicPeriod. symbolicPeriod is mutually exclusive with startDate and endDate. returnResults is optional and can be used with any other properties. startTimezone is optional within activitySegmentIdentifiers.
Example request: searching by teams
{
"where": {
"teams": {
"ids": [
123,
456
],
"qualifiers": [
"Team A",
"Team B"
],
"refs": [
{
"id": 789
},
{
"qualifier": "Team C"
}
]
},
"startDate": "2021-08-16",
"endDate": "2021-08-16",
"symbolicPeriod": {
"id": 904,
"qualifier": "CURRENT_WEEK"
},
"returnResults": false
}
}
Example response: searching by teams
[
{
"team": {
"id": 1,
"qualifier": "Team A"
},
"teamSegments": [
{
"id": 171,
"team": {
"id": 1,
"qualifier": "Team A"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor",
"name": "Princeton, Charles"
},
"startDateTime": "2021-08-19T01:00:00",
"endDateTime": "2021-08-19T04:00:00",
"startTimezone": {
"id": -10,
"qualifier": "UTC"
},
"endTimezone": {
"id": -10,
"qualifier": "UTC"
},
"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"
},
"emptyTransfer": false,
"direct": true,
"eventType": {
"id": 0
},
"createdDateTime": "2021-12-21T06:18:23",
"updatedDateTime": "2021-12-21T06:18:23",
"missingResults": false,
"mismatchedResults": true,
"accepted": true,
"closable": false,
"deleted": false
}
]
}
]
Example request: searching by segments
{
"where": {
"segments": {
"activitySegmentIDs": [
777,
888,
999
],
"activitySegmentIdentifiers": [
{
"team": {
"id": 165,
"qualifier": "225449-YEEWXLZ"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"start": "2021-08-10T08:00",
"startTimezone": {
"id": -10,
"qualifier": "UTC"
}
},
{
"team": {
"id": 155,
"qualifier": "225449-FFFDDDWWW"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump2"
},
"start": "2021-08-12T08:00"
}
]
},
"returnResults": false
}
}
Example response: searching by segments
[
{
"identifier": {
"team": {
"id": 1,
"qualifier": "Team A"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"start": "2021-08-19T01:00:00"
},
"teamSegment": {
"id": 171,
"team": {
"id": 1,
"qualifier": "Team A"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor",
"name": "Princeton, Charles"
},
"startDateTime": "2021-08-19T01:00:00",
"endDateTime": "2021-08-19T04:00:00",
"startTimezone": {
"id": -10,
"qualifier": "UTC"
},
"endTimezone": {
"id": -10,
"qualifier": "UTC"
},
"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"
},
"emptyTransfer": false,
"direct": true,
"eventType": {
"id": 0
},
"createdDateTime": "2021-12-21T06:18:23",
"updatedDateTime": "2021-12-21T06:18:23",
"missingResults": false,
"mismatchedResults": true,
"accepted": true,
"closable": false,
"deleted": false
}
},
{
"identifier": {
"team": {
"id": 2,
"qualifier": "Team B"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"start": "2021-08-19T01:00:00"
},
"teamSegment": {
"id": 172,
"team": {
"id": 2,
"qualifier": "Team B"
},
"activity": {
"id": 201,
"qualifier": "ActivityDump1"
},
"dataSource": {
"id": 5803,
"qualifier": "Princeton, Charles",
"displayName": "Team Segment Editor",
"functionalAreaName": "CharlesPrinceton/Team Segment Editor",
"name": "Princeton, Charles"
},
"startDateTime": "2021-08-19T01:00:00",
"endDateTime": "2021-08-19T04:00:00",
"startTimezone": {
"id": -10,
"qualifier": "UTC"
},
"endTimezone": {
"id": -10,
"qualifier": "UTC"
},
"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"
},
"emptyTransfer": false,
"direct": true,
"eventType": {
"id": 0
},
"createdDateTime": "2021-12-21T06:42:13",
"updatedDateTime": "2021-12-21T06:42:13",
"missingResults": false,
"mismatchedResults": true,
"accepted": true,
"closable": false,
"deleted": false
}
}
]