CampusAPI Configuration Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/configuration
Overview
The Configuration service package defines a set of interfaces for configuration retrieval and management. It may be used to store user profiles or as a means to assist service implementors to modularize configuration data.
This package includes the following entities:
Parameters
Configuration data is expressed through a set of Parameters and Values. A Parameter is rule with a unique Id and a syntax that indicates a primitive type. A Parameter may map to zero or more Values of the same syntax. An application requesting a configuration looks up Values given a Parameter Id.
As a Rule, Parameters may resolve to implicitly created Values based on external rule evaluations.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this parameter, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this parameter, provided by system. | string(uri) |
| displayName | The name of this parameter for display. | string |
| description | The description of this parameter. | string |
| genusTypeId (read‑only) | Id of the immutable type of this parameter. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this parameter. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| active (read‑only) | Whether this parameter is active. Active is true if operational is true and disabled is false, or enabled is true. | boolean |
| enabled | Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler. | boolean |
| disabled | Whether this parameter is administravely disabled. Administratively disabling overrides any applied enabler. | boolean |
| operational (read‑only) | Whether this parameter is operational. This parameter is operational if any of the applied enablers are true. | boolean |
| ruleId | An explicit rule for this parameter. References a rules.Rule object. | string(osid‑id) |
| valueSyntaxIds | The syntax for the values of this parameter. References an array of osid.Sy objects. | string(osid‑id)[] |
| valueCoordinateType | The type of the value if the syntax is a coordinate. | string(osid‑type) |
| valueHeadingType | The type of the value if the syntax is a heading. | string(osid‑type) |
| valueObjectType | The type of the value if the syntax is an object. | string(osid‑type) |
| valueSpatialUnitRecordType | The type of the value if the syntax is a spatial unit. | string(osid‑type) |
| valueVersionScheme | The type of the value if the syntax is a version. | string(osid‑type) |
| valuesShuffled | Tests if if the values assigned to this parameter will be shuffled or values are sorted by index. | boolean |
Values
Values represent primitive types that are assigned to Parameters and constrained by the syntax specified in its Parameter. In the most basic case, a single Value is created for a Parameter and returned when the Parameter is resolved. Parameters can have multiple Values where the Configuration consumer can request all Values, or a single Value selected by the Provider implementation.
Values are Operable such that Values in multi-valued Parameter may be enabled or disabled manually or based on a rule. For example, the configuration of a service may change based on time of day or may change based on some out-of-band context. Value retrievals support passing of a ValueCondition to supply contextual information to feed the rule evaluation.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this value, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this value, provided by system. | string(uri) |
| displayName | The name of this value for display. | string |
| description | The description of this value. | string |
| genusTypeId (read‑only) | Id of the immutable type of this value. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this value. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| parameterId (read‑only) | The parameter associated with this value. References a configuration.Parameter object. | string(osid‑id) |
| priority | The priority of this value. | integer |
| booleanValue | The value if it is a boolean. | boolean |
| byteValue | -- could someone please write a description for this -- | SYNTAX_TYPE_NOT_FOUND: NONE |
| cardinalValue | The value if it is a cardinal. | integer |
| coordinateValue | The value if it is a coordinate. | SYNTAX_TYPE_NOT_FOUND: COORDINATE |
| currencyValue | The value if it is a currency. | string(currency) |
| dateTimeValue | The value if it is a DateTime. | string(date‑time) |
| decimalValue | The value if it is a decimal. | number |
| distanceValue | The value if it is a Distance. | SYNTAX_TYPE_NOT_FOUND: DISTANCE |
| durationValue | The value if it is a Duration. | string(duration) |
| idValueId | -- could someone please write a description for this -- References an id.Id object | string(osid‑id) |
| integerValue | The value if it is an integer. | integer |
| spatialUnitValue | The value if it is a spatial unit. | object(spatial-unit) |
| speedValue | The value if it is a speed. | SYNTAX_TYPE_NOT_FOUND: SPEED |
| stringValue | The value if it is a string. | string |
| timeValue | The value if it is a DateTime. | string(time) |
| typeValue | The value if it is a Type. | string(osid‑type) |
| versionValue | The value if it is a version. | SYNTAX_TYPE_NOT_FOUND: VERSION |
| objectValue | The value if it is an object. | SYNTAX_TYPE_NOT_FOUND: NONE |
Configurations
To create a configuration for an application, a Configuration object is created. The Configuration maps a set of Parameters and their Values. A Configuration may be positioned as a child of another Configuration to inherit its Parameters and Values. The desired Parameters are then mapped to the Configuration and Values assigned.
Parameters may be stored without values in separate Configurations for reuse or standardization.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this configuration, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this configuration, provided by system. | string(uri) |
| displayName | The name of this configuration for display. | string |
| description | The description of this configuration. | string |
| genusTypeId (read‑only) | Id of the immutable type of this configuration. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this configuration. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this configuration. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this configuration. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this configuration. | string |
| registry | -- could someone please write a description for this -- | SYNTAX_TYPE_NOT_FOUND: NONE |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/values
Collection of values in a system, federation of systems, or in a default configuration.
get
Get all values in the system or default configuration.
post
Create a new value in the default configuration.
get /values
Get all values in the system or default configuration.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleValueType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleValueType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleValueType%40campusapi.org - parameterId: (string)
the id string to match a parameter.
Example:
configuration.Parameter%3A585%40base.url - configurationId: (string)
The id string to match a configuration
Example:
configuration.Configuration%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Value:1489@base.url",
"uri": "http://base.url/open/campusapi/configuration/value/configuration.Value%3A1489%40base.url",
"displayName": "Display Name of this Value",
"description": "The description of this Value",
"genusTypeId": "type.Type:defaultValueType@base.url",
"recordTypeIds": [ "type.Type:exampleValueRecordType@campusapi.org", "..."],
"parameterId": "configuration.Parameter:6955@base.url",
"priority": 19,
"booleanValue": true,
"bytesValue": [ "..byte[]..", "..." ],
"cardinalValue": 19,
"coordinateValue": "..Coordinate..",
"currencyValue": "USD+42.00",
"dateTimeValue": "2021-07-21T23:15:30.000Z",
"decimalValue": 3.14,
"distanceValue": "..Distance..",
"durationValue": "P3DT3H",
"idValueId": "id.Id:4139@base.url",
"integerValue": 19,
"spatialUnitValue": "..SpatialUnit..",
"speedValue": "..Speed..",
"stringValue": "This is the string for StringValue",
"timeValue": "..Time..",
"typeValue": "type.Type:2798@base.url",
"versionValue": "..Version.."
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /values
Create a new value in the default configuration.
Query Parameters
- parameterId: required(string)
the parameter of this value.
Example:
configuration.Parameter%3A585%40base.url - genusType: (string)
specify a particular value type to create
Example:
type.Type%3AexampleValueType%40dxtera.org - recordType: (array of )
specify support for one or more value record types
Example:
[ "type.Type%3AexampleValueRecordType%40campusapi.org", "..." ] - configurationId: (string)
specify in which configuration to create this value
Example:
configuration.Configuration%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Value",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this value, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this value, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this value for display.",
"type": "string"
},
"description": {
"description": "The description of this value.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this value. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this value. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"parameterId": {
"description": "The parameter associated with this value.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"priority": {
"description": "The priority of this value.",
"type": "integer",
"minimum": 1
},
"booleanValue": {
"description": "The value if it is a boolean.",
"type": "boolean"
},
"byteValue": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"cardinalValue": {
"description": "The value if it is a cardinal.",
"type": "integer",
"minimum": 1
},
"coordinateValue": {
"description": "The value if it is a coordinate.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"currencyValue": {
"description": "The value if it is a currency.",
"type": "string",
"format": "currency"
},
"dateTimeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "date-time"
},
"decimalValue": {
"description": "The value if it is a decimal.",
"type": "number"
},
"distanceValue": {
"description": "The value if it is a Distance.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"durationValue": {
"description": "The value if it is a Duration.",
"type": "string",
"format": "duration"
},
"idValueId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"format": "osid-id"
},
"integerValue": {
"description": "The value if it is an integer.",
"type": "integer"
},
"spatialUnitValue": {
"description": "The value if it is a spatial unit.",
"type": "string"
},
"speedValue": {
"description": "The value if it is a speed.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"stringValue": {
"description": "The value if it is a string.",
"type": "string"
},
"timeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "time"
},
"typeValue": {
"description": "The value if it is a Type.",
"type": "string",
"format": "osid-type"
},
"versionValue": {
"description": "The value if it is a version.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"objectValue": {
"description": "The value if it is an object.",
"type": "SYNTAX_TYPE_NOT_FOUND"
}
}
}Example:
{
"displayName": "Display Name of this Value",
"description": "The description of this Value",
"priority": 19,
"booleanValue": true,
"bytesValue": [ "..byte[]..", "..." ],
"cardinalValue": 19,
"coordinateValue": "..Coordinate..",
"currencyValue": "USD+42.00",
"dateTimeValue": "2021-07-21T23:15:30.000Z",
"decimalValue": 3.14,
"distanceValue": "..Distance..",
"durationValue": "P3DT3H",
"idValueId": "id.Id:6058@base.url",
"integerValue": 19,
"spatialUnitValue": "..SpatialUnit..",
"speedValue": "..Speed..",
"stringValue": "This is the string for StringValue",
"timeValue": "..Time..",
"typeValue": "type.Type:1813@base.url",
"versionValue": "..Version.."
}
Entity representing a value form metadata.
get
Get form metadata for creating a new value.
get /values/metadata
Get form metadata for creating a new value.
Query Parameters
- parameterId: required(string)
the parameter of this metadatum.
Example:
configuration.Parameter%3A585%40base.url - genusType: (string)
specify a particular value type to create
Example:
type.Type%3AexampleValueType%40dxtera.org - recordType: (array of )
specify support for one or more value record types
Example:
[ "type.Type%3AexampleValueRecordType%40campusapi.org", "..." ] - configurationId: (string)
specify in which configuration to create this value
Example:
configuration.Configuration%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Value",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this value, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this value, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this value for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Value.Value:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this value",
"linked": false
},
"description": {
"description": "The description of this value.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Value.Value:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this value",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this value. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this value. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"priority": {
"description": "The priority of this value.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:priority@dxtera.org",
"existingValue": 42,
"elementLabel": "Priority",
"instructions": "Enter the priority of this value.",
"linked": false
},
"booleanValue": {
"description": "The value if it is a boolean.",
"type": "boolean",
"elementId": "configuration.Value:booleanValue@dxtera.org",
"existingValue": false,
"elementLabel": "Boolean Value",
"instructions": "Enter true or false.",
"linked": false
},
"byteValue": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:byteValue@dxtera.org",
"existingValue": null,
"elementLabel": "Byte Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
},
"cardinalValue": {
"description": "The value if it is a cardinal.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:cardinalValue@dxtera.org",
"existingValue": 42,
"elementLabel": "Cardinal Value",
"instructions": "Enter the cardinal value of this value.",
"linked": false
},
"coordinateValue": {
"description": "The value if it is a coordinate.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:coordinateValue@dxtera.org",
"existingValue": null,
"elementLabel": "Coordinate Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR COORDINATE.",
"linked": false
},
"currencyValue": {
"description": "The value if it is a currency.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:currencyValue@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Currency Value",
"instructions": "Enter the currency value of this value.",
"linked": false
},
"dateTimeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:dateTimeValue@dxtera.org",
"existingValue": "",
"elementLabel": "Date Time Value",
"instructions": "Enter the date time value of this value.",
"linked": false
},
"decimalValue": {
"description": "The value if it is a decimal.",
"type": "number",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:decimalValue@dxtera.org",
"existingValue": 3.14,
"elementLabel": "Decimal Value",
"instructions": "Enter the decimal value of this value.",
"linked": false
},
"distanceValue": {
"description": "The value if it is a Distance.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:distanceValue@dxtera.org",
"existingValue": null,
"elementLabel": "Distance Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR DISTANCE.",
"linked": false
},
"durationValue": {
"description": "The value if it is a Duration.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:durationValue@dxtera.org",
"existingValue": "",
"elementLabel": "Duration Value",
"instructions": "Enter the duration value of this value.",
"linked": false
},
"idValueId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:idValue@dxtera.org",
"existingValue": null,
"elementLabel": "Id Value",
"instructions": "Enter the Id of the id value for this value.",
"linked": false
},
"integerValue": {
"description": "The value if it is an integer.",
"type": "integer",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:integerValue@dxtera.org",
"existingValue": 42,
"elementLabel": "Integer Value",
"instructions": "Enter the integer value of this value.",
"linked": false
},
"spatialUnitValue": {
"description": "The value if it is a spatial unit.",
"type": "string",
"elementId": "configuration.Value:spatialUnitValue@dxtera.org",
"existingValue": null,
"elementLabel": "Spatial Unit Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR SPATIALUNIT.",
"linked": false
},
"speedValue": {
"description": "The value if it is a speed.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:speedValue@dxtera.org",
"existingValue": null,
"elementLabel": "Speed Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR SPEED.",
"linked": false
},
"stringValue": {
"description": "The value if it is a string.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:stringValue@dxtera.org",
"existingValue": "The existing string value",
"elementLabel": "String Value",
"instructions": "Enter a string value for this value.",
"linked": false
},
"timeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:timeValue@dxtera.org",
"existingValue": "",
"elementLabel": "Time Value",
"instructions": "Enter the time value of this value.",
"linked": false
},
"typeValue": {
"description": "The value if it is a Type.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:typeValue@dxtera.org",
"existingValue": null,
"elementLabel": "Type Value",
"instructions": "Enter the Type id of the type value for this value.",
"linked": false
},
"versionValue": {
"description": "The value if it is a version.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:versionValue@dxtera.org",
"existingValue": null,
"elementLabel": "Version Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR VERSION.",
"linked": false
},
"objectValue": {
"description": "The value if it is an object.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:objectValue@dxtera.org",
"existingValue": null,
"elementLabel": "Object Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a value
get
Get a value given its id.
put
Update a given value.
delete
Delete a given value.
get /values/{valueId}
Get a value given its id.
URI Parameters
- valueId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "configuration.Value:1489@base.url",
"uri": "http://base.url/open/campusapi/configuration/value/configuration.Value%3A1489%40base.url",
"displayName": "Display Name of this Value",
"description": "The description of this Value",
"genusTypeId": "type.Type:defaultValueType@base.url",
"recordTypeIds": [ "type.Type:exampleValueRecordType@campusapi.org", "..."],
"parameterId": "configuration.Parameter:6955@base.url",
"priority": 19,
"booleanValue": true,
"bytesValue": [ "..byte[]..", "..." ],
"cardinalValue": 19,
"coordinateValue": "..Coordinate..",
"currencyValue": "USD+42.00",
"dateTimeValue": "2021-07-21T23:15:30.000Z",
"decimalValue": 3.14,
"distanceValue": "..Distance..",
"durationValue": "P3DT3H",
"idValueId": "id.Id:4139@base.url",
"integerValue": 19,
"spatialUnitValue": "..SpatialUnit..",
"speedValue": "..Speed..",
"stringValue": "This is the string for StringValue",
"timeValue": "..Time..",
"typeValue": "type.Type:2798@base.url",
"versionValue": "..Version.."
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "value not found" }
put /values/{valueId}
Update a given value.
URI Parameters
- valueId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Value",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this value, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this value, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this value for display.",
"type": "string"
},
"description": {
"description": "The description of this value.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this value. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this value. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"parameterId": {
"description": "The parameter associated with this value.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"priority": {
"description": "The priority of this value.",
"type": "integer",
"minimum": 1
},
"booleanValue": {
"description": "The value if it is a boolean.",
"type": "boolean"
},
"byteValue": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"cardinalValue": {
"description": "The value if it is a cardinal.",
"type": "integer",
"minimum": 1
},
"coordinateValue": {
"description": "The value if it is a coordinate.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"currencyValue": {
"description": "The value if it is a currency.",
"type": "string",
"format": "currency"
},
"dateTimeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "date-time"
},
"decimalValue": {
"description": "The value if it is a decimal.",
"type": "number"
},
"distanceValue": {
"description": "The value if it is a Distance.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"durationValue": {
"description": "The value if it is a Duration.",
"type": "string",
"format": "duration"
},
"idValueId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"format": "osid-id"
},
"integerValue": {
"description": "The value if it is an integer.",
"type": "integer"
},
"spatialUnitValue": {
"description": "The value if it is a spatial unit.",
"type": "string"
},
"speedValue": {
"description": "The value if it is a speed.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"stringValue": {
"description": "The value if it is a string.",
"type": "string"
},
"timeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "time"
},
"typeValue": {
"description": "The value if it is a Type.",
"type": "string",
"format": "osid-type"
},
"versionValue": {
"description": "The value if it is a version.",
"type": "SYNTAX_TYPE_NOT_FOUND"
},
"objectValue": {
"description": "The value if it is an object.",
"type": "SYNTAX_TYPE_NOT_FOUND"
}
}
}Example:
{
"displayName": "Display Name of this Value",
"description": "The description of this Value",
"priority": 19,
"booleanValue": true,
"bytesValue": [ "..byte[]..", "..." ],
"cardinalValue": 19,
"coordinateValue": "..Coordinate..",
"currencyValue": "USD+42.00",
"dateTimeValue": "2021-07-21T23:15:30.000Z",
"decimalValue": 3.14,
"distanceValue": "..Distance..",
"durationValue": "P3DT3H",
"idValueId": "id.Id:6058@base.url",
"integerValue": 19,
"spatialUnitValue": "..SpatialUnit..",
"speedValue": "..Speed..",
"stringValue": "This is the string for StringValue",
"timeValue": "..Time..",
"typeValue": "type.Type:1813@base.url",
"versionValue": "..Version.."
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The value has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "value not found" }
delete /values/{valueId}
Delete a given value.
URI Parameters
- valueId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The value has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "value not found" }
Entity representing a value form metadata for update
get
Get form metadata for updating an existing value.
get /values/{valueId}/metadata
Get form metadata for updating an existing value.
URI Parameters
- valueId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Value",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this value, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this value, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this value for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Value.Value:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this value",
"linked": false
},
"description": {
"description": "The description of this value.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Value.Value:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this value",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this value. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this value. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"priority": {
"description": "The priority of this value.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:priority@dxtera.org",
"existingValue": 42,
"elementLabel": "Priority",
"instructions": "Enter the priority of this value.",
"linked": false
},
"booleanValue": {
"description": "The value if it is a boolean.",
"type": "boolean",
"elementId": "configuration.Value:booleanValue@dxtera.org",
"existingValue": false,
"elementLabel": "Boolean Value",
"instructions": "Enter true or false.",
"linked": false
},
"byteValue": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:byteValue@dxtera.org",
"existingValue": null,
"elementLabel": "Byte Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
},
"cardinalValue": {
"description": "The value if it is a cardinal.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:cardinalValue@dxtera.org",
"existingValue": 42,
"elementLabel": "Cardinal Value",
"instructions": "Enter the cardinal value of this value.",
"linked": false
},
"coordinateValue": {
"description": "The value if it is a coordinate.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:coordinateValue@dxtera.org",
"existingValue": null,
"elementLabel": "Coordinate Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR COORDINATE.",
"linked": false
},
"currencyValue": {
"description": "The value if it is a currency.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:currencyValue@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Currency Value",
"instructions": "Enter the currency value of this value.",
"linked": false
},
"dateTimeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:dateTimeValue@dxtera.org",
"existingValue": "",
"elementLabel": "Date Time Value",
"instructions": "Enter the date time value of this value.",
"linked": false
},
"decimalValue": {
"description": "The value if it is a decimal.",
"type": "number",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:decimalValue@dxtera.org",
"existingValue": 3.14,
"elementLabel": "Decimal Value",
"instructions": "Enter the decimal value of this value.",
"linked": false
},
"distanceValue": {
"description": "The value if it is a Distance.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:distanceValue@dxtera.org",
"existingValue": null,
"elementLabel": "Distance Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR DISTANCE.",
"linked": false
},
"durationValue": {
"description": "The value if it is a Duration.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:durationValue@dxtera.org",
"existingValue": "",
"elementLabel": "Duration Value",
"instructions": "Enter the duration value of this value.",
"linked": false
},
"idValueId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:idValue@dxtera.org",
"existingValue": null,
"elementLabel": "Id Value",
"instructions": "Enter the Id of the id value for this value.",
"linked": false
},
"integerValue": {
"description": "The value if it is an integer.",
"type": "integer",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "configuration.Value:integerValue@dxtera.org",
"existingValue": 42,
"elementLabel": "Integer Value",
"instructions": "Enter the integer value of this value.",
"linked": false
},
"spatialUnitValue": {
"description": "The value if it is a spatial unit.",
"type": "string",
"elementId": "configuration.Value:spatialUnitValue@dxtera.org",
"existingValue": null,
"elementLabel": "Spatial Unit Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR SPATIALUNIT.",
"linked": false
},
"speedValue": {
"description": "The value if it is a speed.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:speedValue@dxtera.org",
"existingValue": null,
"elementLabel": "Speed Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR SPEED.",
"linked": false
},
"stringValue": {
"description": "The value if it is a string.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:stringValue@dxtera.org",
"existingValue": "The existing string value",
"elementLabel": "String Value",
"instructions": "Enter a string value for this value.",
"linked": false
},
"timeValue": {
"description": "The value if it is a DateTime.",
"type": "string",
"format": "time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:timeValue@dxtera.org",
"existingValue": "",
"elementLabel": "Time Value",
"instructions": "Enter the time value of this value.",
"linked": false
},
"typeValue": {
"description": "The value if it is a Type.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Value:typeValue@dxtera.org",
"existingValue": null,
"elementLabel": "Type Value",
"instructions": "Enter the Type id of the type value for this value.",
"linked": false
},
"versionValue": {
"description": "The value if it is a version.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:versionValue@dxtera.org",
"existingValue": null,
"elementLabel": "Version Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR VERSION.",
"linked": false
},
"objectValue": {
"description": "The value if it is an object.",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Value:objectValue@dxtera.org",
"existingValue": null,
"elementLabel": "Object Value",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "value not found" }
/parameters
Collection of parameters in a system, federation of systems, or in a default configuration.
get
Get all parameters in the system or default configuration.
post
Create a new parameter in the default configuration.
get /parameters
Get all parameters in the system or default configuration.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleParameterType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleParameterType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleParameterType%40campusapi.org - configurationId: (string)
The id string to match a configuration
Example:
configuration.Configuration%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Parameter:7597@base.url",
"uri": "http://base.url/open/campusapi/configuration/parameter/configuration.Parameter%3A7597%40base.url",
"displayName": "Display Name of this Parameter",
"description": "The description of this Parameter",
"genusTypeId": "type.Type:defaultParameterType@base.url",
"recordTypeIds": [ "type.Type:exampleParameterRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"ruleId": "rules.Rule:123@base.url",
"valueSyntax": "..Syntax..",
"valueCoordinateType": "type.Type:3371@base.url",
"valueHeadingType": "type.Type:4860@base.url",
"valueObjectType": "type.Type:86@base.url",
"valueSpatialUnitRecordType": "type.Type:9890@base.url",
"valueVersionScheme": "type.Type:6573@base.url",
"valuesShuffled": true
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /parameters
Create a new parameter in the default configuration.
Query Parameters
- genusType: (string)
specify a particular parameter type to create
Example:
type.Type%3AexampleParameterType%40dxtera.org - recordType: (array of )
specify support for one or more parameter record types
Example:
[ "type.Type%3AexampleParameterRecordType%40campusapi.org", "..." ] - configurationId: (string)
specify in which configuration to create this parameter
Example:
configuration.Configuration%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Parameter",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this parameter, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this parameter, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this parameter for display.",
"type": "string"
},
"description": {
"description": "The description of this parameter.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this parameter. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this parameter. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"active": {
"description": "Whether this parameter is active. Active is true if operational is true and disabled is false, or enabled is true.",
"type": "boolean",
"readOnly": true
},
"enabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this parameter is operational. This parameter is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"ruleId": {
"description": "An explicit Rule for this parameter.",
"type": "string",
"format": "osid-id"
},
"valueSyntaxIds": {
"description": "The syntax for the values of this parameter.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"valueCoordinateType": {
"description": "The type of the value if the syntax is a coordinate.",
"type": "string",
"format": "osid-type"
},
"valueHeadingType": {
"description": "The type of the value if the syntax is a heading.",
"type": "string",
"format": "osid-type"
},
"valueObjectType": {
"description": "The type of the value if the syntax is an object.",
"type": "string",
"format": "osid-type"
},
"valueSpatialUnitRecordType": {
"description": "The type of the value if the syntax is a spatial unit.",
"type": "string",
"format": "osid-type"
},
"valueVersionScheme": {
"description": "The type of the value if the syntax is a version.",
"type": "string",
"format": "osid-type"
},
"valuesShuffled": {
"description": "Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.",
"type": "boolean"
}
}
}Example:
{
"displayName": "Display Name of this Parameter",
"description": "The description of this Parameter",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"ruleId": "rules.Rule:123@base.url",
"valueSyntax": "..Syntax..",
"valueCoordinateType": "type.Type:2286@base.url",
"valueHeadingType": "type.Type:2746@base.url",
"valueObjectType": "type.Type:7063@base.url",
"valueSpatialUnitRecordType": "type.Type:4117@base.url",
"valueVersionScheme": "type.Type:1303@base.url",
"valuesShuffled": true
}
Entity representing a parameter form metadata.
get
Get form metadata for creating a new parameter.
get /parameters/metadata
Get form metadata for creating a new parameter.
Query Parameters
- genusType: (string)
specify a particular parameter type to create
Example:
type.Type%3AexampleParameterType%40dxtera.org - recordType: (array of )
specify support for one or more parameter record types
Example:
[ "type.Type%3AexampleParameterRecordType%40campusapi.org", "..." ] - configurationId: (string)
specify in which configuration to create this parameter
Example:
configuration.Configuration%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Parameter",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this parameter, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this parameter, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this parameter for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this parameter",
"linked": false
},
"description": {
"description": "The description of this parameter.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this parameter",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this parameter. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this parameter. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"enabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Parameter.Parameter:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this parameter is enabled",
"linked": false
},
"disabled": {
"description": "Whether this parameter is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Parameter.Parameter:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this parameter is enabled",
"linked": false
},
"ruleId": {
"description": "An explicit Rule for this parameter.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:rule@base.url",
"existingValue": "",
"elementLabel": "Rule",
"instructions": "Select a Rule to apply to this parameter",
"linked": false
},
"valueSyntax": {
"description": "The syntax for the values of this parameter.",
"type": "array",
"elementId": "configuration.Parameter:valueSyntax@dxtera.org",
"existingValue": [],
"elementLabel": "Value Syntax",
"instructions": "Enter Ids for value syntax of this parameter.",
"linked": false
},
"valueCoordinateType": {
"description": "The type of the value if the syntax is a coordinate.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueCoordinateType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Coordinate Type",
"instructions": "Enter the Type id of the value coordinate type for this parameter.",
"linked": false
},
"valueHeadingType": {
"description": "The type of the value if the syntax is a heading.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueHeadingType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Heading Type",
"instructions": "Enter the Type id of the value heading type for this parameter.",
"linked": false
},
"valueObjectType": {
"description": "The type of the value if the syntax is an object.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueObjectType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Object Type",
"instructions": "Enter the Type id of the value object type for this parameter.",
"linked": false
},
"valueSpatialUnitRecordType": {
"description": "The type of the value if the syntax is a spatial unit.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueSpatialUnitRecordType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Spatial Unit Record Type",
"instructions": "Enter the Type id of the value spatial unit record type for this parameter.",
"linked": false
},
"valueVersionScheme": {
"description": "The type of the value if the syntax is a version.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueVersionScheme@dxtera.org",
"existingValue": null,
"elementLabel": "Value Version Scheme",
"instructions": "Enter the Type id of the value version scheme for this parameter.",
"linked": false
},
"valuesShuffled": {
"description": "Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.",
"type": "boolean",
"elementId": "configuration.Parameter:valuesShuffled@dxtera.org",
"existingValue": false,
"elementLabel": "Values Shuffled",
"instructions": "Enter true or false.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a parameter
get
Get a parameter given its id.
put
Update a given parameter.
delete
Delete a given parameter.
get /parameters/{parameterId}
Get a parameter given its id.
URI Parameters
- parameterId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "configuration.Parameter:7597@base.url",
"uri": "http://base.url/open/campusapi/configuration/parameter/configuration.Parameter%3A7597%40base.url",
"displayName": "Display Name of this Parameter",
"description": "The description of this Parameter",
"genusTypeId": "type.Type:defaultParameterType@base.url",
"recordTypeIds": [ "type.Type:exampleParameterRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"ruleId": "rules.Rule:123@base.url",
"valueSyntax": "..Syntax..",
"valueCoordinateType": "type.Type:3371@base.url",
"valueHeadingType": "type.Type:4860@base.url",
"valueObjectType": "type.Type:86@base.url",
"valueSpatialUnitRecordType": "type.Type:9890@base.url",
"valueVersionScheme": "type.Type:6573@base.url",
"valuesShuffled": true
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "parameter not found" }
put /parameters/{parameterId}
Update a given parameter.
URI Parameters
- parameterId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Parameter",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this parameter, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this parameter, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this parameter for display.",
"type": "string"
},
"description": {
"description": "The description of this parameter.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this parameter. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this parameter. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"active": {
"description": "Whether this parameter is active. Active is true if operational is true and disabled is false, or enabled is true.",
"type": "boolean",
"readOnly": true
},
"enabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this parameter is operational. This parameter is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"ruleId": {
"description": "An explicit Rule for this parameter.",
"type": "string",
"format": "osid-id"
},
"valueSyntaxIds": {
"description": "The syntax for the values of this parameter.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"valueCoordinateType": {
"description": "The type of the value if the syntax is a coordinate.",
"type": "string",
"format": "osid-type"
},
"valueHeadingType": {
"description": "The type of the value if the syntax is a heading.",
"type": "string",
"format": "osid-type"
},
"valueObjectType": {
"description": "The type of the value if the syntax is an object.",
"type": "string",
"format": "osid-type"
},
"valueSpatialUnitRecordType": {
"description": "The type of the value if the syntax is a spatial unit.",
"type": "string",
"format": "osid-type"
},
"valueVersionScheme": {
"description": "The type of the value if the syntax is a version.",
"type": "string",
"format": "osid-type"
},
"valuesShuffled": {
"description": "Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.",
"type": "boolean"
}
}
}Example:
{
"displayName": "Display Name of this Parameter",
"description": "The description of this Parameter",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"ruleId": "rules.Rule:123@base.url",
"valueSyntax": "..Syntax..",
"valueCoordinateType": "type.Type:2286@base.url",
"valueHeadingType": "type.Type:2746@base.url",
"valueObjectType": "type.Type:7063@base.url",
"valueSpatialUnitRecordType": "type.Type:4117@base.url",
"valueVersionScheme": "type.Type:1303@base.url",
"valuesShuffled": true
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The parameter has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "parameter not found" }
delete /parameters/{parameterId}
Delete a given parameter.
URI Parameters
- parameterId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The parameter has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "parameter not found" }
Entity representing a parameter form metadata for update
get
Get form metadata for updating an existing parameter.
get /parameters/{parameterId}/metadata
Get form metadata for updating an existing parameter.
URI Parameters
- parameterId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Parameter",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this parameter, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this parameter, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this parameter for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this parameter",
"linked": false
},
"description": {
"description": "The description of this parameter.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this parameter",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this parameter. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this parameter. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"enabled": {
"description": "Whether this parameter is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Parameter.Parameter:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this parameter is enabled",
"linked": false
},
"disabled": {
"description": "Whether this parameter is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Parameter.Parameter:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this parameter is enabled",
"linked": false
},
"ruleId": {
"description": "An explicit Rule for this parameter.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Parameter.Parameter:rule@base.url",
"existingValue": "",
"elementLabel": "Rule",
"instructions": "Select a Rule to apply to this parameter",
"linked": false
},
"valueSyntax": {
"description": "The syntax for the values of this parameter.",
"type": "array",
"elementId": "configuration.Parameter:valueSyntax@dxtera.org",
"existingValue": [],
"elementLabel": "Value Syntax",
"instructions": "Enter Ids for value syntax of this parameter.",
"linked": false
},
"valueCoordinateType": {
"description": "The type of the value if the syntax is a coordinate.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueCoordinateType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Coordinate Type",
"instructions": "Enter the Type id of the value coordinate type for this parameter.",
"linked": false
},
"valueHeadingType": {
"description": "The type of the value if the syntax is a heading.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueHeadingType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Heading Type",
"instructions": "Enter the Type id of the value heading type for this parameter.",
"linked": false
},
"valueObjectType": {
"description": "The type of the value if the syntax is an object.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueObjectType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Object Type",
"instructions": "Enter the Type id of the value object type for this parameter.",
"linked": false
},
"valueSpatialUnitRecordType": {
"description": "The type of the value if the syntax is a spatial unit.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueSpatialUnitRecordType@dxtera.org",
"existingValue": null,
"elementLabel": "Value Spatial Unit Record Type",
"instructions": "Enter the Type id of the value spatial unit record type for this parameter.",
"linked": false
},
"valueVersionScheme": {
"description": "The type of the value if the syntax is a version.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "configuration.Parameter:valueVersionScheme@dxtera.org",
"existingValue": null,
"elementLabel": "Value Version Scheme",
"instructions": "Enter the Type id of the value version scheme for this parameter.",
"linked": false
},
"valuesShuffled": {
"description": "Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.",
"type": "boolean",
"elementId": "configuration.Parameter:valuesShuffled@dxtera.org",
"existingValue": false,
"elementLabel": "Values Shuffled",
"instructions": "Enter true or false.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "parameter not found" }
/configurations
Collection of configurations in a system or federation of systems.
get
Get all configurations.
post
Create a new configuration.
get /configurations
Get all configurations.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleConfigurationType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleConfigurationType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleConfigurationType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - parameterId: (string)
Get configurations mapped to this parameter.
Example:
configuration.Parameter%3A1521%40demo.dxtera.org - valueId: (string)
Get configurations mapped to this value.
Example:
configuration.Value%3A845%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Configuration:6902@base.url",
"uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A6902%40base.url",
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"genusTypeId": "type.Type:defaultConfigurationType@base.url",
"recordTypeIds": [ "type.Type:exampleConfigurationRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /configurations
Create a new configuration.
Query Parameters
- genusType: (string)
specify a particular configuration type to create
Example:
type.Type%3AexampleConfigurationType%40dxtera.org - recordType: (array of )
specify support for one or more configuration record types
Example:
[ "type.Type%3AexampleConfigurationRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Configuration",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this configuration, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this configuration, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this configuration for display.",
"type": "string"
},
"description": {
"description": "The description of this configuration.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this configuration. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this configuration. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this configuration.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this configuration. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this configuration.",
"type": "string"
},
"registry": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND"
}
}
}Example:
{
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
}
Entity representing a configuration form metadata.
get
Get form metadata for creating a new configuration.
get /configurations/metadata
Get form metadata for creating a new configuration.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Configuration",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this configuration, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this configuration, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this configuration for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this configuration",
"linked": false
},
"description": {
"description": "The description of this configuration.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this configuration",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this configuration. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this configuration. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this configuration.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this configuration",
"linked": false
},
"brandingIds": {
"description": "The branding of this configuration. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Configuration.Configuration:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this configuration",
"linked": false
},
"license": {
"description": "The licensing that applies to this configuration.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this configuration",
"linked": false
},
"registry": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Configuration:registry@dxtera.org",
"existingValue": null,
"elementLabel": "Registry",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root configurations in the configuration hierarchy. A node with no parents is an orphan. While all configuration Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-configuration
get /configurations/root-configuration
Get all root root-configuration
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Configuration:6902@base.url",
"uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A6902%40base.url",
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"genusTypeId": "type.Type:defaultConfigurationType@base.url",
"recordTypeIds": [ "type.Type:exampleConfigurationRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a configuration
get
Get a configuration given its id.
put
Update a given configuration.
delete
Delete a given configuration.
get /configurations/{configurationId}
Get a configuration given its id.
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "configuration.Configuration:6902@base.url",
"uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A6902%40base.url",
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"genusTypeId": "type.Type:defaultConfigurationType@base.url",
"recordTypeIds": [ "type.Type:exampleConfigurationRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "configuration not found" }
put /configurations/{configurationId}
Update a given configuration.
URI Parameters
- configurationId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Configuration",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this configuration, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this configuration, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this configuration for display.",
"type": "string"
},
"description": {
"description": "The description of this configuration.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this configuration. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this configuration. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this configuration.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this configuration. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this configuration.",
"type": "string"
},
"registry": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND"
}
}
}Example:
{
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The configuration has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "configuration not found" }
delete /configurations/{configurationId}
Delete a given configuration.
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The configuration has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "configuration not found" }
Entity representing a configuration form metadata for update
get
Get form metadata for updating an existing configuration.
get /configurations/{configurationId}/metadata
Get form metadata for updating an existing configuration.
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Configuration",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this configuration, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this configuration, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this configuration for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this configuration",
"linked": false
},
"description": {
"description": "The description of this configuration.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this configuration",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this configuration. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this configuration. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this configuration.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this configuration",
"linked": false
},
"brandingIds": {
"description": "The branding of this configuration. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Configuration.Configuration:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this configuration",
"linked": false
},
"license": {
"description": "The licensing that applies to this configuration.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Configuration.Configuration:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this configuration",
"linked": false
},
"registry": {
"description": "-- could someone please write a description for this --",
"type": "SYNTAX_TYPE_NOT_FOUND",
"elementId": "configuration.Configuration:registry@dxtera.org",
"existingValue": null,
"elementLabel": "Registry",
"instructions": "NEED TO GENERATE AN INSTRUCTION FOR NONE.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "configuration not found" }
get
Get child configurations for the given configuration in the hierarchy.
get /configurations/{configurationId}/children
Get child configurations for the given configuration in the hierarchy.
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Configuration:6902@base.url",
"uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A6902%40base.url",
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"genusTypeId": "type.Type:defaultConfigurationType@base.url",
"recordTypeIds": [ "type.Type:exampleConfigurationRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add configuration as child of the given configuration in the hierarchy.
delete
Remove the given configuration as a child of the given configuration in the hierarchy.
put /configurations/{configurationId}/children/{childId}
Add configuration as child of the given configuration in the hierarchy.
URI Parameters
- configurationId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child configuration has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "configuration not found" }
delete /configurations/{configurationId}/children/{childId}
Remove the given configuration as a child of the given configuration in the hierarchy.
URI Parameters
- configurationId: required(string)
- childId: required(string)
get
Get parent configurations for the given configuration in the hierarchy.
get /configurations/{configurationId}/parents
Get parent configurations for the given configuration in the hierarchy.
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Configuration:6902@base.url",
"uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A6902%40base.url",
"displayName": "Display Name of this Configuration",
"description": "The description of this Configuration",
"genusTypeId": "type.Type:defaultConfigurationType@base.url",
"recordTypeIds": [ "type.Type:exampleConfigurationRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Configuration@base.url",
"license": "The license that applies to this Configuration"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all values in this configuration
get /configurations/{configurationId}/values
Get all values in this configuration
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Value:1489@base.url",
"uri": "http://base.url/open/campusapi/configuration/value/configuration.Value%3A1489%40base.url",
"displayName": "Display Name of this Value",
"description": "The description of this Value",
"genusTypeId": "type.Type:defaultValueType@base.url",
"recordTypeIds": [ "type.Type:exampleValueRecordType@campusapi.org", "..."],
"parameterId": "configuration.Parameter:6955@base.url",
"priority": 19,
"booleanValue": true,
"bytesValue": [ "..byte[]..", "..." ],
"cardinalValue": 19,
"coordinateValue": "..Coordinate..",
"currencyValue": "USD+42.00",
"dateTimeValue": "2021-07-21T23:15:30.000Z",
"decimalValue": 3.14,
"distanceValue": "..Distance..",
"durationValue": "P3DT3H",
"idValueId": "id.Id:4139@base.url",
"integerValue": 19,
"spatialUnitValue": "..SpatialUnit..",
"speedValue": "..Speed..",
"stringValue": "This is the string for StringValue",
"timeValue": "..Time..",
"typeValue": "type.Type:2798@base.url",
"versionValue": "..Version.."
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given value to this configuration
delete
Remove the given value from the configuration.
put /configurations/{configurationId}/values/{valueId}
Add the given value to this configuration
URI Parameters
- configurationId: required(string)
- valueId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "value has been added to configuration" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "value not found" }
delete /configurations/{configurationId}/values/{valueId}
Remove the given value from the configuration.
URI Parameters
- configurationId: required(string)
- valueId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "value has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "value not found" }
get
Get all parameters in this configuration
get /configurations/{configurationId}/parameters
Get all parameters in this configuration
URI Parameters
- configurationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "configuration.Parameter:7597@base.url",
"uri": "http://base.url/open/campusapi/configuration/parameter/configuration.Parameter%3A7597%40base.url",
"displayName": "Display Name of this Parameter",
"description": "The description of this Parameter",
"genusTypeId": "type.Type:defaultParameterType@base.url",
"recordTypeIds": [ "type.Type:exampleParameterRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"ruleId": "rules.Rule:123@base.url",
"valueSyntax": "..Syntax..",
"valueCoordinateType": "type.Type:3371@base.url",
"valueHeadingType": "type.Type:4860@base.url",
"valueObjectType": "type.Type:86@base.url",
"valueSpatialUnitRecordType": "type.Type:9890@base.url",
"valueVersionScheme": "type.Type:6573@base.url",
"valuesShuffled": true
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given parameter to this configuration
delete
Remove the given parameter from the configuration.
put /configurations/{configurationId}/parameters/{parameterId}
Add the given parameter to this configuration
URI Parameters
- configurationId: required(string)
- parameterId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "parameter has been added to configuration" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "parameter not found" }
delete /configurations/{configurationId}/parameters/{parameterId}
Remove the given parameter from the configuration.
URI Parameters
- configurationId: required(string)
- parameterId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "parameter has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "parameter not found" }