CampusAPI Configuration Services API documentation version 0.1.5
Based on OSID version 3.0.0

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "idValue", "typeValue", "parameter", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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:4288@base.url",
  "integerValue": 19,
  "spatialUnitValue": "..SpatialUnit..",
  "speedValue": "..Speed..",
  "stringValue": "This is the string for StringValue",
  "timeValue": "..Time..",
  "typeValue": "type.Type:1095@base.url",
  "versionValue": "..Version.."
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "idValue", "typeValue", "parameter", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ValueQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchParameterIds": {
      "description": "List of parameter Ids for this query to match value that have a related parameter.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "parameterQueries": {
      "description": "ParameterQueries to match the parameter. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchPriority": {
      "description": "Match Values with prioritys between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPriority": {
      "description": "Match prioritys with any value. true to match Values with any priority, false to match ProgramOfferings with no priority",
      "type": "boolean"

    },
    "matchBooleanValue": {
      "description": "Match boolean value for booleanValue.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchByteValue": {
      "description": "not yet supported",
      "type": "NONE"
    },
    "matchCardinalValue": {
      "description": "Match Values with cardinalValues between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCardinalValue": {
      "description": "Match cardinalValues with any value. true to match Values with any cardinal value, false to match ProgramOfferings with no cardinal value",
      "type": "boolean"

    },
    "matchCoordinateValue": {
      "description": "not yet supported",
      "type": "COORDINATE"
    },
    "matchCurrencyValue": {
      "description": "Matches currencyValues in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCurrencyValue": {
      "description": "Match currencyValues with any value. true to match Values with any currency value, false to match ProgramOfferings with no currency value",
      "type": "boolean"

    },
    "matchDateTimeValue": {
      "description": "Matches dateTimeValues between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDateTimeValue": {
      "description": "Match dateTimeValues with any value. true to match Values with any date time value, false to match ProgramOfferings with no date time value",
      "type": "boolean"

    },
    "matchDecimalValue": {
      "description": "Match DecimalValue within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDecimalValue": {
      "description": "Match decimalValues with any value. true to match Values with any decimal value, false to match ProgramOfferings with no decimal value",
      "type": "boolean"

    },
    "matchDistanceValue": {
      "description": "not yet supported",
      "type": "DISTANCE"
    },
    "matchDurationValue": {
      "description": "Matches durationValues in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDurationValue": {
      "description": "Match durationValues with any value. true to match Values with any duration value, false to match ProgramOfferings with no duration value",
      "type": "boolean"

    },
    "matchIdValueIds": {
      "description": "List of Id Ids for this query to match idValue.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "idValueId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "idValueQueries": {
      "description": "id.IdQueries to match the Id Value. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyIdValue": {
      "description": "Match id value with any value. true to match Values with any id value, false to match Values with no id value",
      "type": "boolean"
    },
    "matchIntegerValue": {
      "description": "Match Values with integerValues between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyIntegerValue": {
      "description": "Match integerValues with any value. true to match Values with any integer value, false to match ProgramOfferings with no integer value",
      "type": "boolean"

    },
    "matchSpatialUnitValue": {
      "description": "not yet supported",
      "type": "SPATIALUNIT"
    },
    "matchSpeedValue": {
      "description": "not yet supported",
      "type": "SPEED"
    },
    "matchStringValue": {
      "description": "List of StringValue strings to match. Boolean OR performed among multiple stringValues.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stringValues": {
            "description": "stringValues to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyStringValue": {
      "description": "Match stringValues with any value. true to match Values with any string value, false to match ProgramOfferings with no string value",
      "type": "boolean"

    },
    "matchTimeValue": {
      "description": "Matches timeValues between the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "time"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTimeValue": {
      "description": "Match timeValues with any value. true to match Values with any time value, false to match ProgramOfferings with no time value",
      "type": "boolean"

    },
    "matchTypeValue": {
      "description": "List of Type Ids for this query to match typeValue.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "typeValueType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchVersionValue": {
      "description": "not yet supported",
      "type": "VERSION"
    },
    "matchObjectValue": {
      "description": "not yet supported",
      "type": "NONE"
    },
    "matchConfigurationIds": {
      "description": "List of Configuration Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "configurationId": {
            "description": "Configuration id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "configurationQueries": {
      "description": "ConfigurationQueries to match Configuration. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• valueId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "idValue", "typeValue", "parameter", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:4288@base.url",
  "integerValue": 19,
  "spatialUnitValue": "..SpatialUnit..",
  "speedValue": "..Speed..",
  "stringValue": "This is the string for StringValue",
  "timeValue": "..Time..",
  "typeValue": "type.Type:1095@base.url",
  "versionValue": "..Version.."
}

URI Parameters

• valueId: required(string)

URI Parameters

• valueId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "valueCoordinateType", "valueHeadingType", "valueObjectType", "valueSpatialUnitRecordType", "valueVersionScheme", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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:9802@base.url",
  "valueHeadingType": "type.Type:5578@base.url",
  "valueObjectType": "type.Type:8719@base.url",
  "valueSpatialUnitRecordType": "type.Type:8316@base.url",
  "valueVersionScheme": "type.Type:2750@base.url",
  "valuesShuffled": true
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "valueCoordinateType", "valueHeadingType", "valueObjectType", "valueSpatialUnitRecordType", "valueVersionScheme", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ParameterQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "ruleQueries": {
      "description": "rules.RuleQuery for the cyclic event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchValueSyntaxIds": {
      "description": "List of Sy Ids for this query to match valueSyntax.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueSyntaxId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "valueSyntaxQueries": {
      "description": "osid.SyQueries to match the Value Syntax. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyValueSyntax": {
      "description": "Match value syntax with any value. true to match Parameters with any value syntax, false to match Parameters with no value syntax",
      "type": "boolean"
    },
    "matchValueCoordinateType": {
      "description": "List of Type Ids for this query to match valueCoordinateType.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueCoordinateTypeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchValueHeadingType": {
      "description": "List of Type Ids for this query to match valueHeadingType.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueHeadingTypeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchValueObjectType": {
      "description": "List of Type Ids for this query to match valueObjectType.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueObjectTypeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchValueSpatialUnitRecordType": {
      "description": "List of Type Ids for this query to match valueSpatialUnitRecordType.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueSpatialUnitRecordTypeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchValueVersionScheme": {
      "description": "List of Type Ids for this query to match valueVersionScheme.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valueVersionSchemeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchValuesShuffled": {
      "description": "Match boolean value for valuesShuffled.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchConfigurationIds": {
      "description": "List of Configuration Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "configurationId": {
            "description": "Configuration id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "configurationQueries": {
      "description": "ConfigurationQueries to match Configuration. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• parameterId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "valueCoordinateType", "valueHeadingType", "valueObjectType", "valueSpatialUnitRecordType", "valueVersionScheme", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:9802@base.url",
  "valueHeadingType": "type.Type:5578@base.url",
  "valueObjectType": "type.Type:8719@base.url",
  "valueSpatialUnitRecordType": "type.Type:8316@base.url",
  "valueVersionScheme": "type.Type:2750@base.url",
  "valuesShuffled": true
}

URI Parameters

• parameterId: required(string)

URI Parameters

• parameterId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ConfigurationQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Configuration with any provider, false to match Configuration with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Configuration with any branding, false to match Configuration with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRegistry": {
      "description": "not yet supported",
      "type": "NONE"
    },
    "matchConfigurationIds": {
      "description": "List of Configuration Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "configurationId": {
            "description": "Configuration id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "configurationQueries": {
      "description": "ConfigurationQueries to match Configuration. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "configuration.Configuration:2841@base.url",
    "uri": "http://base.url/open/campusapi/configuration/configuration/configuration.Configuration%3A2841%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" }

URI Parameters

• configurationId: required(string)

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"
}

URI Parameters

• configurationId: required(string)

URI Parameters

• configurationId: required(string)

URI Parameters

• configurationId: required(string)

URI Parameters

• configurationId: required(string)
• childId: required(string)

URI Parameters

• configurationId: required(string)
• childId: required(string)

URI Parameters

• configurationId: required(string)

URI Parameters

• configurationId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "idValue", "typeValue", "parameter", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• configurationId: required(string)
• valueId: required(string)

URI Parameters

• configurationId: required(string)
• valueId: required(string)

URI Parameters

• configurationId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "valueCoordinateType", "valueHeadingType", "valueObjectType", "valueSpatialUnitRecordType", "valueVersionScheme", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• configurationId: required(string)
• parameterId: required(string)

URI Parameters

• configurationId: required(string)
• parameterId: required(string)