Find profile type by id

GET 
/profile_types/:id

Find profile type by id

Request

Path Parameters

id uuidrequired

ID of the object to retrieve, update, or delete

Responses

200

Expected response to a valid request

application/json

Schema

Schema

profile_type object
id uuid
The objects ID.
uid string
Possible values: >= 32 characters and <= 32 characters
The objects UID.
name string
This is the name of the profile type.
category string
Possible values: [employee, non-employee, organization, assignment, other]
This is the category the profile type falls into.
bypass_dup_protection boolean
Whether or not duplication protection is bypassed.
archived boolean
Whether or not the profile type is archived.
permitted_role_ids uuid[]
The role ids that are permitted for this profile type.
isc_synced boolean
Is this profile type synced with ics
profile_type_dup_attributes object[]
Array [
id uuid
The ID of the properties that are used for duplication protection.
uid string
Possible values: >= 32 characters and <= 32 characters
The uid of the properties that are used for duplication protection.
profile_type_id uuid
The ID of the profile type.
ne_attribute_id uuid
The ID of the ne attribute.
]
profile_type_namings object[]
Array [
id uuid
The ID of the profile type naming.
uid string
Possible values: >= 32 characters and <= 32 characters
The UID of the profile type naming.
profile_type_id uuid
The ID of the associated profile type.
ne_attribute_id uuid
The ID of the associated ne attribute.
order integer
The order that the namings are used in.
]

Example (from schema)

{
  "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
      }
    ]
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...