ExternalSystem

URL

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

Properties

Metadata

{
    "type" : "ExternalSystem",
    "path" : "/v1/externalsystems",
    "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" : "String",
            "name" : "integrationPlugin",
            "description" : "The name of the third-party system integrated into prima:Time.",
            "access" : "READ_WRITE"
        },
        {
            "type" : "String",
            "name" : "name",
            "description" : "The name of the external system",
            "access" : "READ_WRITE"
        },
        {
            "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" : "0e897901-4cc3-46b6-a5e7-c96d847b6989",
    "createdAt" : "/Date(1651049967382)/",
    "updatedAt" : "/Date(1651100907382)/",
    "version" : 4,
    "name" : "My BaseCamp account",
    "integrationPlugin" : "basecamp",
    "displayName" : "My BaseCamp account"
}