Allocation
PartDraftv1.0.0-rc.2
An allocation: where and when an activity happens, and the operating states its sources run in there.
https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Allocation.json
Fields
idtextnot emptyThe record's id: unique within the document.
featureThe feature the activity happens at.
groupThe group the activity happens at, when it covers several features.
basisOne ofthe codes belowWhether the activity is planned here or tested.
planned- The project intends to carry out the activity here.
scenario- A what-if: the evaluation tests the activity here, and nobody has said it will happen.
intervalWhen the activity happens here, when it differs from the activity's own.
countwhole numberat least 1How many of the activity run here at once, such as two rigs.
statesList ofStateShareThe operating states the sources run in, with the share of the time in each.
descriptiontextNotes on the allocation.
- Exactly one of
featureorgroup.
Links
Points at Records whose ids this record holds, with the field that holds each.
- FeatureEntityfeatureA natural or built object with a place and properties, such as a wellsite, a dwelling or a road. As in ISO 19101. A feature where a framework judges effects is a receptor and has a receptor class.
- GroupPartgroupFeatures that a project evaluates together as one unit, such as wellsites close to each other. A group has no sources of its own: its members carry them.
- Operating statePartStateShare.stateA named way that a source runs, set by its operating properties, such as speed, load, flow rate or mode. Off is an operating state. Each emission names the state it holds for.
- PeriodPartStateShare.periodA recurring window in local time that a rule judges by, such as night-time from 22:00 to 07:00. A window whose end is not after its start runs past midnight.
Held by Records that embed this one, with their field that holds it.
Examples
An id that another example defines opens that record.
Example 2
{
"id": "allocation-1",
"feature": "feature-wellsite",
"basis": "planned",
"interval": {
"start": "2026-09-01T00:00:00-06:00"
},
"states": [
{
"state": "state-loaded",
"share": {
"amount": 80,
"unit": "%"
}
},
{
"state": "state-idle",
"share": {
"amount": 20,
"unit": "%"
}
}
]
}Show 1 more exampleHide the other example
Example 1
{
"feature": "feature-wellsite"
}Changes and file
Changes
- 0.1.0 First version.
Schema file
Show the JSON SchemaHide the JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Allocation.json",
"title": "Allocation",
"description": "An allocation: where and when an activity happens, and the operating states its sources run in there.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The record's id: unique within the document."
},
"feature": {
"type": "string",
"minLength": 1,
"x-ods-ref": "Feature",
"description": "The feature the activity happens at."
},
"group": {
"type": "string",
"minLength": 1,
"x-ods-ref": "Group",
"description": "The group the activity happens at, when it covers several features."
},
"basis": {
"type": "string",
"enum": [
"planned",
"scenario"
],
"description": "Whether the activity is planned here or tested.",
"x-ods-options": [
{
"value": "planned",
"title": "Planned",
"description": "The project intends to carry out the activity here."
},
{
"value": "scenario",
"title": "Scenario",
"description": "A what-if: the evaluation tests the activity here, and nobody has said it will happen."
}
]
},
"interval": {
"$ref": "Interval.json",
"description": "When the activity happens here, when it differs from the activity's own."
},
"count": {
"type": "integer",
"minimum": 1,
"description": "How many of the activity run here at once, such as two rigs."
},
"states": {
"type": "array",
"items": {
"$ref": "#/$defs/StateShare"
},
"description": "The operating states the sources run in, with the share of the time in each."
},
"description": {
"type": "string",
"description": "Notes on the allocation."
}
},
"oneOf": [
{
"properties": {
"feature": true
},
"required": [
"feature"
]
},
{
"properties": {
"group": true
},
"required": [
"group"
]
}
],
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false,
"$defs": {
"StateShare": {
"type": "object",
"properties": {
"state": {
"type": "string",
"minLength": 1,
"x-ods-ref": "OperatingState",
"description": "The operating state."
},
"share": {
"$ref": "Value.json",
"description": "The share of the time the source runs in it, in percent. Leave it out when it runs in it all the time."
},
"period": {
"type": "string",
"minLength": 1,
"x-ods-ref": "Period",
"description": "The window that repeats when the source runs in it, such as day-time only."
}
},
"required": [
"state"
],
"description": "One operating state an allocation uses.",
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false
}
},
"examples": [
{
"feature": "feature-wellsite"
},
{
"id": "allocation-1",
"feature": "feature-wellsite",
"basis": "planned",
"interval": {
"start": "2026-09-01T00:00:00-06:00"
},
"states": [
{
"state": "state-loaded",
"share": {
"amount": 80,
"unit": "%"
}
},
{
"state": "state-idle",
"share": {
"amount": 20,
"unit": "%"
}
}
]
}
],
"x-ods-status": "draft",
"x-ods-kind": "part",
"x-ods-module": "core",
"x-ods-changes": {
"0.1.0": "First version."
}
}