UserRole

URL

https://api.primatime.com/v1/userroles

Properties

Metadata

{
    "type" : "UserRole",
    "path" : "/v1/userroles",
    "fields" : [
        {
            "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" : "Role",
            "path" : "/v1/roles",
            "name" : "role",
            "description" : "Role which has an user.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "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" : "User",
            "path" : "/v1/users",
            "name" : "user",
            "description" : "User who has a role.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "type" : "Long",
            "name" : "version",
            "description" : "Object version number.",
            "access" : "READ_WRITE"
        }
    ],
    "cascades" : [
        {
            "cascadeType" : "REMOVE",
            "objectTypes" : [
                "TrashItem"
            ]
        }
    ]
}

Dummy data

{
    "id" : "ca9ccfa4-46cf-477d-9e13-15261dfeb505",
    "createdAt" : "/Date(1651049127107)/",
    "updatedAt" : "/Date(1651086507107)/",
    "version" : 0,
    "user" : {
        "id" : "05153cf6-0160-4296-8922-029001003d91",
        "createdAt" : "/Date(1651049847107)/",
        "updatedAt" : "/Date(1651086507107)/",
        "version" : 9,
        "firstName" : "John",
        "lastName" : "Doe",
        "nickName" : "Johny D.",
        "email" : "v4_9n4blj186l5r@testdata.com",
        "phone" : "55 234 555 678",
        "position" : "Senior developer",
        "timeZone" : "America/Sao_Paulo",
        "dateFormat" : "yyyy-MM-dd",
        "timeFormat" : "K:mm a",
        "weekStart" : 7,
        "language" : "pt_BR",
        "password" : "vlaufr8vkna_qfn6il91",
        "secretKey" : "userSecretKey",
        "confirmed" : false,
        "confirmedEmail" : false,
        "active" : false,
        "birthdayRemind" : "/Date(1652911200000)/",
        "workingTimeStart" : "/Date(1651039200000)/",
        "workingTimeEnd" : "/Date(1651071600000)/",
        "created" : "/Date(1650964107107)/",
        "admin" : false,
        "projectManager" : false,
        "displayName" : "Doe John"
    },
    "role" : {
        "id" : "fbd2b452-7a3d-4fc0-9948-ba58a631d883",
        "createdAt" : "/Date(1651049787108)/",
        "updatedAt" : "/Date(1651133307108)/",
        "version" : 3,
        "name" : "Admin",
        "builtInRole" : "ADMIN",
        "roleType" : "EXPLICIT",
        "product" : "CORE",
        "displayName" : "ADMIN"
    },
    "displayName" : "Doe John [ADMIN]"
}