CampusAPI Process Services API documentation version 0.1.0
Based on OSID version 3.0.0

https://base.url

Overview

The Personnel services define people and organizations.

Objects may take part in multiple processes simulataneously, and while an object can only be in one state within a process, an object may have more than one state across processes. An externally mapped Id is restricted to one State per Process.

States

A State is a simple object that captures the name and description of a state. A State belongs to a single Process. A process for representing the lifecycle of Assets and another process for representing the lifecycle of Courses may each define a "draft" state. Two States need to be created to represent the draft state of a course in the course lifecycle process and the draft state of an asset in the asset lifecycle process.

FieldDescriptionType
id(read‑only)The unique id of this state, provided by system.string(osid‑id)
uri(read‑only)The uri of this state, provided by system.string(uri)
displayNameThe name of this state for display.string
descriptionThe description of this state.string
genusTypeId
(read‑only)		Id of the immutable type of this state. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this state. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]

Processes

A Process is a collection (catalog) of States. States are mapped to a Process to form a finite state machine.

The standard catalog federating pattern was blindly applied which can create views of combined processes. What this means in practice is anyone's guess.

As an auxiliary orchestrated service, a Process represents not only a collection of States but also the implicit object type of the mapped Ids. For example, the "Publishing Asset" process manages Asset Ids where all Assets in the orchestrated repository are known and already in some initial State.

FieldDescriptionType
id(read‑only)The unique id of this process, provided by system.string(osid‑id)
uri(read‑only)The uri of this process, provided by system.string(uri)
displayNameThe name of this process for display.string
descriptionThe description of this process.string
genusTypeId
(read‑only)		Id of the immutable type of this process. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this process. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
providerIdThe provider of this process. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this process. References repository.Asset objects.string(osid‑id)[]
licenseThe licensing that applies to this process.string

License

CampusAPI REST Definitions © 2025 by DXtera Institute - licensed under CC BY-ND 4.0 Based on the Open Service Interface Definitions: http://osid.org

/process/states

Collection of States in a system, federation of systems, or in a default Process.

get post

get

Get all States in the system or default Process.

post

Create a new State in the default Process.

Create a new State in the default Process.

Query Parameters

  • processId: (string)

    specify in which process to create this state

    Example:

    process.Process%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "State",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this state. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this state. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this state for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this state.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this state. 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 state. 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
    }
  }
}

Example:

{
  "displayName": "Display Name of this State",
  "description": "The description of this State"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The State has been created",
  "stateId": "process.State:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

post

Query the collection of States in a system, federation of systems, or in a default process by posting a Query object.

post

Submit a query using a StateQuery object.

Submit a query using a StateQuery object.

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": "StateQuery",
  "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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchProcessIds": {
      "description": "List of Process Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "processId": {
            "description": "Process id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "processQueries": {
      "description": "ProcessQueries to match Process. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "process-query"
      }
    }
  }
}

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "process.State:1735@base.url",
    "uri": "http://base.url/open/campusapi/process/state/process.State%3A1735%40base.url",
    "displayName": "Display Name of this State",
    "description": "The description of this State",
    "genusTypeId": "type.Type:defaultStateType@base.url",
    "recordTypeIds": [ "type.Type:exampleStateRecordType@campusapi.org", "..."]
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

post

post

Create multiple new StateBatch in the default Process.

Create multiple new StateBatch in the default Process.

Query Parameters

  • processId: (string)

    specify in which process to create this state

    Example:

    process.Process%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "StateBatch",
    "type": "array",
    "Items": {
        "type": "state"
    }
}

Example:

[
  {
    "displayName": "Display Name of this State",
    "description": "The description of this State"
  },
  {
    "...": "..."
  }
]

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "42 States have been created"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a State form metadata.

get

Get form metadata for creating a new State.

get put delete

Entity representing a State

get

Get a particular State given its id.

put

Update a particular State given its id.

delete

Delete a particular State given its id.

Get a particular State given its id.

URI Parameters

  • stateId: required(string)

Query Parameters

  • 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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "process.State:1735@base.url",
  "uri": "http://base.url/open/campusapi/process/state/process.State%3A1735%40base.url",
  "displayName": "Display Name of this State",
  "description": "The description of this State",
  "genusTypeId": "type.Type:defaultStateType@base.url",
  "recordTypeIds": [ "type.Type:exampleStateRecordType@campusapi.org", "..."]
}

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": "State not found" }

Update a particular State given its id.

URI Parameters

  • stateId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StateItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this state. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this state. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this state for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this state.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this state. 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 state. 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
    }
  }
}

Example:

{
  "displayName": "Display Name of this State",
  "description": "The description of this State"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The State 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": "State not found" }

Delete a particular State given its id.

URI Parameters

  • stateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The State 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": "State not found" }

get

Entity representing a State form metadata for update

get

Get form metadata for updating an existing State.

Get form metadata for updating an existing State.

URI Parameters

  • stateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "State",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this state, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this state, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this state for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "State.State:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this state",
      "linked": false
    },
    "description": {
      "description": "The description of this state.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "State.State:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this state",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this state. 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 state. 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
    }
  }
}

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": "state not found" }

/process/processes

Collection of Processes in a system or federation of systems.

get post

get

Get all Processes.

post

Create a new Process.

Create a new Process.

Query Parameters

  • genusType: (string)

    specify a particular process type to create

    Example:

    type.Type%3AexampleProcessType%40dxtera.org
  • recordType: (array of )

    specify support for one or more process record types

    Example:

    [
  "type.Type%3AexampleProcessRecordType%40campusapi.org",
  "..."
]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Process",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this process. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this process. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this process for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this process.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this process. 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 process. 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 process.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this process. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this process.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Process",
  "description": "The description of this Process",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Process@base.url",
  "license": "The license that applies to this Process"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Process has been created",
  "processId": "process.Process:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

post

Query the collection of Processes in a system, federation of systems, or in a default process by posting a Query object.

post

Submit a query using a ProcessQuery object.

Submit a query using a ProcessQuery object.

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

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProcessQuery",
  "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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "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": "providerQueries to match the provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Process with any provider, false to match Process 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.AssetQueries to match the branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "asset-query"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Process with any branding, false to match Process 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"
          }
        }
      }
    },
    "matchProcessIds": {
      "description": "List of Process Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "processId": {
            "description": "Process id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "processQueries": {
      "description": "ProcessQueries to match Process. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "process-query"
      }
    }
  }
}

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "process.Process:7912@base.url",
    "uri": "http://base.url/open/campusapi/process/process/process.Process%3A7912%40base.url",
    "displayName": "Display Name of this Process",
    "description": "The description of this Process",
    "genusTypeId": "type.Type:defaultProcessType@base.url",
    "recordTypeIds": [ "type.Type:exampleProcessRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Process@base.url",
    "license": "The license that applies to this Process"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a Process form metadata.

get

Get form metadata for creating a new Process.

get

The root Processes in the Process hierarchy. A node with no parents is an orphan. While all Process 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-processes

put delete

put

Add the given Process as a root in the Process hierarchy

delete

Remove the given Process as a root in the Process hierarchy.

Add the given Process as a root in the Process hierarchy

URI Parameters

  • processId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Process has been added as a root" }

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": "Process not found" }

Remove the given Process as a root in the Process hierarchy.

URI Parameters

  • processId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Process has been removed as a root from 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": "Process not found" }

get

get

Get parent Processes for the given Process in the hierarchy.

get

get

Get child Processes for the given Process in the hierarchy.

put delete

put

Add Process as child of the given Process in the hierarchy.

delete

Remove the given Process as a child of the given Process in the hierarchy.

Add Process as child of the given Process in the hierarchy.

URI Parameters

  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child Process 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": "process not found" }

Remove the given Process as a child of the given Process in the hierarchy.

URI Parameters

  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child Process has been removed from the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get put delete

Entity representing a Process

get

Get a particular Process given its id.

put

Update a particular Process given its id.

delete

Delete a particular Process given its id.

Get a particular Process given its id.

URI Parameters

  • processId: required(string)

Query Parameters

  • 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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "process.Process:7912@base.url",
  "uri": "http://base.url/open/campusapi/process/process/process.Process%3A7912%40base.url",
  "displayName": "Display Name of this Process",
  "description": "The description of this Process",
  "genusTypeId": "type.Type:defaultProcessType@base.url",
  "recordTypeIds": [ "type.Type:exampleProcessRecordType@campusapi.org", "..."],
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Process@base.url",
  "license": "The license that applies to this Process"
}

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": "Process not found" }

Update a particular Process given its id.

URI Parameters

  • processId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProcessItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this process. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this process. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this process for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this process.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this process. 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 process. 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 process.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this process. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this process.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Process",
  "description": "The description of this Process",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Process@base.url",
  "license": "The license that applies to this Process"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Process 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": "Process not found" }

Delete a particular Process given its id.

URI Parameters

  • processId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Process 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": "Process not found" }

get

Entity representing a Process form metadata for update

get

Get form metadata for updating an existing Process.

Get form metadata for updating an existing Process.

URI Parameters

  • processId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Process",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this process, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this process, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this process for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Process.Process:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this process",
      "linked": false
    },
    "description": {
      "description": "The description of this process.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Process.Process:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this process",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this process. 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 process. 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 process.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Process.Process:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this process",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this process. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Process.Process:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this process",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this process.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Process.Process:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this process",
      "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": "process not found" }

get

get

Get all States in this Process

Get all States in this Process

URI Parameters

  • processId: 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", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

    Example:

    all
  • keyword: (string)

    The match string for keyword query

    Example:

    Hello%20World
  • displayName: (string)

    The match string for displayName query

    Example:

    Hello%20World
  • description: (string)

    The match string for description query

    Example:

    Hello%20World
  • genusTypeId: (string)

    The id string to match a genusType

    Example:

    type.Type%3AexampleStateType%40dxtera.org
  • parentGenusTypeId: (string)

    The id string to match a parent genusType

    Example:

    type.Type%3AparentTypeExampleStateType%40dxtera.org
  • recordTypeId: (string)

    The id string to match a recordType

    Example:

    type.Type%3AexampleStateType%40campusapi.org

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "process.State:1735@base.url",
    "uri": "http://base.url/open/campusapi/process/state/process.State%3A1735%40base.url",
    "displayName": "Display Name of this State",
    "description": "The description of this State",
    "genusTypeId": "type.Type:defaultStateType@base.url",
    "recordTypeIds": [ "type.Type:exampleStateRecordType@campusapi.org", "..."]
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given State to this Process

delete

Remove the given State from the Process.

Add the given State to this Process

URI Parameters

  • processId: required(string)
  • stateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "State has been added to Process" }

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": "State not found" }

Remove the given State from the Process.

URI Parameters

  • processId: required(string)
  • stateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "State 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": "State not found" }

post get

Define and inspect the StateQuery related to a "smart" Process. A smart Process is a dynamic Process whose cataloged objects are defined through queries.

post

Apply the provided StateQuery to this Process to create a dynamic smart Process

get

Get the StateQuery associated with this smart Process.

Apply the provided StateQuery to this Process to create a dynamic smart Process

URI Parameters

  • processId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StateQuery",
  "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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchProcessIds": {
      "description": "List of Process Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "processId": {
            "description": "Process id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "processQueries": {
      "description": "ProcessQueries to match Process. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "process-query"
      }
    }
  }
}

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "state-query successfully applied to process" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{ "message": "Permission denied" }

Get the StateQuery associated with this smart Process.

URI Parameters

  • processId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": 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": "Process not found" }