Endpoint
/api/v2/tenants/{tenantId}/rosters
Path Parameters
tenantIdstring
descriptionstring
namestring
Unique name for roster used for roster identification.
shiftDetailsobject
Child Parameters
- shiftDetails.name
- Unique name for shift. The shift would be identified with the name.Example: Morning Shift
- shiftDetails.schedule
- shiftDetails.userGroups
- Add user groups to a roster.
- shiftDetails.users
- Add users to a roster.
timeZoneobject
Time zone in which the roster should operate (see table). An example time zone is: `"timeZone": {"name": "Asia/Calcutta"},`
Child Parameters
- timeZone.name
{
"description": "Team which handles SJ network issues",
"name": "SJ Network Support",
"shiftDetails": [
{
"name": "Morning shift",
"schedule": {
"endDate": "2018-03-10T17:30:00+0000",
"startDate": "2018-02-06T07:05:00+0000",
"type": "one-time"
},
"userGroups": [
{
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"id": "USR0000000018"
}
]
}
],
"timeZone": {
"name": "Asia/Calcutta"
}
}
{
"description": "Team to handle all network issues in SJ site.",
"name": "SJ Network Support",
"shiftDetails": [
{
"name": "Morning shift",
"schedule": {
"endDate": "2018-06-10T16:10:20+0000",
"startDate": "2018-02-05T07:05:00+0000",
"type": "one-time"
},
"userGroups": [
{
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"id": "USR0000000018"
}
]
},
{
"name": "Evening shift",
"schedule": {
"endPattern": {
"type": "NEVER"
},
"endTime": "01:30:10",
"pattern": {
"repeatFrequency": 5,
"type": "weekly",
"weekDays": "Wednesday,Thursday,Friday"
},
"startDate": "2018-03-06T00:00:00+0000",
"startTime": "16:30:00",
"type": "recurring"
},
"userGroups": [
{
"uniqueId": "USRGRP-48965gg5-8fg6-a3aa-e288-0d3667e36f5"
}
],
"users": [
{
"id": "USR0000000020"
}
]
}
],
"timeZone": {
"name": "Asia/Calcutta"
}
}
Responses
OK
createdTimestring
descriptionstring
idstring
namestring
shiftDetailsarray
Child Parameters
- shiftDetails.id
- shiftDetails.name
- shiftDetails.schedule
- shiftDetails.userGroups
- shiftDetails.users
updatedTimestring
{
"client": {
"activated": true,
"id": 7,
"name": "Logix Inc",
"uniqueId": "client_7"
},
"createdTime": "2018-02-04T09:08:15+0000",
"description": "Team to monitor all network issues in SJ site.",
"id": "ES-3b05178f-b197-46b2-9451-db9bfc3c8403",
"name": "SJ Network Support",
"shiftDetails": [
{
"id": "ESD-237dffd1-8b86-47da-a40a-78246b6028e1",
"name": "Morning shift",
"schedule": {
"endDate": "2017-06-10T16:10:20+0000",
"startDate": "2018-02-06T07:05:00+0000",
"type": "one-time"
},
"userGroups": [
{
"createdTime": "2017-03-14T11:40:35+0000",
"description": "",
"name": "Network Admins",
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"email": "john.smith@myorganization.com",
"firstName": "John",
"id": "USR0000000018",
"lastName": "Smith",
"loginName": "John_Smith",
"mobileNumber": "9004561234",
"phoneNumber": ""
}
]
},
{
"id": "ESD-edaea54b-9a2a-42e9-b54b-6dea26c55202",
"name": "Evening shift",
"schedule": {
"endPattern": {
"type": "NEVER"
},
"endTime": "01:30:10",
"pattern": {
"repeatFrequency": 5,
"type": "weekly",
"weekDays": "Wednesday,Thursday,Friday"
},
"startDate": "2018-02-06T00:00:00+0000",
"startTime": "16:30:00",
"type": "recurring"
},
"userGroups": [
{
"createdTime": "2017-03-14T11:40:35+0000",
"description": "Team to monitor all Database issues.",
"name": "Database Admins",
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"email": "james.blake@myorganization.com",
"firstName": "James",
"id": "USR0000000018",
"lastName": "Blake",
"loginName": "James_Blake",
"mobileNumber": "9001237123",
"phoneNumber": ""
}
]
}
],
"timeZone": {
"code": "IST",
"id": "19",
"label": "GMT +05:30 India",
"name": "Asia/Calcutta"
},
"updatedTime": ""
}