Description
Configuration is where install specific data will be housed. This will represent a single row in a Configuration database table. A default Configuration record will be loaded on initial startup/deployment of the SSP application.Requires Administrator level access.
Get Configuration
GET /ssp/api/1/reference/configurationconfig
Security
SERVICE_REFERENCE_READ
Returns
All Configuration Values
| Code Block |
|---|
{success: "idtrue",
message: "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" ",
results: 13,
rows: [
{id: "e99ff3c7-6a59-4812-b3b1-285fa8764d3a",
createdDate: 1337878800000,
createdBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
modifiedDate: 1337878800000,
modifiedBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
objectStatus: "ACTIVE",
name: "defaultEarlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280inst_name",
description: "Institution name",
"documentStorageLocation" : "C:\SSP\Documents"} |
Save Configuration
...
value: "My Edu",
valueValidation: null,
defaultValue: "My Edu",
sortOrder: 99}
]
}
|
Get Configuration by Parameter
GET /ssp/api/1/reference/configuration/{id}Sample Postconfig?name='parameter'
Security
SERVICE_REFERENCE_READ
Returns
Configuration Values by Parameters
| Code Block |
|---|
{"id" : "6201b18d59dbcf48-9d1d9be3-48d311e1-82d4bded-092e52ad676b0026b9e7ff4c",
"createdById" createdDate: 1336417200000,
createdBy:
{id: "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
firstName: "createdDateSystem",
lastName: "1332216000000"Administrator"},
modifiedDate: 1336417200000,
modifiedBy: "modifiedById"
{id: "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
firstName: "modifiedDateSystem",
lastName: "1332216000000Administrator"},
objectStatus: "objectStatusACTIVE",
name: "ACTIVEbcc_email_address",
description: "defaultEarlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"documentStorageLocation" : "C:\SSP\Documents"} |
Returns
Configuration
The email address to blind carbon copy on every message",
value: "noone@test.com",
valueValidation: null,
defaultValue: "noone@test.com",
sortOrder: 100} |
Save Configuration
PUT /ssp/api/1/reference/config/{id}
Note that default values cannot be modified via this resource.
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"name": "createdByIdbcc_email_address",
"description": "91f46e39-cea8-422b-b215-00f6bcf5d280The email address to blind carbon copy on every message",
"createdDate" :value": "noone@test.com",
"1332216000000valueValidation": null,
"sortOrder": "modifiedById100} |
Returns
Configuration
| Code Block |
|---|
{"id" : "91f46e396201b18d-cea89d1d-422b48d3-b21582d4-00f6bcf5d280092e52ad676b", "modifiedDatename" : "1332216000000bcc_email_address", "objectStatusdescription" : "ACTIVEThe email address to blind carbon copy on every message", "defaultEarlyAlertCoordinatorIdvalue" : "91f46e39-cea8-422b-b215-00f6bcf5d280noone@test.com", "documentStorageLocationvalueValidation": :null, "C:\SSP\Documents"sortOrder": 100} |