Customuserinfo API
Description
Use the customuserinfo API for managing custom user definitions. Three resources are used: customuserinfo/definition, customuserinfo/value, and customuserinfo/user.
Identifier
Simple, the ID of the object (a long value)
Parameters
None
Representation of customuserinfo/definition
{
"id":"_id of definition_",
"description":"_definition description_",
"name":"_definition name_"
}
Representation of customuserinfo/value
{
"userId":"_id of user_",
"value":"_content of the value_",
"definitionId":"_id of definition_"
}
Representation of customuserinfo/user
{
"userId":"_id of user_",
"value":"_content of the value_",
"definitionId":{
"id" : "_id of definition_",
"description" : "_definition description_",
"name" : "_definition name_"
}
}
Methods
The methods used for these resources are:
- GET
- POST
- PUT
- DELETE
Platform API
Platform
Description
Handle the platform. This requires a platform session. Log in using the platformloginservice servlet.
Identifier
unusedid, the id is not used because there is only one platform
Representation
{
"createdBy":"_the user name of the platform administrator_",
"created":"_the creation date_",
"initialVersion":"_the version in which the platform was created_",
"state":"_can be STARTED or STOPPED_",
"previousVersion":"_the previous version the platform was in or empty if there is none_",
"version":"_the current version of the platform_"
}
Methods
The methods used for this resource are:
- GET - get the current platform
- POST - create the platform
- PUT - start or stop the platform
- DELETE - destroy the platform