Role

URL

https://api.primaerp.com/v1/roles

https://api.primaerp.com/v1/roles/{id}/users

https://api.primaerp.com/v1/roles/{id}/competencies

Properties

Name Type Access Required Description
builtInRole BuiltInRole read only no If it is set, then the role is generated automatically and cannot be edited.
createdAt Date read only no Date of creation.
displayName String read only no Describes an object in human readable form.
id String read write no Unique object identifier.
name String read write no The name of an custom user's role. Built-in roles do not have a name.
product Product read write no Product, only custom roles can be edited.
roleType RoleType read write no Role type, only custom roles can be edited.
trashItem TrashItem read write no Informs whether an object is in the trash. An object is in the trash if a trash item was specified.
updatedAt Date read only no Last modified date.
version Long read write no Object version number.

Metadata

{
    "type" : "Role",
    "path" : "/v1/roles",
    "fields" : [
        {
            "type" : "BuiltInRole",
            "name" : "builtInRole",
            "description" : "If it is set, then the role is generated automatically and cannot be edited.",
            "access" : "READ_ONLY",
            "constraints" : [
                {
                    "type" : "Enum",
                    "details" : "TIME_USER, OWNER, ADMIN, PROJECT_MANAGER, PRICE_EDITOR, BILLING_USER, ATTENDANCE_USER, ATTENDANCE_ADVANCED_USER, ATTENDANCE_MANAGER, TEAM_OBSERVER"
                }
            ]
        },
        {
            "type" : "Date",
            "name" : "createdAt",
            "description" : "Date of creation.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "String",
            "name" : "displayName",
            "description" : "Describes an object in human readable form.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "String",
            "name" : "id",
            "description" : "Unique object identifier.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "Pattern",
                    "details" : "regexp [0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}"
                },
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "type" : "String",
            "name" : "name",
            "description" : "The name of an custom user's role. Built-in roles do not have a name.",
            "access" : "READ_WRITE"
        },
        {
            "type" : "Product",
            "name" : "product",
            "description" : "Product, only custom roles can be edited.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "Enum",
                    "details" : "CORE, TIME, BILLING, ATTENDANCE"
                }
            ]
        },
        {
            "type" : "RoleType",
            "name" : "roleType",
            "description" : "Role type, only custom roles can be edited.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "Enum",
                    "details" : "IMPLICIT, EXPLICIT, CUSTOM"
                }
            ]
        },
        {
            "type" : "TrashItem",
            "path" : "/v1/trash",
            "name" : "trashItem",
            "description" : "Informs whether an object is in the trash. An object is in the trash if a trash item was specified.",
            "access" : "READ_WRITE"
        },
        {
            "type" : "Date",
            "name" : "updatedAt",
            "description" : "Last modified date.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "Long",
            "name" : "version",
            "description" : "Object version number.",
            "access" : "READ_WRITE"
        }
    ],
    "cascades" : [
        {
            "cascadeType" : "REMOVE",
            "objectTypes" : [
                "TrashItem"
            ]
        }
    ]
}

Dummy data

{
    "id" : "d371aedb-00cc-432b-bdee-ec147d707072",
    "createdAt" : "/Date(1489387213945)/",
    "updatedAt" : "/Date(1489420393945)/",
    "version" : 5,
    "name" : "Admin",
    "builtInRole" : "ADMIN",
    "roleType" : "EXPLICIT",
    "product" : "CORE",
    "displayName" : "ADMIN"
}