Update a profile type by id
PATCH/profile_types/:id
Update a profile type by id
Request
Path Parameters
ID of the object to retrieve, update, or delete
- application/json
Body
required
- Array [
- ]
- Array [
- ]
profile_type object
This is the name of the profile type.
Possible values: [employee
, non-employee
, organization
, assignment
, other
]
This is the category the profile type falls into.
Whether or not duplication protection is bypassed.
Whether or not the profile type is archived.
The role ids that are permitted for this profile type.
Default value: false
Is this profile type synced with ics
profile_type_dup_attributes object[]
The ID of the properties that are used for duplication protection.
Possible values: >= 32 characters
and <= 32 characters
The uid of the properties that are used for duplication protection.
The ID of the profile type.
The ID of the ne attribute.
profile_type_namings object[]
The ID of the profile type naming.
Possible values: >= 32 characters
and <= 32 characters
The UID of the profile type naming.
The ID of the associated profile type.
The ID of the associated ne attribute.
The order that the namings are used in.
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
profile_type object
The objects ID.
Possible values: >= 32 characters
and <= 32 characters
The objects UID.
This is the name of the profile type.
Possible values: [employee
, non-employee
, organization
, assignment
, other
]
This is the category the profile type falls into.
Whether or not duplication protection is bypassed.
Whether or not the profile type is archived.
The role ids that are permitted for this profile type.
Is this profile type synced with ics
profile_type_dup_attributes object[]
The ID of the properties that are used for duplication protection.
Possible values: >= 32 characters
and <= 32 characters
The uid of the properties that are used for duplication protection.
The ID of the profile type.
The ID of the ne attribute.
profile_type_namings object[]
The ID of the profile type naming.
Possible values: >= 32 characters
and <= 32 characters
The UID of the profile type naming.
The ID of the associated profile type.
The ID of the associated ne attribute.
The order that the namings are used in.
{
"profile_type": {
"id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"uid": "ptUid",
"name": "Worker",
"category": "employee",
"bypass_dup_protection": false,
"archived": false,
"permitted_role_ids": [
"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"
],
"isc_synced": false,
"profile_type_dup_attributes": [
{
"id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"uid": "attribute-uid",
"profile_type_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"ne_attribute_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8"
}
],
"profile_type_namings": [
{
"id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"uid": "profile-type-name",
"profile_type_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"ne_attribute_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"order": 0
}
]
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- InvalidJson
- ValidationErrors
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}