Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

All Configuration Values

Code Block
{success: "true",
 message: "",
 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: "inst_name",
   description: "Institution name",
   value: "My Edu",
   valueValidation: null,
   defaultValue: "My Edu",
   sortOrder: 99}
  ]
}

Get Configuration by Parameter

...

PUT /ssp/api/1/reference/config/{id}

Note that default values cannot be modified via this resource.

Security

SERVICE_REFERENCE_WRITE

...

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280name": "bcc_email_address",
     "firstNamedescription" : "John",The email address to blind carbon "lastName"copy : "Doe"},  
 "createdDate" : "1332216000000"on every message",
 "modifiedByvalue" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"noone@test.com",
     "firstNamevalueValidation" : "John"null,
     "lastNamesortOrder" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "documentStorageLocation" : "C:\SSP\Documents",
 "institutionName" : "Sinclair Community College",
 "termToRepresentEarlyAlert" : "Early Alert",
 "coachSetFromExternalData" : false}100}

Returns

Configuration

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdByname" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
   "bcc_email_address",
 "firstNamedescription" : "John",The email address to blind carbon "lastName"copy : "Doe"},  
 "createdDate" : "1332216000000"on every message",
 "modifiedByvalue" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""noone@test.com",
     "firstNamevalueValidation" : "John"null,
     "lastNamesortOrder" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "documentStorageLocation" : "C:\SSP\Documents",
 "institutionName" : "Sinclair Community College",
 "termToRepresentEarlyAlert" : "Early Alert",
 "coachSetFromExternalData" : false: 100}