Job
A Job.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
employerIds |
id | ⋆ | the employer Ids |
employers |
Resource | ⋆ | the employers |
competencyIds |
id | ⋆ | the competency Ids |
competencies |
Competency | ⋆ | the competencies |
Work
Work is an instance of a job and may
require competence.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
jobId |
id | the job Id |
|
job |
Job | the job | |
needsCompetence |
boolean | true if competency if specified, false if
incompetence will do |
|
competencyIds |
id | ⋆ | the competency Ids |
competencies |
Competency | ⋆ | the competency |
createdDate |
datetime | the created date | |
isComplete |
boolean | true if this work is complete, false otherwise |
|
completionDate |
datetime | the completion date |
Competency
A Competency is a skill required for
a work.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
Availability
An Availability represents a
resource's availability for work. A competency may be
used to qualify how the resource can be applied to the
work. The effective dates of this relationship specify
the availability dates for the resource.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
resourceId |
id | the resource Id |
|
resource |
Resource | the resource | |
jobId |
id | the job Id |
|
job |
Job | the job | |
isCompetent |
boolean | true if a competency is available, false
otherwise |
|
competencyId |
id | the competency Id |
|
competency |
Competency | the competency | |
percentage |
cardinal | the percentage availability |
Commission
A Commission represents a commitment
of a resource for work. A commission may also specify
a competency to qualify the work performed. The
effective dates of the relationship specify the
duration of the commission.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
resourceId |
id | the resource Id |
|
resource |
Resource | the resource | |
workId |
id | the work Id |
|
work |
Work | the work | |
isCompetent |
boolean | true if a competency is available, false
otherwise |
|
competencyId |
id | the competency Id |
|
competency |
Competency | the competency | |
percentage |
cardinal | the percentage commitment |
Effort
An Effort captures actual time spent
on a commission. The time spent may be used to further
qualify the effort that took place within the
effective dates. Multiple efforts may be logged
between a resource and a commission to capture
discontiguous periosds of time.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
resourceId |
id | the resource Id |
|
resource |
Resource | the resource | |
commissionId |
id | the commission Id |
|
commission |
Commission | the commission | |
timeSpent |
duration | the time spent |
Foundry
A Foundry represents a collection of
jobs.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |