CampusAPI Resourcing Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/resourcing
Overview
The Resourcing service package provides a means for resourcing work. The Resourcing package works in conjunction with the Workflow, Learning, and Tracking packages to manage the assignment of Resources to Work as part an an overall work management system.
This package includes the following entities:
Jobs
A Job is a collection of Work that is performed on an ongoing basis. The distinction between a Job and Work is that Work is a specific instance of a task while the Job represents the overall goal and may be perpetual. For example, a construction project is a Job that has many project components. One of the project components is the installation of electrical panels throughout the building. Each electrical panel is a Work that requires a certain Competency. The Competency indicates that the installation needs to be performed by an electrician with a Proficiency in such installations.
A Job governs Work and the operation of matching Resources based on the Proficiencies of the Resource and the Competencies required by the Work.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this job, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this job, provided by system. | string(uri) |
| displayName | The name of this job for display. | string |
| description | The description of this job. | string |
| genusTypeId (read‑only) | Id of the immutable type of this job. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this job. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this job. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this job. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this job. | string |
| active (read‑only) | Whether this job is active. Active is true if operational is true and disabled is false, or enabled is true. | boolean |
| enabled | Whether this job is administravely enabled. Administratively enabling overrides any applied enabler. | boolean |
| disabled | Whether this job is administravely disabled. Administratively disabling overrides any applied enabler. | boolean |
| operational (read‑only) | Whether this job is operational. This job is operational if any of the applied enablers are true. | boolean |
| competencyIds | The competencies. References an array of resourcing.Competency objects. | string(osid‑id)[] |
Works
Work is an abstract concept that represents a task that needs to be performed by workers. Workers may require a competency in order to perform the work.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this work, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this work, provided by system. | string(uri) |
| displayName | The name of this work for display. | string |
| description | The description of this work. | string |
| genusTypeId (read‑only) | Id of the immutable type of this work. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this work. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| jobId (read‑only) | The job associated with this work. References a resourcing.Job object. | string(osid‑id) |
| competencyIds | The competency. References an array of resourcing.Competency objects. | string(osid‑id)[] |
Competencies
A Competency is described as a set of learning Objectives. A worker meets the requirements of Work if the worker (Resource) has a Proficiency for the related learning Objectives managed in the Learning service package.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this competency, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this competency, provided by system. | string(uri) |
| displayName | The name of this competency for display. | string |
| description | The description of this competency. | string |
| genusTypeId (read‑only) | Id of the immutable type of this competency. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this competency. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
Availabilities
Availability indicates the Resources available to assign to Work in a Job. An Availability is an relationship between a Resource and a Job qualified by a set of Competencies.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this availability, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this availability, provided by system. | string(uri) |
| displayName | The name of this availability for display. | string |
| description | The description of this availability. | string |
| genusTypeId (read‑only) | Id of the immutable type of this availability. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this availability. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this availability. | string(date‑time) |
| endDate | The ending date of this availability. | string(date‑time) |
| endReasonId | The reason this availability ended. References a process.State object. | string(osid‑id) |
| resourceId (read‑only) | The resource associated with this availability. References a resource.Resource object. | string(osid‑id) |
| jobId (read‑only) | The job associated with this availability. References a resourcing.Job object. | string(osid‑id) |
| competencyId | The competency. References a resourcing.Competency object | string(osid‑id) |
| percentage | The percentage availability. | integer |
Commissions
A Commission is the assignment of a Resource to Work. A Commission is an relationship between a Resource and Work qualified by the Competency used.
Commissions may be assigned manually or automatically based on the rules of the Job. For example, a call center may route trouble tickets to a set of resources in second tier support based on the subject matter of the problem report. The trouble ticket is the Work within the Job of the call center. The subject matter is described as a required Competency and each resource in the second tier support group has a set of Proficiencies in various areas. The system selects the best Resource match optimizing the load distribution based on the Availability and the existing Commissions of the Resources.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this commission, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this commission, provided by system. | string(uri) |
| displayName | The name of this commission for display. | string |
| description | The description of this commission. | string |
| genusTypeId (read‑only) | Id of the immutable type of this commission. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this commission. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this commission. | string(date‑time) |
| endDate | The ending date of this commission. | string(date‑time) |
| endReasonId | The reason this commission ended. References a process.State object. | string(osid‑id) |
| resourceId (read‑only) | The resource associated with this commission. References a resource.Resource object. | string(osid‑id) |
| workId (read‑only) | The work associated with this commission. References a resourcing.Work object. | string(osid‑id) |
| competencyId | The competency. References a resourcing.Competency object | string(osid‑id) |
| percentage | The percentage commitment. | integer |
Efforts
Effort tracks the effort expended by a Resource on Work. Effort is an relationship between a Resource and a Commission.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this effort, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this effort, provided by system. | string(uri) |
| displayName | The name of this effort for display. | string |
| description | The description of this effort. | string |
| genusTypeId (read‑only) | Id of the immutable type of this effort. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this effort. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this effort. | string(date‑time) |
| endDate | The ending date of this effort. | string(date‑time) |
| endReasonId | The reason this effort ended. References a process.State object. | string(osid‑id) |
| resourceId (read‑only) | The resource associated with this effort. References a resource.Resource object. | string(osid‑id) |
| commissionId (read‑only) | The commission associated with this effort. References a resourcing.Commission object. | string(osid‑id) |
| timeSpent | The time spent on this commission. | string(duration) |
Foundries
Jobs, Work, Competencies, Availabilities, Commissions, and Effort may be organized into federateable catalogs. A Foundry is the name for the Resourcing catalog.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this foundry, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this foundry, provided by system. | string(uri) |
| displayName | The name of this foundry for display. | string |
| description | The description of this foundry. | string |
| genusTypeId (read‑only) | Id of the immutable type of this foundry. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this foundry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this foundry. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this foundry. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this foundry. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/jobs
Collection of jobs in a system, federation of systems, or in a default foundry.
get
Get all jobs in the system or default foundry.
post
Create a new job in the default foundry.
get /jobs
Get all jobs in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleJobType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleJobType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleJobType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3690%40demo.dxtera.org - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Job:6255@base.url",
"uri": "http://base.url/open/campusapi/resourcing/job/resourcing.Job%3A6255%40base.url",
"displayName": "Display Name of this Job",
"description": "The description of this Job",
"genusTypeId": "type.Type:defaultJobType@base.url",
"recordTypeIds": [ "type.Type:exampleJobRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Job@base.url",
"license": "The license that applies to this Job",
"competencies": [ "resourcing.Competency:772@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /jobs
Create a new job in the default foundry.
Query Parameters
- genusType: (string)
specify a particular job type to create
Example:
type.Type%3AexampleJobType%40dxtera.org - recordType: (array of )
specify support for one or more job record types
Example:
[ "type.Type%3AexampleJobRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this job
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Job",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this job, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this job, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this job for display.",
"type": "string"
},
"description": {
"description": "The description of this job.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this job. 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 job. 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 job.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this job. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this job.",
"type": "string"
},
"active": {
"description": "Whether this job 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 job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this job is operational. This job is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"competencyIds": {
"description": "The competencies.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Job",
"description": "The description of this Job",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Job@base.url",
"license": "The license that applies to this Job",
"competencies": [ "resourcing.Competency:3827@base.url", "..." ]
}
Entity representing a job form metadata.
get
Get form metadata for creating a new job.
get /jobs/metadata
Get form metadata for creating a new job.
Query Parameters
- genusType: (string)
specify a particular job type to create
Example:
type.Type%3AexampleJobType%40dxtera.org - recordType: (array of )
specify support for one or more job record types
Example:
[ "type.Type%3AexampleJobRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this job
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Job",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this job, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this job, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this job for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this job",
"linked": false
},
"description": {
"description": "The description of this job.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this job",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this job. 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 job. 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 job.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this job",
"linked": false
},
"brandingIds": {
"description": "The branding of this job. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Job.Job:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this job",
"linked": false
},
"license": {
"description": "The licensing that applies to this job.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this job",
"linked": false
},
"enabled": {
"description": "Whether this job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Job.Job:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this job is enabled",
"linked": false
},
"disabled": {
"description": "Whether this job is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Job.Job:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this job is enabled",
"linked": false
},
"competencies": {
"description": "The competencies.",
"type": "array",
"elementId": "resourcing.Job:competencies@dxtera.org",
"existingValue": [],
"elementLabel": "Competencies",
"instructions": "Enter Ids for competencies of this job.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a job
get
Get a job given its id.
put
Update a given job.
delete
Delete a given job.
get /jobs/{jobId}
Get a job given its id.
URI Parameters
- jobId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Job:6255@base.url",
"uri": "http://base.url/open/campusapi/resourcing/job/resourcing.Job%3A6255%40base.url",
"displayName": "Display Name of this Job",
"description": "The description of this Job",
"genusTypeId": "type.Type:defaultJobType@base.url",
"recordTypeIds": [ "type.Type:exampleJobRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Job@base.url",
"license": "The license that applies to this Job",
"competencies": [ "resourcing.Competency:772@base.url", "..." ]
}
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": "job not found" }
put /jobs/{jobId}
Update a given job.
URI Parameters
- jobId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Job",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this job, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this job, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this job for display.",
"type": "string"
},
"description": {
"description": "The description of this job.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this job. 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 job. 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 job.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this job. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this job.",
"type": "string"
},
"active": {
"description": "Whether this job 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 job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this job is operational. This job is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"competencyIds": {
"description": "The competencies.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Job",
"description": "The description of this Job",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Job@base.url",
"license": "The license that applies to this Job",
"competencies": [ "resourcing.Competency:3827@base.url", "..." ]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The job 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": "job not found" }
delete /jobs/{jobId}
Delete a given job.
URI Parameters
- jobId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The job 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": "job not found" }
Entity representing a job form metadata for update
get
Get form metadata for updating an existing job.
get /jobs/{jobId}/metadata
Get form metadata for updating an existing job.
URI Parameters
- jobId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Job",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this job, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this job, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this job for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this job",
"linked": false
},
"description": {
"description": "The description of this job.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this job",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this job. 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 job. 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 job.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this job",
"linked": false
},
"brandingIds": {
"description": "The branding of this job. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Job.Job:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this job",
"linked": false
},
"license": {
"description": "The licensing that applies to this job.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Job.Job:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this job",
"linked": false
},
"enabled": {
"description": "Whether this job is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Job.Job:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this job is enabled",
"linked": false
},
"disabled": {
"description": "Whether this job is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Job.Job:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this job is enabled",
"linked": false
},
"competencies": {
"description": "The competencies.",
"type": "array",
"elementId": "resourcing.Job:competencies@dxtera.org",
"existingValue": [],
"elementLabel": "Competencies",
"instructions": "Enter Ids for competencies of this job.",
"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": "job not found" }
/works
Collection of works in a system, federation of systems, or in a default foundry.
get
Get all works in the system or default foundry.
post
Create a new work in the default foundry.
get /works
Get all works in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleWorkType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleWorkType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleWorkType%40campusapi.org - jobId: (string)
the id string to match a job.
Example:
resourcing.Job%3A120%40base.url - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Work:1292@base.url",
"uri": "http://base.url/open/campusapi/resourcing/work/resourcing.Work%3A1292%40base.url",
"displayName": "Display Name of this Work",
"description": "The description of this Work",
"genusTypeId": "type.Type:defaultWorkType@base.url",
"recordTypeIds": [ "type.Type:exampleWorkRecordType@campusapi.org", "..."],
"jobId": "resourcing.Job:742@base.url",
"competencies": [ "resourcing.Competency:5386@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /works
Create a new work in the default foundry.
Query Parameters
- jobId: required(string)
the job of this work.
Example:
resourcing.Job%3A120%40base.url - genusType: (string)
specify a particular work type to create
Example:
type.Type%3AexampleWorkType%40dxtera.org - recordType: (array of )
specify support for one or more work record types
Example:
[ "type.Type%3AexampleWorkRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this work
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Work",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this work, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this work, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this work for display.",
"type": "string"
},
"description": {
"description": "The description of this work.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this work. 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 work. 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
},
"jobId": {
"description": "The job associated with this work.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyIds": {
"description": "The competency.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Work",
"description": "The description of this Work",
"competencies": [ "resourcing.Competency:9869@base.url", "..." ]
}
Entity representing a work form metadata.
get
Get form metadata for creating a new work.
get /works/metadata
Get form metadata for creating a new work.
Query Parameters
- jobId: required(string)
the job of this metadatum.
Example:
resourcing.Job%3A120%40base.url - genusType: (string)
specify a particular work type to create
Example:
type.Type%3AexampleWorkType%40dxtera.org - recordType: (array of )
specify support for one or more work record types
Example:
[ "type.Type%3AexampleWorkRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this work
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Work",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this work, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this work, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this work for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Work.Work:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this work",
"linked": false
},
"description": {
"description": "The description of this work.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Work.Work:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this work",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this work. 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 work. 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
},
"competencies": {
"description": "The competency.",
"type": "array",
"elementId": "resourcing.Work:competencies@dxtera.org",
"existingValue": [],
"elementLabel": "Competencies",
"instructions": "Enter Ids for competencies of this work.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a work
get
Get a work given its id.
put
Update a given work.
delete
Delete a given work.
get /works/{workId}
Get a work given its id.
URI Parameters
- workId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Work:1292@base.url",
"uri": "http://base.url/open/campusapi/resourcing/work/resourcing.Work%3A1292%40base.url",
"displayName": "Display Name of this Work",
"description": "The description of this Work",
"genusTypeId": "type.Type:defaultWorkType@base.url",
"recordTypeIds": [ "type.Type:exampleWorkRecordType@campusapi.org", "..."],
"jobId": "resourcing.Job:742@base.url",
"competencies": [ "resourcing.Competency:5386@base.url", "..." ]
}
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": "work not found" }
put /works/{workId}
Update a given work.
URI Parameters
- workId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Work",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this work, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this work, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this work for display.",
"type": "string"
},
"description": {
"description": "The description of this work.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this work. 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 work. 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
},
"jobId": {
"description": "The job associated with this work.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyIds": {
"description": "The competency.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Work",
"description": "The description of this Work",
"competencies": [ "resourcing.Competency:9869@base.url", "..." ]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The work 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": "work not found" }
delete /works/{workId}
Delete a given work.
URI Parameters
- workId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The work 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": "work not found" }
Entity representing a work form metadata for update
get
Get form metadata for updating an existing work.
get /works/{workId}/metadata
Get form metadata for updating an existing work.
URI Parameters
- workId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Work",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this work, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this work, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this work for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Work.Work:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this work",
"linked": false
},
"description": {
"description": "The description of this work.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Work.Work:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this work",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this work. 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 work. 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
},
"competencies": {
"description": "The competency.",
"type": "array",
"elementId": "resourcing.Work:competencies@dxtera.org",
"existingValue": [],
"elementLabel": "Competencies",
"instructions": "Enter Ids for competencies of this work.",
"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": "work not found" }
/competencies
Collection of competencies in a system, federation of systems, or in a default foundry.
get
Get all competencies in the system or default foundry.
post
Create a new competency in the default foundry.
get /competencies
Get all competencies in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleCompetencyType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleCompetencyType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleCompetencyType%40campusapi.org - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Competency:3478@base.url",
"uri": "http://base.url/open/campusapi/resourcing/competency/resourcing.Competency%3A3478%40base.url",
"displayName": "Display Name of this Competency",
"description": "The description of this Competency",
"genusTypeId": "type.Type:defaultCompetencyType@base.url",
"recordTypeIds": [ "type.Type:exampleCompetencyRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /competencies
Create a new competency in the default foundry.
Query Parameters
- genusType: (string)
specify a particular competency type to create
Example:
type.Type%3AexampleCompetencyType%40dxtera.org - recordType: (array of )
specify support for one or more competency record types
Example:
[ "type.Type%3AexampleCompetencyRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this competency
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Competency",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this competency, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this competency, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this competency for display.",
"type": "string"
},
"description": {
"description": "The description of this competency.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this competency. 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 competency. 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 Competency",
"description": "The description of this Competency"
}
Entity representing a competency form metadata.
get
Get form metadata for creating a new competency.
get /competencies/metadata
Get form metadata for creating a new competency.
Query Parameters
- genusType: (string)
specify a particular competency type to create
Example:
type.Type%3AexampleCompetencyType%40dxtera.org - recordType: (array of )
specify support for one or more competency record types
Example:
[ "type.Type%3AexampleCompetencyRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this competency
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Competency",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this competency, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this competency, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this competency for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Competency.Competency:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this competency",
"linked": false
},
"description": {
"description": "The description of this competency.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Competency.Competency:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this competency",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this competency. 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 competency. 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" }
Entity representing a competency
get
Get a competency given its id.
put
Update a given competency.
delete
Delete a given competency.
get /competencies/{competencyId}
Get a competency given its id.
URI Parameters
- competencyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Competency:3478@base.url",
"uri": "http://base.url/open/campusapi/resourcing/competency/resourcing.Competency%3A3478%40base.url",
"displayName": "Display Name of this Competency",
"description": "The description of this Competency",
"genusTypeId": "type.Type:defaultCompetencyType@base.url",
"recordTypeIds": [ "type.Type:exampleCompetencyRecordType@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": "competency not found" }
put /competencies/{competencyId}
Update a given competency.
URI Parameters
- competencyId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Competency",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this competency, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this competency, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this competency for display.",
"type": "string"
},
"description": {
"description": "The description of this competency.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this competency. 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 competency. 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 Competency",
"description": "The description of this Competency"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The competency 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": "competency not found" }
delete /competencies/{competencyId}
Delete a given competency.
URI Parameters
- competencyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The competency 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": "competency not found" }
Entity representing a competency form metadata for update
get
Get form metadata for updating an existing competency.
get /competencies/{competencyId}/metadata
Get form metadata for updating an existing competency.
URI Parameters
- competencyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Competency",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this competency, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this competency, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this competency for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Competency.Competency:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this competency",
"linked": false
},
"description": {
"description": "The description of this competency.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Competency.Competency:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this competency",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this competency. 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 competency. 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": "competency not found" }
/availabilities
Collection of availabilities in a system, federation of systems, or in a default foundry.
get
Get all availabilities in the system or default foundry.
post
Create a new availability in the default foundry.
get /availabilities
Get all availabilities in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleAvailabilityType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAvailabilityType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAvailabilityType%40campusapi.org - fromDate: (string)
Get all availabilities from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all availabilities up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - resourceId: (string)
the id string to match a resource.
Example:
resource.Resource%3A768%40base.url - jobId: (string)
the id string to match a job.
Example:
resourcing.Job%3A360%40base.url - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Availability:2089@base.url",
"uri": "http://base.url/open/campusapi/resourcing/availability/resourcing.Availability%3A2089%40base.url",
"displayName": "Display Name of this Availability",
"description": "The description of this Availability",
"genusTypeId": "type.Type:defaultAvailabilityType@base.url",
"recordTypeIds": [ "type.Type:exampleAvailabilityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2089@base.url",
"resourceId": "resource.Resource:2903@base.url",
"jobId": "resourcing.Job:8103@base.url",
"competencyId": "resourcing.Competency:4635@base.url",
"percentage": 19
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /availabilities
Create a new availability in the default foundry.
Query Parameters
- resourceId: required(string)
the resource of this availability.
Example:
resource.Resource%3A768%40base.url - jobId: required(string)
the job of this availability.
Example:
resourcing.Job%3A360%40base.url - genusType: (string)
specify a particular availability type to create
Example:
type.Type%3AexampleAvailabilityType%40dxtera.org - recordType: (array of )
specify support for one or more availability record types
Example:
[ "type.Type%3AexampleAvailabilityRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this availability
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Availability",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this availability, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this availability, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this availability for display.",
"type": "string"
},
"description": {
"description": "The description of this availability.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this availability. 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 availability. 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
},
"startDate": {
"description": "The starting date of this availability.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this availability.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this availability ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this availability.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"jobId": {
"description": "The job associated with this availability.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyId": {
"description": "The competency.",
"type": "string",
"format": "osid-id"
},
"percentage": {
"description": "The percentage availability.",
"type": "integer",
"minimum": 1
}
}
}Example:
{
"displayName": "Display Name of this Availability",
"description": "The description of this Availability",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:583@base.url",
"competencyId": "resourcing.Competency:8286@base.url",
"percentage": 19
}
Entity representing a availability form metadata.
get
Get form metadata for creating a new availability.
get /availabilities/metadata
Get form metadata for creating a new availability.
Query Parameters
- resourceId: required(string)
the resource of this metadatum.
Example:
resource.Resource%3A768%40base.url - jobId: required(string)
the job of this metadatum.
Example:
resourcing.Job%3A360%40base.url - genusType: (string)
specify a particular availability type to create
Example:
type.Type%3AexampleAvailabilityType%40dxtera.org - recordType: (array of )
specify support for one or more availability record types
Example:
[ "type.Type%3AexampleAvailabilityRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this availability
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Availability",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this availability, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this availability, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this availability for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this availability",
"linked": false
},
"description": {
"description": "The description of this availability.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this availability",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this availability. 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 availability. 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
},
"startDate": {
"description": "The starting date of this availability.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this availability",
"linked": false
},
"endDate": {
"description": "The ending date of this availability.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this availability",
"linked": false
},
"endReasonId": {
"description": "The reason this availability ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this availability ended",
"linked": false
},
"competencyId": {
"description": "The competency.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Availability:competency@dxtera.org",
"existingValue": null,
"elementLabel": "Competency",
"instructions": "Enter the Id of the competency for this availability.",
"linked": false
},
"percentage": {
"description": "The percentage availability.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "resourcing.Availability:percentage@dxtera.org",
"existingValue": 42,
"elementLabel": "Percentage",
"instructions": "Enter the percentage of this availability.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a availability
get
Get a availability given its id.
put
Update a given availability.
delete
Delete a given availability.
get /availabilities/{availabilityId}
Get a availability given its id.
URI Parameters
- availabilityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Availability:2089@base.url",
"uri": "http://base.url/open/campusapi/resourcing/availability/resourcing.Availability%3A2089%40base.url",
"displayName": "Display Name of this Availability",
"description": "The description of this Availability",
"genusTypeId": "type.Type:defaultAvailabilityType@base.url",
"recordTypeIds": [ "type.Type:exampleAvailabilityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2089@base.url",
"resourceId": "resource.Resource:2903@base.url",
"jobId": "resourcing.Job:8103@base.url",
"competencyId": "resourcing.Competency:4635@base.url",
"percentage": 19
}
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": "availability not found" }
put /availabilities/{availabilityId}
Update a given availability.
URI Parameters
- availabilityId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Availability",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this availability, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this availability, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this availability for display.",
"type": "string"
},
"description": {
"description": "The description of this availability.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this availability. 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 availability. 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
},
"startDate": {
"description": "The starting date of this availability.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this availability.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this availability ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this availability.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"jobId": {
"description": "The job associated with this availability.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyId": {
"description": "The competency.",
"type": "string",
"format": "osid-id"
},
"percentage": {
"description": "The percentage availability.",
"type": "integer",
"minimum": 1
}
}
}Example:
{
"displayName": "Display Name of this Availability",
"description": "The description of this Availability",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:583@base.url",
"competencyId": "resourcing.Competency:8286@base.url",
"percentage": 19
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The availability 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": "availability not found" }
delete /availabilities/{availabilityId}
Delete a given availability.
URI Parameters
- availabilityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The availability 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": "availability not found" }
Entity representing a availability form metadata for update
get
Get form metadata for updating an existing availability.
get /availabilities/{availabilityId}/metadata
Get form metadata for updating an existing availability.
URI Parameters
- availabilityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Availability",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this availability, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this availability, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this availability for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this availability",
"linked": false
},
"description": {
"description": "The description of this availability.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this availability",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this availability. 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 availability. 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
},
"startDate": {
"description": "The starting date of this availability.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this availability",
"linked": false
},
"endDate": {
"description": "The ending date of this availability.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this availability",
"linked": false
},
"endReasonId": {
"description": "The reason this availability ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Availability.Availability:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this availability ended",
"linked": false
},
"competencyId": {
"description": "The competency.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Availability:competency@dxtera.org",
"existingValue": null,
"elementLabel": "Competency",
"instructions": "Enter the Id of the competency for this availability.",
"linked": false
},
"percentage": {
"description": "The percentage availability.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "resourcing.Availability:percentage@dxtera.org",
"existingValue": 42,
"elementLabel": "Percentage",
"instructions": "Enter the percentage of this availability.",
"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": "availability not found" }
/commissions
Collection of commissions in a system, federation of systems, or in a default foundry.
get
Get all commissions in the system or default foundry.
post
Create a new commission in the default foundry.
get /commissions
Get all commissions in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleCommissionType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleCommissionType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleCommissionType%40campusapi.org - fromDate: (string)
Get all commissions from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all commissions up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - resourceId: (string)
the id string to match a resource.
Example:
resource.Resource%3A640%40base.url - workId: (string)
the id string to match a work.
Example:
resourcing.Work%3A400%40base.url - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Commission:6335@base.url",
"uri": "http://base.url/open/campusapi/resourcing/commission/resourcing.Commission%3A6335%40base.url",
"displayName": "Display Name of this Commission",
"description": "The description of this Commission",
"genusTypeId": "type.Type:defaultCommissionType@base.url",
"recordTypeIds": [ "type.Type:exampleCommissionRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6335@base.url",
"resourceId": "resource.Resource:2079@base.url",
"workId": "resourcing.Work:5078@base.url",
"competencyId": "resourcing.Competency:2459@base.url",
"percentage": 19
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /commissions
Create a new commission in the default foundry.
Query Parameters
- resourceId: required(string)
the resource of this commission.
Example:
resource.Resource%3A640%40base.url - workId: required(string)
the work of this commission.
Example:
resourcing.Work%3A400%40base.url - genusType: (string)
specify a particular commission type to create
Example:
type.Type%3AexampleCommissionType%40dxtera.org - recordType: (array of )
specify support for one or more commission record types
Example:
[ "type.Type%3AexampleCommissionRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this commission
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Commission",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this commission, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this commission, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this commission for display.",
"type": "string"
},
"description": {
"description": "The description of this commission.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this commission. 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 commission. 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
},
"startDate": {
"description": "The starting date of this commission.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this commission.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this commission ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this commission.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"workId": {
"description": "The work associated with this commission.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyId": {
"description": "The competency.",
"type": "string",
"format": "osid-id"
},
"percentage": {
"description": "The percentage commitment.",
"type": "integer",
"minimum": 1
}
}
}Example:
{
"displayName": "Display Name of this Commission",
"description": "The description of this Commission",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:3839@base.url",
"competencyId": "resourcing.Competency:9232@base.url",
"percentage": 19
}
Entity representing a commission form metadata.
get
Get form metadata for creating a new commission.
get /commissions/metadata
Get form metadata for creating a new commission.
Query Parameters
- resourceId: required(string)
the resource of this metadatum.
Example:
resource.Resource%3A640%40base.url - workId: required(string)
the work of this metadatum.
Example:
resourcing.Work%3A400%40base.url - genusType: (string)
specify a particular commission type to create
Example:
type.Type%3AexampleCommissionType%40dxtera.org - recordType: (array of )
specify support for one or more commission record types
Example:
[ "type.Type%3AexampleCommissionRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this commission
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Commission",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this commission, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this commission, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this commission for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this commission",
"linked": false
},
"description": {
"description": "The description of this commission.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this commission",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this commission. 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 commission. 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
},
"startDate": {
"description": "The starting date of this commission.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this commission",
"linked": false
},
"endDate": {
"description": "The ending date of this commission.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this commission",
"linked": false
},
"endReasonId": {
"description": "The reason this commission ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this commission ended",
"linked": false
},
"competencyId": {
"description": "The competency.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Commission:competency@dxtera.org",
"existingValue": null,
"elementLabel": "Competency",
"instructions": "Enter the Id of the competency for this commission.",
"linked": false
},
"percentage": {
"description": "The percentage commitment.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "resourcing.Commission:percentage@dxtera.org",
"existingValue": 42,
"elementLabel": "Percentage",
"instructions": "Enter the percentage of this commission.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a commission
get
Get a commission given its id.
put
Update a given commission.
delete
Delete a given commission.
get /commissions/{commissionId}
Get a commission given its id.
URI Parameters
- commissionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Commission:6335@base.url",
"uri": "http://base.url/open/campusapi/resourcing/commission/resourcing.Commission%3A6335%40base.url",
"displayName": "Display Name of this Commission",
"description": "The description of this Commission",
"genusTypeId": "type.Type:defaultCommissionType@base.url",
"recordTypeIds": [ "type.Type:exampleCommissionRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6335@base.url",
"resourceId": "resource.Resource:2079@base.url",
"workId": "resourcing.Work:5078@base.url",
"competencyId": "resourcing.Competency:2459@base.url",
"percentage": 19
}
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": "commission not found" }
put /commissions/{commissionId}
Update a given commission.
URI Parameters
- commissionId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Commission",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this commission, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this commission, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this commission for display.",
"type": "string"
},
"description": {
"description": "The description of this commission.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this commission. 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 commission. 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
},
"startDate": {
"description": "The starting date of this commission.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this commission.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this commission ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this commission.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"workId": {
"description": "The work associated with this commission.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"competencyId": {
"description": "The competency.",
"type": "string",
"format": "osid-id"
},
"percentage": {
"description": "The percentage commitment.",
"type": "integer",
"minimum": 1
}
}
}Example:
{
"displayName": "Display Name of this Commission",
"description": "The description of this Commission",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:3839@base.url",
"competencyId": "resourcing.Competency:9232@base.url",
"percentage": 19
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The commission 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": "commission not found" }
delete /commissions/{commissionId}
Delete a given commission.
URI Parameters
- commissionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The commission 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": "commission not found" }
Entity representing a commission form metadata for update
get
Get form metadata for updating an existing commission.
get /commissions/{commissionId}/metadata
Get form metadata for updating an existing commission.
URI Parameters
- commissionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Commission",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this commission, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this commission, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this commission for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this commission",
"linked": false
},
"description": {
"description": "The description of this commission.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this commission",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this commission. 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 commission. 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
},
"startDate": {
"description": "The starting date of this commission.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this commission",
"linked": false
},
"endDate": {
"description": "The ending date of this commission.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this commission",
"linked": false
},
"endReasonId": {
"description": "The reason this commission ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Commission.Commission:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this commission ended",
"linked": false
},
"competencyId": {
"description": "The competency.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Commission:competency@dxtera.org",
"existingValue": null,
"elementLabel": "Competency",
"instructions": "Enter the Id of the competency for this commission.",
"linked": false
},
"percentage": {
"description": "The percentage commitment.",
"type": "integer",
"minimum": 1,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "resourcing.Commission:percentage@dxtera.org",
"existingValue": 42,
"elementLabel": "Percentage",
"instructions": "Enter the percentage of this commission.",
"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": "commission not found" }
/efforts
Collection of efforts in a system, federation of systems, or in a default foundry.
get
Get all efforts in the system or default foundry.
post
Create a new effort in the default foundry.
get /efforts
Get all efforts in the system or default foundry.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleEffortType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleEffortType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleEffortType%40campusapi.org - fromDate: (string)
Get all efforts from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all efforts up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - resourceId: (string)
the id string to match a resource.
Example:
resource.Resource%3A384%40base.url - commissionId: (string)
the id string to match a commission.
Example:
resourcing.Commission%3A600%40base.url - foundryId: (string)
The id string to match a foundry
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Effort:7634@base.url",
"uri": "http://base.url/open/campusapi/resourcing/effort/resourcing.Effort%3A7634%40base.url",
"displayName": "Display Name of this Effort",
"description": "The description of this Effort",
"genusTypeId": "type.Type:defaultEffortType@base.url",
"recordTypeIds": [ "type.Type:exampleEffortRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:7634@base.url",
"resourceId": "resource.Resource:3781@base.url",
"commissionId": "resourcing.Commission:4821@base.url",
"timeSpent": "P3DT3H"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /efforts
Create a new effort in the default foundry.
Query Parameters
- resourceId: required(string)
the resource of this effort.
Example:
resource.Resource%3A384%40base.url - commissionId: required(string)
the commission of this effort.
Example:
resourcing.Commission%3A600%40base.url - genusType: (string)
specify a particular effort type to create
Example:
type.Type%3AexampleEffortType%40dxtera.org - recordType: (array of )
specify support for one or more effort record types
Example:
[ "type.Type%3AexampleEffortRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this effort
Example:
resourcing.Foundry%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Effort",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this effort, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this effort, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this effort for display.",
"type": "string"
},
"description": {
"description": "The description of this effort.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this effort. 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 effort. 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
},
"startDate": {
"description": "The starting date of this effort.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this effort.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this effort ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this effort.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"commissionId": {
"description": "The commission associated with this effort.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"timeSpent": {
"description": "The time spent on this commission.",
"type": "string",
"format": "duration"
}
}
}Example:
{
"displayName": "Display Name of this Effort",
"description": "The description of this Effort",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6716@base.url",
"timeSpent": "P3DT3H"
}
Entity representing a effort form metadata.
get
Get form metadata for creating a new effort.
get /efforts/metadata
Get form metadata for creating a new effort.
Query Parameters
- resourceId: required(string)
the resource of this metadatum.
Example:
resource.Resource%3A384%40base.url - commissionId: required(string)
the commission of this metadatum.
Example:
resourcing.Commission%3A600%40base.url - genusType: (string)
specify a particular effort type to create
Example:
type.Type%3AexampleEffortType%40dxtera.org - recordType: (array of )
specify support for one or more effort record types
Example:
[ "type.Type%3AexampleEffortRecordType%40campusapi.org", "..." ] - foundryId: (string)
specify in which foundry to create this effort
Example:
resourcing.Foundry%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Effort",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this effort, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this effort, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this effort for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this effort",
"linked": false
},
"description": {
"description": "The description of this effort.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this effort",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this effort. 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 effort. 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
},
"startDate": {
"description": "The starting date of this effort.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this effort",
"linked": false
},
"endDate": {
"description": "The ending date of this effort.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this effort",
"linked": false
},
"endReasonId": {
"description": "The reason this effort ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this effort ended",
"linked": false
},
"timeSpent": {
"description": "The time spent on this commission.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Effort:timeSpent@dxtera.org",
"existingValue": "",
"elementLabel": "Time Spent",
"instructions": "Enter the time spent of this effort.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a effort
get
Get a effort given its id.
put
Update a given effort.
delete
Delete a given effort.
get /efforts/{effortId}
Get a effort given its id.
URI Parameters
- effortId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Effort:7634@base.url",
"uri": "http://base.url/open/campusapi/resourcing/effort/resourcing.Effort%3A7634%40base.url",
"displayName": "Display Name of this Effort",
"description": "The description of this Effort",
"genusTypeId": "type.Type:defaultEffortType@base.url",
"recordTypeIds": [ "type.Type:exampleEffortRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:7634@base.url",
"resourceId": "resource.Resource:3781@base.url",
"commissionId": "resourcing.Commission:4821@base.url",
"timeSpent": "P3DT3H"
}
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": "effort not found" }
put /efforts/{effortId}
Update a given effort.
URI Parameters
- effortId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Effort",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this effort, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this effort, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this effort for display.",
"type": "string"
},
"description": {
"description": "The description of this effort.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this effort. 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 effort. 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
},
"startDate": {
"description": "The starting date of this effort.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this effort.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this effort ended.",
"type": "string",
"format": "osid-id"
},
"resourceId": {
"description": "The resource associated with this effort.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"commissionId": {
"description": "The commission associated with this effort.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"timeSpent": {
"description": "The time spent on this commission.",
"type": "string",
"format": "duration"
}
}
}Example:
{
"displayName": "Display Name of this Effort",
"description": "The description of this Effort",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6716@base.url",
"timeSpent": "P3DT3H"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The effort 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": "effort not found" }
delete /efforts/{effortId}
Delete a given effort.
URI Parameters
- effortId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The effort 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": "effort not found" }
Entity representing a effort form metadata for update
get
Get form metadata for updating an existing effort.
get /efforts/{effortId}/metadata
Get form metadata for updating an existing effort.
URI Parameters
- effortId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Effort",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this effort, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this effort, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this effort for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this effort",
"linked": false
},
"description": {
"description": "The description of this effort.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this effort",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this effort. 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 effort. 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
},
"startDate": {
"description": "The starting date of this effort.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this effort",
"linked": false
},
"endDate": {
"description": "The ending date of this effort.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this effort",
"linked": false
},
"endReasonId": {
"description": "The reason this effort ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Effort.Effort:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this effort ended",
"linked": false
},
"timeSpent": {
"description": "The time spent on this commission.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resourcing.Effort:timeSpent@dxtera.org",
"existingValue": "",
"elementLabel": "Time Spent",
"instructions": "Enter the time spent of this effort.",
"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": "effort not found" }
/foundries
Collection of foundries in a system or federation of systems.
get
Get all foundries.
post
Create a new foundry.
get /foundries
Get all foundries.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleFoundryType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleFoundryType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleFoundryType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - jobId: (string)
Get foundries mapped to this job.
Example:
resourcing.Job%3A210%40demo.dxtera.org - workId: (string)
Get foundries mapped to this work.
Example:
resourcing.Work%3A280%40demo.dxtera.org - competencyId: (string)
Get foundries mapped to this competency.
Example:
resourcing.Competency%3A700%40demo.dxtera.org - availabilityId: (string)
Get foundries mapped to this availability.
Example:
resourcing.Availability%3A840%40demo.dxtera.org - commissionId: (string)
Get foundries mapped to this commission.
Example:
resourcing.Commission%3A700%40demo.dxtera.org - effortId: (string)
Get foundries mapped to this effort.
Example:
resourcing.Effort%3A420%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Foundry:4212@base.url",
"uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A4212%40base.url",
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"genusTypeId": "type.Type:defaultFoundryType@base.url",
"recordTypeIds": [ "type.Type:exampleFoundryRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /foundries
Create a new foundry.
Query Parameters
- genusType: (string)
specify a particular foundry type to create
Example:
type.Type%3AexampleFoundryType%40dxtera.org - recordType: (array of )
specify support for one or more foundry record types
Example:
[ "type.Type%3AexampleFoundryRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Foundry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this foundry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this foundry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this foundry for display.",
"type": "string"
},
"description": {
"description": "The description of this foundry.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this foundry. 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 foundry. 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 foundry.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this foundry. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this foundry.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
}
Entity representing a foundry form metadata.
get
Get form metadata for creating a new foundry.
get /foundries/metadata
Get form metadata for creating a new foundry.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Foundry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this foundry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this foundry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this foundry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this foundry",
"linked": false
},
"description": {
"description": "The description of this foundry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this foundry",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this foundry. 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 foundry. 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 foundry.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this foundry",
"linked": false
},
"brandingIds": {
"description": "The branding of this foundry. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Foundry.Foundry:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this foundry",
"linked": false
},
"license": {
"description": "The licensing that applies to this foundry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this foundry",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root foundries in the foundry hierarchy. A node with no parents is an orphan. While all foundry 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-foundry
get /foundries/root-foundry
Get all root root-foundry
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Foundry:4212@base.url",
"uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A4212%40base.url",
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"genusTypeId": "type.Type:defaultFoundryType@base.url",
"recordTypeIds": [ "type.Type:exampleFoundryRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a foundry
get
Get a foundry given its id.
put
Update a given foundry.
delete
Delete a given foundry.
get /foundries/{foundryId}
Get a foundry given its id.
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resourcing.Foundry:4212@base.url",
"uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A4212%40base.url",
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"genusTypeId": "type.Type:defaultFoundryType@base.url",
"recordTypeIds": [ "type.Type:exampleFoundryRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
}
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": "foundry not found" }
put /foundries/{foundryId}
Update a given foundry.
URI Parameters
- foundryId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Foundry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this foundry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this foundry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this foundry for display.",
"type": "string"
},
"description": {
"description": "The description of this foundry.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this foundry. 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 foundry. 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 foundry.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this foundry. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this foundry.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The foundry 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": "foundry not found" }
delete /foundries/{foundryId}
Delete a given foundry.
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The foundry 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": "foundry not found" }
Entity representing a foundry form metadata for update
get
Get form metadata for updating an existing foundry.
get /foundries/{foundryId}/metadata
Get form metadata for updating an existing foundry.
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Foundry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this foundry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this foundry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this foundry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this foundry",
"linked": false
},
"description": {
"description": "The description of this foundry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this foundry",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this foundry. 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 foundry. 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 foundry.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this foundry",
"linked": false
},
"brandingIds": {
"description": "The branding of this foundry. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Foundry.Foundry:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this foundry",
"linked": false
},
"license": {
"description": "The licensing that applies to this foundry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Foundry.Foundry:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this foundry",
"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": "foundry not found" }
get
Get child foundries for the given foundry in the hierarchy.
get /foundries/{foundryId}/children
Get child foundries for the given foundry in the hierarchy.
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Foundry:4212@base.url",
"uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A4212%40base.url",
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"genusTypeId": "type.Type:defaultFoundryType@base.url",
"recordTypeIds": [ "type.Type:exampleFoundryRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add foundry as child of the given foundry in the hierarchy.
delete
Remove the given foundry as a child of the given foundry in the hierarchy.
put /foundries/{foundryId}/children/{childId}
Add foundry as child of the given foundry in the hierarchy.
URI Parameters
- foundryId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child foundry 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": "foundry not found" }
delete /foundries/{foundryId}/children/{childId}
Remove the given foundry as a child of the given foundry in the hierarchy.
URI Parameters
- foundryId: required(string)
- childId: required(string)
get
Get parent foundries for the given foundry in the hierarchy.
get /foundries/{foundryId}/parents
Get parent foundries for the given foundry in the hierarchy.
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Foundry:4212@base.url",
"uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A4212%40base.url",
"displayName": "Display Name of this Foundry",
"description": "The description of this Foundry",
"genusTypeId": "type.Type:defaultFoundryType@base.url",
"recordTypeIds": [ "type.Type:exampleFoundryRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Foundry@base.url",
"license": "The license that applies to this Foundry"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all jobs in this foundry
get /foundries/{foundryId}/jobs
Get all jobs in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Job:6255@base.url",
"uri": "http://base.url/open/campusapi/resourcing/job/resourcing.Job%3A6255%40base.url",
"displayName": "Display Name of this Job",
"description": "The description of this Job",
"genusTypeId": "type.Type:defaultJobType@base.url",
"recordTypeIds": [ "type.Type:exampleJobRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Job@base.url",
"license": "The license that applies to this Job",
"competencies": [ "resourcing.Competency:772@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given job to this foundry
delete
Remove the given job from the foundry.
put /foundries/{foundryId}/jobs/{jobId}
Add the given job to this foundry
URI Parameters
- foundryId: required(string)
- jobId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "job has been added to foundry" }
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": "job not found" }
delete /foundries/{foundryId}/jobs/{jobId}
Remove the given job from the foundry.
URI Parameters
- foundryId: required(string)
- jobId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "job 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": "job not found" }
get
Get all works in this foundry
get /foundries/{foundryId}/works
Get all works in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Work:1292@base.url",
"uri": "http://base.url/open/campusapi/resourcing/work/resourcing.Work%3A1292%40base.url",
"displayName": "Display Name of this Work",
"description": "The description of this Work",
"genusTypeId": "type.Type:defaultWorkType@base.url",
"recordTypeIds": [ "type.Type:exampleWorkRecordType@campusapi.org", "..."],
"jobId": "resourcing.Job:742@base.url",
"competencies": [ "resourcing.Competency:5386@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given work to this foundry
delete
Remove the given work from the foundry.
put /foundries/{foundryId}/works/{workId}
Add the given work to this foundry
URI Parameters
- foundryId: required(string)
- workId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "work has been added to foundry" }
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": "work not found" }
delete /foundries/{foundryId}/works/{workId}
Remove the given work from the foundry.
URI Parameters
- foundryId: required(string)
- workId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "work 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": "work not found" }
get
Get all competencies in this foundry
get /foundries/{foundryId}/competencies
Get all competencies in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Competency:3478@base.url",
"uri": "http://base.url/open/campusapi/resourcing/competency/resourcing.Competency%3A3478%40base.url",
"displayName": "Display Name of this Competency",
"description": "The description of this Competency",
"genusTypeId": "type.Type:defaultCompetencyType@base.url",
"recordTypeIds": [ "type.Type:exampleCompetencyRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given competency to this foundry
delete
Remove the given competency from the foundry.
put /foundries/{foundryId}/competencies/{competencyId}
Add the given competency to this foundry
URI Parameters
- foundryId: required(string)
- competencyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "competency has been added to foundry" }
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": "competency not found" }
delete /foundries/{foundryId}/competencies/{competencyId}
Remove the given competency from the foundry.
URI Parameters
- foundryId: required(string)
- competencyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "competency 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": "competency not found" }
get
Get all availabilities in this foundry
get /foundries/{foundryId}/availabilities
Get all availabilities in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Availability:2089@base.url",
"uri": "http://base.url/open/campusapi/resourcing/availability/resourcing.Availability%3A2089%40base.url",
"displayName": "Display Name of this Availability",
"description": "The description of this Availability",
"genusTypeId": "type.Type:defaultAvailabilityType@base.url",
"recordTypeIds": [ "type.Type:exampleAvailabilityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2089@base.url",
"resourceId": "resource.Resource:2903@base.url",
"jobId": "resourcing.Job:8103@base.url",
"competencyId": "resourcing.Competency:4635@base.url",
"percentage": 19
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given availability to this foundry
delete
Remove the given availability from the foundry.
put /foundries/{foundryId}/availabilities/{availabilityId}
Add the given availability to this foundry
URI Parameters
- foundryId: required(string)
- availabilityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "availability has been added to foundry" }
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": "availability not found" }
delete /foundries/{foundryId}/availabilities/{availabilityId}
Remove the given availability from the foundry.
URI Parameters
- foundryId: required(string)
- availabilityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "availability 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": "availability not found" }
get
Get all commissions in this foundry
get /foundries/{foundryId}/commissions
Get all commissions in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Commission:6335@base.url",
"uri": "http://base.url/open/campusapi/resourcing/commission/resourcing.Commission%3A6335%40base.url",
"displayName": "Display Name of this Commission",
"description": "The description of this Commission",
"genusTypeId": "type.Type:defaultCommissionType@base.url",
"recordTypeIds": [ "type.Type:exampleCommissionRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6335@base.url",
"resourceId": "resource.Resource:2079@base.url",
"workId": "resourcing.Work:5078@base.url",
"competencyId": "resourcing.Competency:2459@base.url",
"percentage": 19
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given commission to this foundry
delete
Remove the given commission from the foundry.
put /foundries/{foundryId}/commissions/{commissionId}
Add the given commission to this foundry
URI Parameters
- foundryId: required(string)
- commissionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "commission has been added to foundry" }
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": "commission not found" }
delete /foundries/{foundryId}/commissions/{commissionId}
Remove the given commission from the foundry.
URI Parameters
- foundryId: required(string)
- commissionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "commission 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": "commission not found" }
get
Get all efforts in this foundry
get /foundries/{foundryId}/efforts
Get all efforts in this foundry
URI Parameters
- foundryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resourcing.Effort:7634@base.url",
"uri": "http://base.url/open/campusapi/resourcing/effort/resourcing.Effort%3A7634%40base.url",
"displayName": "Display Name of this Effort",
"description": "The description of this Effort",
"genusTypeId": "type.Type:defaultEffortType@base.url",
"recordTypeIds": [ "type.Type:exampleEffortRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:7634@base.url",
"resourceId": "resource.Resource:3781@base.url",
"commissionId": "resourcing.Commission:4821@base.url",
"timeSpent": "P3DT3H"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given effort to this foundry
delete
Remove the given effort from the foundry.
put /foundries/{foundryId}/efforts/{effortId}
Add the given effort to this foundry
URI Parameters
- foundryId: required(string)
- effortId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "effort has been added to foundry" }
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": "effort not found" }
delete /foundries/{foundryId}/efforts/{effortId}
Remove the given effort from the foundry.
URI Parameters
- foundryId: required(string)
- effortId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "effort 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": "effort not found" }