...
Sample JSON response
Code Block |
---|
{
"id": 1102,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db",
"sections": [
{
"name": "Default section",
"manager": {
"id": 1095,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"designation": {
"id": 212,
"name": "Functional Tester"
},
"role": {
"id": 1026,
"name": "User"
},
"teams": [],
"directReports": [],
"leavePolicy": {
"id": 393,
"name": "Default Leave Policy"
},
"holidayScheme": {
"id": 328,
"name": "Default Holiday Scheme"
},
"workweekScheme": {
"id": 321,
"name": "Default Workweek"
}
},
{
"id": 1047,
"name": "Employment details",
"attributes": [
{
"id": 5015,
"name": "Employee id",
"type": "Text field (single line)",
"value": "101"
},
{
"id": 5016,
"name": "Employment type",
"type": "Select list (single choice)",
"values": [
{
"id": 5257,
"name": "Permanent"
}
]
},
{
"id": 5017,
"name": "Employment status",
"type": "Select list (single choice)",
"values": [
{
"id": 5259,
"name": "Active"
}
]
},
{
"id": 5018,
"name": "Joining date",
"type": "Date picker",
"value": "1/Mar/22"
},
{
"id": 5019,
"name": "Stay with us",
"type": "Derived field",
"value": "2 years, 1 months, and 24 days"
},
{
"id": 5020,
"name": "Last working day",
"type": "Date picker",
"value": "31/May/24"
}
]
},
{
"id": 1048,
"name": "Job details",
"attributes": [
{
"id": 5021,
"name": "Job description",
"type": "Text field (multiple line)",
"value": "Have proficiency in Functional Testing.\nWorks in FS BU.",
"valueInHtml": "<div><p>Have proficiency in Functional Testing.</p><p>Works in FS BU.</p></div>"
},
{
"id": 5022,
"name": "Location",
"type": "Select list (single choice)",
"values": [
{
"id": 5263,
"name": "India office"
}
]
},
{
"id": 5023,
"name": "Desk location",
"type": "Text field (single line)",
"value": "Pune"
}
]
},
{
"id": 1049,
"name": "Personal details",
"attributes": [
{
"id": 5024,
"name": "Gender",
"type": "Select list (single choice)",
"values": [
{
"id": 5265,
"name": "Female"
}
]
},
{
"id": 5025,
"name": "Marital status",
"type": "Select list (single choice)",
"values": [
{
"id": 5267,
"name": "Single"
}
]
},
{
"id": 5026,
"name": "Blood group",
"type": "Select list (single choice)",
"values": [
{
"id": 5270,
"name": "A positive"
}
]
},
{
"id": 5027,
"name": "Date of birth",
"type": "Date picker",
"value": "23/Jul/98"
},
{
"id": 5028,
"name": "Age",
"type": "Derived field",
"value": "25 years, 9 months, and 2 days"
},
{
"id": 5029,
"name": "Nationality",
"type": "Text field (single line)",
"value": "Indian"
}
]
},
{
"id": 1050,
"name": "Contact details",
"attributes": [
{
"id": 5030,
"name": "Phone no.",
"type": "Text field (single line)",
"value": "8645666000"
},
{
"id": 5031,
"name": "Address",
"type": "Text field (multiple line)",
"value": "Whitefield,\nBangalore",
"valueInHtml": "<div><p>Whitefield,</p><p>Bangalore</p></div>"
},
{
"id": 5032,
"name": "Emergency contact",
"type": "Text field (single line)",
"value": "8593467826"
},
{
"id": 5033,
"name": "Skype",
"type": "Text field (single line)",
"value": "alan@skype.com"
}
]
},
{
"id": 1051,
"name": "Bank Details",
"attributes": [
{
"id": 5034,
"name": "Bank Name",
"type": "Text field (single line)",
"value": "Axis Bank"
},
{
"id": 5035,
"name": "Bank Account Number",
"type": "Numeric field",
"value": "895678894578945"
},
{
"id": 5036,
"name": "Bank IFSC",
"type": "Text field (single line)",
"value": "AX000355"
}
]
},
{
"id": 1052,
"name": "Project Details",
"attributes": [
{
"id": 5037,
"name": "Reporting Manager",
"type": "User picker (single select)",
"users": [
{
"id": 1098,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5f21e250ef11df0025988f71"
}
]
},
{
"id": 5037,
"name": "Reportee",
"type": "User picker (single select)",
"users": [
{
"id": 1097,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:19d2a5e6-03bd-49a1-854b-9059c075dc60"
}
]
},
{
"id": 5038,
"name": "Trainer",
"type": "User picker (multiple select)",
"users": [
{
"id": 1101,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5cd625a87c13590d66b4085b"
},
{
"id": 1103,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=618d0225fba4d0006ae18bea"
}
]
},
{
"id": 5038,
"name": "Trainee(s)",
"type": "User picker (multiple select)",
"users": [
{
"id": 1097,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:19d2a5e6-03bd-49a1-854b-9059c075dc60"
}
]
}
]
}
],
"externalId": "",
"creator": {
"id": 1095,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"created": "8/Apr/24 10:19 AM",
"modifiedBy": {
"id": 1095,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"modified": "25/Apr/24 10:15 AM",
"dateTimeFormat": "d/MMM/yy h:mm a",
"dateFormat": "d/MMM/yy"
} |
Response parameters
Parent | Parameter | Type | Description | Possible values |
---|---|---|---|---|
id | Number | UpRaise user-id | 120, 5161, etc. | |
jiraUserRestApiUrl | String | User’s Jira Rest API URL | <baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db | |
sections | Object | This object contains all the sections from UpRaise user profile | All the default and custom sections of UpRaise user profile | |
name | String | Name of the section |
| |
manager | String | Attribute that shows the aligned manager of current user in UpRaise company directory |
| |
manager | id | Number | UpRaise user id of user who is manager of current user |
|
manager | jiraUserRestApiUrl | String | Hira user Rest API URL of the user who is manager of current user |
|
designation | String | Attribute that shows the designation of current user as per UpRaise company directory |
| |
designation | id | Number | Id of the designation assigned to current user | 12, 6737, etc. |
designation | name | String |
| |
role | String | Attribute that shows the current UpRaise role of the user as per UpRaise company directory |
| |
role | id | Number | Role id of current UpRaise role |
|
role | name | String | UpRaise role of the current user |
|
teams | String | Attribute that shows the current team/s of the user as per UpRaise company directory |
| |
teams | id | Number | Id of team/s of current user |
|
teams | name | String | Name of the team/s of current user |
|
directReports | String | Attribute that shows the current directport/s of the user as per UpRaise company directory |
| |
id | Number | UpRaise user id of user who is manager of current user |
| |
jiraUserRestApiUrl | String | Hira user Rest API URL of the user who is manager of current user |
| |
leavePolicy | String | Attribute that shows the currently applicable leave policy of the user (In case of UpRaise Employee Garrison and UpRaise People) |
| |
leavePolicy | id | Number | Id of the applicable leave policy | 12, 78, etc. |
leavePolicy | name | String | Name of the applicable leave policy |
|
holidayScheme | Attribute that shows the currently applicable holiday scheme of the user (In case of UpRaise Employee Garrison and UpRaise People) |
| ||
holidayScheme | id | Number | Id of the applicable holiday scheme | 12, 727, etc. |
holidayScheme | name | String | Name of the applicable holiday scheme |
|
workweekScheme | Attribute that shows the currently applicable workweek scheme of the user (In case of UpRaise Employee Garrison and UpRaise People) |
| ||
workweekScheme | id | Number | Id of the applicable workweek scheme | 12, 27, etc. |
workweekScheme | name | String | Name of the applicable workweek scheme |
|
attributes | String | This object is contained under the other custom profile sections. These sections can contain different types of attributes related to user profiles with different types of fields as explained below. Parameters under this object are based on what type of fields are added in the section. | ||
id | Number | Attribute id | 12, 336, etc. | |
name | String | Name of the attribute |
| |
type | String | Field type of attribute |
| |
values | String | This parameter will show values based on the type of the field. Eg. If date picker field, then the value in this parameter will be a date. If field type is user picker then value will contain user name and the expected parameters under it are user ID and Jira user Rest API URL. |
| |
values | id | Number | Id of the value | 12, 2, etc. |
values | name | String | Name of the attribute |
|
valueInHtml | String | Value in HTML for text field type attribute | <div><p>Whitefield,</p><p>Bangalore</p></div> | |
users | String | Applicable when the attribute field type is User picker |
| |
externalId | Number | Applicable when the user is added using HRMS sync from different HRMS tools | Any external id of the user | |
creator | String | Details of the user who created the current user |
| |
created | String | Date when the user is created | 8/Apr/24 10:19 AM 8/Jan/24 11:19 AM | |
modifiedBy | String | User details who last modified the current user details |
| |
dateTimeFormat | String | Format definition of date fields returned in response. | d/MMM/yy h:mm a | |
dateFormat | String | Format definition of date fields returned in response. | d/MMM/yy |