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

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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:1839@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "JobQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Job with any provider, false to match Job with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Job with any branding, false to match Job with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchCompetencyIds": {
      "description": "List of Competency Ids for this query to match competencies.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "competencyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "competencyQueries": {
      "description": "resourcing.CompetencyQueries to match the Competencies. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCompetency": {
      "description": "Match competencies with any value. true to match Jobs with any competencies, false to match Jobs with no competencies",
      "type": "boolean"
    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• genusType: (string)

  specify a particular 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

URI Parameters

• jobId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:1839@base.url", "..." ]
}

URI Parameters

• jobId: required(string)

URI Parameters

• jobId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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:9248@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "WorkQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJobIds": {
      "description": "List of job Ids for this query to match work that have a related job.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "jobQueries": {
      "description": "JobQueries to match the job. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCompetencyIds": {
      "description": "List of Competency Ids for this query to match competencies.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "competencyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "competencyQueries": {
      "description": "resourcing.CompetencyQueries to match the Competencies. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCompetency": {
      "description": "Match competencies with any value. true to match Works with any competencies, false to match Works with no competencies",
      "type": "boolean"
    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• workId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:9248@base.url", "..." ]
}

URI Parameters

• workId: required(string)

URI Parameters

• workId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• 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

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

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CompetencyQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• genusType: (string)

  specify a particular 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

URI Parameters

• competencyId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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

URI Parameters

• competencyId: required(string)

URI Parameters

• competencyId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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:4498@base.url",
  "competencyId": "resourcing.Competency:8945@base.url",
  "percentage": 19
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AvailabilityQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Availabilities with any end reason, false to match Availabilities with no end reason",
      "type": "boolean"
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match availability that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchJobIds": {
      "description": "List of job Ids for this query to match availability that have a related job.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "jobQueries": {
      "description": "JobQueries to match the job. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCompetencyIds": {
      "description": "List of Competency Ids for this query to match competency.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "competencyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "competencyQueries": {
      "description": "resourcing.CompetencyQueries to match the Competency. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCompetency": {
      "description": "Match competency with any value. true to match Availabilities with any competency, false to match Availabilities with no competency",
      "type": "boolean"
    },
    "matchPercentage": {
      "description": "Match Availabilities with percentages between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPercentage": {
      "description": "Match percentages with any value. true to match Availabilities with any percentage, false to match ProgramOfferings with no percentage",
      "type": "boolean"

    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• availabilityId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:4498@base.url",
  "competencyId": "resourcing.Competency:8945@base.url",
  "percentage": 19
}

URI Parameters

• availabilityId: required(string)

URI Parameters

• availabilityId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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:8926@base.url",
  "competencyId": "resourcing.Competency:9102@base.url",
  "percentage": 19
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CommissionQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Commissions with any end reason, false to match Commissions with no end reason",
      "type": "boolean"
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match commission that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchWorkIds": {
      "description": "List of work Ids for this query to match commission that have a related work.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "workQueries": {
      "description": "WorkQueries to match the work. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCompetencyIds": {
      "description": "List of Competency Ids for this query to match competency.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "competencyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "competencyQueries": {
      "description": "resourcing.CompetencyQueries to match the Competency. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCompetency": {
      "description": "Match competency with any value. true to match Commissions with any competency, false to match Commissions with no competency",
      "type": "boolean"
    },
    "matchPercentage": {
      "description": "Match Commissions with percentages between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPercentage": {
      "description": "Match percentages with any value. true to match Commissions with any percentage, false to match ProgramOfferings with no percentage",
      "type": "boolean"

    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• commissionId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:8926@base.url",
  "competencyId": "resourcing.Competency:9102@base.url",
  "percentage": 19
}

URI Parameters

• commissionId: required(string)

URI Parameters

• commissionId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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:5497@base.url",
  "timeSpent": "P3DT3H"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "EffortQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Efforts with any end reason, false to match Efforts with no end reason",
      "type": "boolean"
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match effort that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCommissionIds": {
      "description": "List of commission Ids for this query to match effort that have a related commission.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "commissionQueries": {
      "description": "CommissionQueries to match the commission. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchTimeSpent": {
      "description": "Matches timeSpents in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTimeSpent": {
      "description": "Match timeSpents with any value. true to match Efforts with any time spent, false to match ProgramOfferings with no time spent",
      "type": "boolean"

    },
    "matchFoundryIds": {
      "description": "List of Foundry Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "foundryId": {
            "description": "Foundry id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "foundryQueries": {
      "description": "FoundryQueries to match Foundry. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• effortId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:5497@base.url",
  "timeSpent": "P3DT3H"
}

URI Parameters

• effortId: required(string)

URI Parameters

• effortId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

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

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "resourcing.Foundry:7205@base.url",
    "uri": "http://base.url/open/campusapi/resourcing/foundry/resourcing.Foundry%3A7205%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" }

URI Parameters

• foundryId: required(string)

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

URI Parameters

• foundryId: required(string)

URI Parameters

• foundryId: required(string)

URI Parameters

• foundryId: required(string)

URI Parameters

• foundryId: required(string)
• childId: required(string)

URI Parameters

• foundryId: required(string)
• childId: required(string)

URI Parameters

• foundryId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

URI Parameters

• foundryId: required(string)
• jobId: required(string)

URI Parameters

• foundryId: required(string)
• jobId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

URI Parameters

• foundryId: required(string)
• workId: required(string)

URI Parameters

• foundryId: required(string)
• workId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• 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

URI Parameters

• foundryId: required(string)
• competencyId: required(string)

URI Parameters

• foundryId: required(string)
• competencyId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

URI Parameters

• foundryId: required(string)
• availabilityId: required(string)

URI Parameters

• foundryId: required(string)
• availabilityId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

URI Parameters

• foundryId: required(string)
• commissionId: required(string)

URI Parameters

• foundryId: required(string)
• commissionId: required(string)

URI Parameters

• foundryId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%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

URI Parameters

• foundryId: required(string)
• effortId: required(string)

URI Parameters

• foundryId: required(string)
• effortId: required(string)