getUserProfileAttributes

Background

This REST API is meant to provide user profile attribute master data to the end user. So, they can use it in the create/update user REST API.

API Details

This API will require valid authentication & will expect the user API token in the request.
- Read Create User API token for more details

Request

Below are the endpoints for this API based on which UpRaise app you are using

App name	Endpoint
UpRaise for Employee Success	https://employee-success.upraise.io/rest/upraise/public/1.0/directory/getUserProfileAttributes
UpRaise People	https://people.upraise.io/rest/upraise/public/1.0/directory/getUserProfileAttributes
UpRaise Employee Garrison	https://garrison.upraise.io/rest/upraise/public/1.0/directory/getUserProfileAttributes

On this page
1 Background 2 API Details 3 Request 4 Sample JSON 5 Response parameters

Sample JSON

[
  {
    "field": "Role",
    "type": "Single select",
    "values": [
      {
        "id": 1025,
        "name": "No Access",
        "type": "Default"
      },
      {
        "id": 1026,
        "name": "User",
        "type": "Default"
      },
      {
        "id": 1027,
        "name": "Admin",
        "type": "Default"
      },
      {
        "id": 1028,
        "name": "Super Admin",
        "type": "Default"
      },
      {
        "id": 1029,
        "name": "User with Super Admin permissions",
        "type": "Custom"
      }
    ]
  },
  {
    "field": "Designation",
    "type": "Single select",
    "values": [
      {
        "id": 209,
        "name": "CEO"
      },
      {
        "id": 212,
        "name": "Functional Tester"
      },
      {
        "id": 210,
        "name": "Product Manager"
      },
      {
        "id": 211,
        "name": "Software Developer"
      }
    ]
  },
  {
    "field": "Teams",
    "type": "Multiple select",
    "teamsApiUrl": "<baseURL>/rest/upraise/public/1.0/directory/teams"
  },
  {
    "field": "Manager",
    "type": "Single select",
    "usersApiUrl": "<baseURL>/rest/upraise/public/1.0/directory/1829/getUsersForSegment"
  },
  {
    "field": "Custom attributes",
    "sections": [
      {
        "id": 1047,
        "name": "Employment details",
        "attributes": [
          {
            "id": 5015,
            "name": "Employee id",
            "type": "Text field (single line)"
          },
          {
            "id": 5016,
            "name": "Employment type",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5257,
                "name": "Permanent"
              },
              {
                "id": 5258,
                "name": "On contract"
              }
            ]
          },
          {
            "id": 5017,
            "name": "Employment status",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5259,
                "name": "Active"
              },
              {
                "id": 5260,
                "name": "Seperated"
              },
              {
                "id": 5261,
                "name": "Terminated"
              }
            ]
          },
          {
            "id": 5018,
            "name": "Joining date",
            "type": "Date picker",
            "format": "dd-MM-yyyy"
          },
          {
            "id": 5020,
            "name": "Last working day",
            "type": "Date picker",
            "format": "dd-MM-yyyy"
          }
        ]
      },
      {
        "id": 1048,
        "name": "Job details",
        "attributes": [
          {
            "id": 5021,
            "name": "Job description",
            "type": "Text field (multiple line)"
          },
          {
            "id": 5022,
            "name": "Location",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5262,
                "name": "US office"
              },
              {
                "id": 5263,
                "name": "India office"
              }
            ]
          },
          {
            "id": 5023,
            "name": "Desk location",
            "type": "Text field (single line)"
          }
        ]
      },
      {
        "id": 1049,
        "name": "Personal details",
        "attributes": [
          {
            "id": 5024,
            "name": "Gender",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5264,
                "name": "Male"
              },
              {
                "id": 5265,
                "name": "Female"
              },
              {
                "id": 5266,
                "name": "Not disclosed"
              }
            ]
          },
          {
            "id": 5025,
            "name": "Marital status",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5267,
                "name": "Single"
              },
              {
                "id": 5268,
                "name": "Married"
              },
              {
                "id": 5269,
                "name": "Not disclosed"
              }
            ]
          },
          {
            "id": 5026,
            "name": "Blood group",
            "type": "Select list (single choice)",
            "values": [
              {
                "id": 5270,
                "name": "A positive"
              },
              {
                "id": 5271,
                "name": "A negative"
              },
              {
                "id": 5272,
                "name": "B positive"
              },
              {
                "id": 5273,
                "name": "B negative"
              },
              {
                "id": 5274,
                "name": "O positive"
              },
              {
                "id": 5275,
                "name": "O negative"
              },
              {
                "id": 5276,
                "name": "AB positive"
              },
              {
                "id": 5277,
                "name": "AB negative"
              }
            ]
          },
          {
            "id": 5027,
            "name": "Date of birth",
            "type": "Date picker",
            "format": "dd-MM-yyyy"
          },
          {
            "id": 5029,
            "name": "Nationality",
            "type": "Text field (single line)"
          }
        ]
      },
      {
        "id": 1050,
        "name": "Contact details",
        "attributes": [
          {
            "id": 5030,
            "name": "Phone no.",
            "type": "Text field (single line)"
          },
          {
            "id": 5031,
            "name": "Address",
            "type": "Text field (multiple line)"
          },
          {
            "id": 5032,
            "name": "Emergency contact",
            "type": "Text field (single line)"
          },
          {
            "id": 5033,
            "name": "Skype",
            "type": "Text field (single line)"
          }
        ]
      },
      {
        "id": 1051,
        "name": "Bank Details",
        "attributes": [
          {
            "id": 5034,
            "name": "Bank Name",
            "type": "Text field (single line)"
          },
          {
            "id": 5035,
            "name": "Bank Account Number",
            "type": "Numeric field"
          },
          {
            "id": 5036,
            "name": "Bank IFSC",
            "type": "Text field (single line)"
          }
        ]
      },
      {
        "id": 1052,
        "name": "Project Details",
        "attributes": [
          {
            "id": 5037,
            "name": "Reporting Manager",
            "type": "User picker (single select)",
            "usersApiUrl": "<baseURL>/rest/upraise/public/1.0/directory/1829/getUsersForSegment"
          },
          {
            "id": 5038,
            "name": "Trainer",
            "type": "User picker (multiple select)",
            "usersApiUrl": "<baseURL>/rest/upraise/public/1.0/directory/1829/getUsersForSegment"
          },
          {
            "id": 5039,
            "name": "Preferred Technology",
            "type": "Select list (multiple choice)",
            "values": [
              {
                "id": 5278,
                "name": "Java"
              },
              {
                "id": 5279,
                "name": "Python"
              },
              {
                "id": 5280,
                "name": "C++"
              },
              {
                "id": 5281,
                "name": "C"
              }
            ]
          }
        ]
      }
    ]
  }
]

Response parameters

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
The below parameters are related to the default user attribute Role
	field	String	This parameter is UpRaise user’s UpRaise role	role
	type	String	This parameter defines the field type of the role attribute	Single select field
	values	String	This parameter defines the value parameters of role attribute	id name type
values	id	Number	Id of the user role	78, 43, etc.
values	name	String	Name of the role	User Admin Super Admin No access Any custom role
values	type	String	Type of the user attribute	Default
The below parameters are related to the default user attribute Designation
	field	String	This parameter is UpRaise user’s designation	designation
	type	String	This parameter defines the field type of the attribute	Single select field
	values	String	This parameter defines the value parameters of designation attribute	id name
	id	Number	Id of the user role	80, 38, etc.
	name	String	Name of the role	Sales manager Support Executive Any employee designation
	type	String	Type of the user attribute	Default
The below parameters are related to the default user attribute Teams
	field	String	This parameter is UpRaise user’s default team	designation
	type	String	This parameter defines the field type of the attribute	multiple select
	teamsApiUrl	String	This parameter is for the team’s UpRaise API URL	<baseURL>/rest/upraise/public/1.0/directory/teams
The below parameters are related to the default user attribute Manager
	field	String	This parameter is UpRaise user’s default manager	manager
	type	String	This parameter defines the field type of the attribute	single select
	usersApiUrl	String	This parameter is for the UpRaise API URL of the user who is assigned as manager	<baseURL>/rest/upraise/public/1.0/directory/1829/getUsersForSegment
Below attributes are the custom attributes created by UpRaise admins under the different custom sections
	field	String	Custom attribute parameter	Custom attributes
	sections	Array	This Array contains all custom sections and attributes of UpRaise users	Different custom sections and their attributes
sections	id	Number	ID of the section	12, 78, etc.
sections	name	String	Name of the section	Employment details Contact details Personal details Job details
sections	attributes	Array	This Array contains all the attributes of the given section	id, type, and name of each attribute under this Array
attributes	id	Number	ID of the attribute	62, 67, etc.
attributes	type	String	Different types of attributes can be added in sections. Based on the selected type each attribute will have relevant parameters under each parameter	Text field (single line) Text field (Multi-line) Select list (single choice) Select list (multiple choice) Date picker User picker (single select) User picker (multiple select) Numeric field
attributes	name	String	Name of the attribute	Employee id Contact number Address Skills
	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.	id name
values	id	Number	Id of the value	53, 45, etc.
	name	String	Name of the attribute	The possible values are based on the type of field attribute. Eg. Skill, status, etc.
	usersApiUrl	String	User’s UpRaise API URL. This parameter is applicable when the attribute field type is a single or multi-select user	<baseURL>/rest/upraise/public/1.0/directory/1829/getUsersForSegment
	format	String	This parameter is used when there is a date type attribute field	Any date