4.3.17. BarePipe¶
4.3.17.1. Example BarePipe¶
{
"pdef_id": "c292842e-b70c-480c-a842-f5086d5fe35d",
"pdef_type": "bare_pipe",
"meta_data": {},
"additional_data": {},
"part_number": "10254",
"serial_number": "445567",
"heat_ref": "4db9b261",
"plate_ref": "aa56593f6073",
"billet_ref": null,
"length_act": {
"val": 12.252,
"unit": "m"
},
"mass": {
"val": 2235.0,
"unit": "kg"
},
"manuf_date_time": "2022-05-03T09:50:41.287633",
"manuf_cpy": "Vallourec",
"manuf_mill": "Dusseldorf-Rath",
"manuf_process": "SMLS",
"marking": "DNVGL SMLS 450 406.4 x 19.1 SPD",
"material_type": "C-Mn",
"delivery_condition_api5L": "M",
"supp_req_api5L": [
"O",
"N"
],
"supp_req_dnv": [
"S",
"P",
"D"
],
"mill_test_pressure": {
"val": 405.0,
"unit": "bar"
},
"int_dia_avg_end_a": {
"val": 368.2,
"unit": "mm"
},
"int_dia_avg_end_b": {
"val": 368.2,
"unit": "mm"
},
"wth_avg_end_a": {
"val": 19.1,
"unit": "mm"
},
"wth_avg_end_b": {
"val": 19.1,
"unit": "mm"
},
"oor_avg_end_a": {
"val": 4.06,
"unit": "mm"
},
"oor_avg_end_b": {
"val": 4.06,
"unit": "mm"
},
"oor_avg_body": {
"val": 4.06,
"unit": "mm"
},
"related_bare_pipe_spec": [
"aa133c9b-5952-42e1-aaa2-0be4cd9fb4fe"
],
"records_of_pipe_damage": [
{
"pdef_id": "8d1ba434-c385-4166-883c-07f982cfaa32",
"pdef_type": "pipe_damage",
"meta_data": {},
"additional_data": {},
"descr": "Small shallow scratch at 2.4m from north end, approx 0.8m long.",
"type": "shallow scratch.",
"raised_date_time": "2022-05-03T09:50:41.287633",
"resolution": "accepted as-is.",
"resolution_date_time": "2022-05-03T09:50:41.287633"
}
]
}
4.3.17.2. Documentation BarePipe¶
BarePipe refers to a bare pipe. It describes the property of a unique tube, or instance of linepipe.
Each tube has its own measurements, properties etc. They are made according to a generic specification, see BarePipeSpec. Each BarePipe object can reference such specification.
For example, if a PDEF dataset reports a pipeline that required 1000 tubes to be milled, then the PDEF dataset will report 1000 instances of BarePipe in this collection. If those tubes are the same type, meaning they are all produced to the same BarePipeSpec, then only one BarePipeSpec instance will probably be reported in the dedicated BarePipeSpec collection.
Note
The current version of PDEF only covers carbon steel pipes. Instances of plastic liner pipe, clad pipes, mechanically lined pipes or full corrosion resistance alloy pipes (13Cr, 22Cr, 25Cr, …) shall be included in a later project phase.
4.3.17.3. Schema BarePipe¶
-
pdef.model.bare_pipe.BarePipe BarePipe object stores data related to one bare linepipe, ie more or less a 12m long metallic tube coming out of the pipemill.
Show JSON schema
{ "title": "BarePipe", "description": "`BarePipe` object stores data related to one bare linepipe, ie more or less a 12m long metallic tube coming out of the pipemill.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "bare_pipe", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "part_number": { "title": "Part Number", "description": "Object :ref:`part_number`, ie the manufacturer or purchaser part design number.", "maxLength": 256, "example": "100-440-0.750-3434-A", "type": "string" }, "serial_number": { "title": "Part Number", "description": "Object :ref:`serial_number`, ie the manufacturer or purchaser item serial number.", "maxLength": 256, "example": "P/N 12345", "type": "string" }, "heat_ref": { "title": "Heat Reference", "description": "Reference of the heat used to make the pipe.", "maxLength": 256, "example": "aa56593f6073", "type": "string" }, "plate_ref": { "title": "Plate Reference", "description": "Reference of the plate used to make the pipe.", "maxLength": 256, "example": "4db9b261", "type": "string" }, "billet_ref": { "title": "Billet Reference", "description": "Reference of the billet used to make the pipe.", "maxLength": 256, "example": "4db9b261", "type": "string" }, "length_act": { "title": "Length", "description": "The linepipe actual :ref:`length`.", "example": { "val": 12.252, "unit": "m" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "mass": { "title": "Mass of the linepipe", "description": "Linepipe nominal :ref:`Mass`, empty in air.", "example": [ { "val": 398.7, "unit": "kg" }, { "val": 398700.0, "unit": "g" } ], "allOf": [ { "$ref": "#/definitions/Mass" } ] }, "manuf_date_time": { "title": "Manufacture Date and Time", "description": "Date of manufacturing.", "example": [ "2032-04-23T10:20:30.400+02:30" ], "type": "string", "format": "date-time" }, "manuf_cpy": { "title": "Manufacturer", "description": "Name of the company who manufactured the linepipe.", "maxLength": 256, "example": "Vallourec", "type": "string" }, "manuf_mill": { "title": "Pipe Mill", "description": "Mill facilities that made the linepipe.", "maxLength": 256, "example": "Dalmine", "type": "string" }, "manuf_process": { "title": "Process of Manufacture", "description": "Process used to make the main pipe.", "example": "SMLS", "enum": [ "EBW", "LBW", "HFI", "MWPHFW", "SAW", "SAWL", "SAWH", "SMLS" ], "type": "string" }, "marking": { "title": "Marking", "description": "Marking for the linepipe.", "examples": [ "DNVGL SMLS 450 SP 323.9 x 14.3", "DNVGL MWPL 415 D L - UNS S31600 (B) UNS N06625 (E)", "X API Spec 5L 508 12,7 L360M PSL 2 SAWL Y Z TESTED 17,5" ], "type": "string" }, "material_type": { "title": "Material Type", "description": "Material type used to make the pipe.", "example": [ "C-Mn", "LINED/CLAD", "CRA" ], "enum": [ "C-Mn", "CRA", "LINED/CLAD" ], "type": "string" }, "delivery_condition_api5L": { "title": "Delivery Condition (API 5L)", "description": "Delivery condition for the pipe.", "example": [ "M", "Q" ], "enum": [ "R", "N", "Q", "M" ], "type": "string" }, "supp_req_api5L": { "title": "Supplementary Requirement, API5L", "description": "Supplementary requirements from the purchaser, as per DNV.", "example": [ "['O', 'S']", "['O']" ], "type": "array", "items": { "enum": [ "S", "O", "N" ], "type": "string" } }, "supp_req_dnv": { "title": "Supplementary Requirement, DNV", "description": "Supplementary requirements from the purchaser, as per DNV.", "example": [ "['S', 'P']", "['U']" ], "type": "array", "items": { "enum": [ "D", "F", "P", "S", "U" ], "type": "string" } }, "mill_test_pressure": { "title": "Actual Mill Hydrotest Pressure", "description": "Pressure at which the linepipe is hydrotested at the mill.", "example": { "val": 405, "unit": "bar" }, "allOf": [ { "$ref": "#/definitions/Pressure" } ] }, "int_dia_avg_end_a": { "title": "Internal Diameter, average, A-end, measured.", "description": "Internal diameter of the linepipe, average, end A, measured.", "example": [ { "val": 368.2, "unit": "mm" } ], "allOf": [ { "$ref": "#/definitions/Length" } ] }, "int_dia_avg_end_b": { "title": "Internal Diameter, average, B-end, measured.", "description": "Internal diameter of the linepipe, average, end B, measured.", "example": [ { "val": 368.2, "unit": "mm" } ], "allOf": [ { "$ref": "#/definitions/Length" } ] }, "wth_avg_end_a": { "title": "Wall Thickness, average, A-end, measured.", "description": "Wall thickness of the linepipe, average, end A, measured.", "example": [ { "val": 19.1, "unit": "mm" } ], "allOf": [ { "$ref": "#/definitions/Length" } ] }, "wth_avg_end_b": { "title": "Wall Thickness, average, B-end, measured.", "description": "Wall thickness of the linepipe, average, end B, measured.", "example": [ { "val": 19.1, "unit": "mm" } ], "allOf": [ { "$ref": "#/definitions/Length" } ] }, "oor_avg_end_a": { "title": "Out-of-roundness, average, A-end, measured", "description": "Actual out-of-roundness of the linepipe, average, end A, measured.", "example": { "val": 4.06, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "oor_avg_end_b": { "title": "Out-of-roundness, average, B-end, measured", "description": "Actual out-of-roundness of the linepipe, average, end B, measured.", "example": { "val": 4.06, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "oor_avg_body": { "title": "Out-of-roundness, body", "description": "Actual out-of-roundness of the linepipe body,average, measured.", "example": { "val": 4.06, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "related_bare_pipe_spec": { "title": "Relations to Bare Pipe Specifications", "description": "Related instances of :ref:`BarePipeSpec`, provided as array of :ref:`pdef_id`.", "example": [ "37e682a2-e4e5-497a-b252-ea4b4ea54bc0", "93b73ef3-cf5a-445e-a162-68fa6f246faa" ], "type": "array", "items": { "type": "string" } }, "records_of_pipe_damage": { "title": "Records of Pipe Damages", "description": "Embedded records of :ref:`PipeDamage`.", "type": "array", "items": { "$ref": "#/definitions/PipeDamage" } } }, "additionalProperties": false, "definitions": { "MetaData": { "title": "MetaData", "description": "Optional base JSON-fragment used to report meta data. User free structure.", "type": "object", "properties": {} }, "AdditionalData": { "title": "AdditionalData", "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.", "type": "object", "properties": {} }, "Length": { "title": "Length", "description": ":ref:`Measure` of a length, distance, thickness, diameter, etc", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }, "Mass": { "title": "Mass", "description": ":ref:`Measure` of mass", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "g", "kg", "lb", "lbs", "t" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }, "Pressure": { "title": "Pressure", "description": ":ref:`Measure` of pressure", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "Pa", "kPa", "MPa", "GPa", "psi", "kpsi", "bar" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }, "PipeDamage": { "title": "PipeDamage", "description": "Gathers the records of damage observed and reported on a :ref:`BarePipe` instance. \n\n`PipeDamage` instances are stored in the `pipe_damage` member of :ref:`BarePipe`.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "pipe_damage", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "descr": { "title": "Description", "description": "Descriptive text for the Pipe Damage.", "maxLength": 1000, "type": "string" }, "type": { "title": "Type of Damage", "description": "Descriptive text for the Pipe Damage.", "maxLength": 256, "type": "string" }, "raised_date_time": { "title": "Damage Detection Date and Time", "description": "Date and time when the damage was raised.", "example": "2032-04-23T10:20:30.400+02:30", "type": "string", "format": "date-time" }, "resolution": { "title": "Resolution", "description": "Descriptive text for the resolution.", "maxLength": 256, "type": "string" }, "resolution_date_time": { "title": "Damage resolution Date and Time", "description": "Date and time when the damage was resolved.", "example": "2032-04-23T10:20:30.400+02:30", "type": "string", "format": "date-time" } }, "additionalProperties": false } } }
- Config
extra: str = forbid
-
billet_ref: Optional[str] = PydanticUndefined Reference of the billet used to make the pipe.
- Constraints and examples:
maxLength = 256
example = 4db9b261
-
delivery_condition_api5L: Optional[Literal[R, N, Q, M]] = PydanticUndefined Delivery condition for the pipe.
- Constraints and examples:
example = [‘M’, ‘Q’]
-
heat_ref: Optional[str] = PydanticUndefined Reference of the heat used to make the pipe.
- Constraints and examples:
maxLength = 256
example = aa56593f6073
-
int_dia_avg_end_a: Optional[pdef.model.measure.Length] = PydanticUndefined Internal diameter of the linepipe, average, end A, measured.
- Constraints and examples:
example = [{‘val’: 368.2, ‘unit’: ‘mm’}]
-
int_dia_avg_end_b: Optional[pdef.model.measure.Length] = PydanticUndefined Internal diameter of the linepipe, average, end B, measured.
- Constraints and examples:
example = [{‘val’: 368.2, ‘unit’: ‘mm’}]
-
length_act: Optional[pdef.model.measure.Length] = PydanticUndefined The linepipe actual Length.
- Constraints and examples:
example = {‘val’: 12.252, ‘unit’: ‘m’}
-
manuf_cpy: Optional[str] = PydanticUndefined Name of the company who manufactured the linepipe.
- Constraints and examples:
maxLength = 256
example = Vallourec
-
manuf_date_time: Optional[datetime.datetime] = PydanticUndefined Date of manufacturing.
- Constraints and examples:
example = [‘2032-04-23T10:20:30.400+02:30’]
-
manuf_mill: Optional[str] = PydanticUndefined Mill facilities that made the linepipe.
- Constraints and examples:
maxLength = 256
example = Dalmine
-
manuf_process: Optional[Literal[EBW, LBW, HFI, MWPHFW, SAW, SAWL, SAWH, SMLS]] = PydanticUndefined Process used to make the main pipe.
- Constraints and examples:
example = SMLS
-
marking: Optional[str] = PydanticUndefined Marking for the linepipe.
- Constraints and examples:
examples = [‘DNVGL SMLS 450 SP 323.9 x 14.3’, ‘DNVGL MWPL 415 D L - UNS S31600 (B) UNS N06625 (E)’, ‘X API Spec 5L 508 12,7 L360M PSL 2 SAWL Y Z TESTED 17,5’]
-
mass: Optional[pdef.model.measure.Mass] = PydanticUndefined Linepipe nominal Mass, empty in air.
- Constraints and examples:
example = [{‘val’: 398.7, ‘unit’: ‘kg’}, {‘val’: 398700.0, ‘unit’: ‘g’}]
-
material_type: Optional[Literal[C-Mn, CRA, LINED/CLAD]] = PydanticUndefined Material type used to make the pipe.
- Constraints and examples:
example = [‘C-Mn’, ‘LINED/CLAD’, ‘CRA’]
-
mill_test_pressure: Optional[pdef.model.measure.Pressure] = PydanticUndefined Pressure at which the linepipe is hydrotested at the mill.
- Constraints and examples:
example = {‘val’: 405, ‘unit’: ‘bar’}
-
oor_avg_body: Optional[pdef.model.measure.Length] = PydanticUndefined Actual out-of-roundness of the linepipe body,average, measured.
- Constraints and examples:
example = {‘val’: 4.06, ‘unit’: ‘mm’}
-
oor_avg_end_a: Optional[pdef.model.measure.Length] = PydanticUndefined Actual out-of-roundness of the linepipe, average, end A, measured.
- Constraints and examples:
example = {‘val’: 4.06, ‘unit’: ‘mm’}
-
oor_avg_end_b: Optional[pdef.model.measure.Length] = PydanticUndefined Actual out-of-roundness of the linepipe, average, end B, measured.
- Constraints and examples:
example = {‘val’: 4.06, ‘unit’: ‘mm’}
-
part_number: Optional[str] = PydanticUndefined Object part_number, ie the manufacturer or purchaser part design number.
- Constraints and examples:
maxLength = 256
example = 100-440-0.750-3434-A
-
pdef_type: str = 'bare_pipe' - Constraints and examples:
const = bare_pipe
-
plate_ref: Optional[str] = PydanticUndefined Reference of the plate used to make the pipe.
- Constraints and examples:
maxLength = 256
example = 4db9b261
-
records_of_pipe_damage: Optional[List[pdef.model.bare_pipe.PipeDamage]] = PydanticUndefined Embedded records of PipeDamage.
-
related_bare_pipe_spec: Optional[List[str]] = PydanticUndefined Related instances of BarePipeSpec, provided as array of pdef_id.
- Constraints and examples:
example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]
-
serial_number: Optional[str] = PydanticUndefined Object serial_number, ie the manufacturer or purchaser item serial number.
- Constraints and examples:
maxLength = 256
example = P/N 12345
-
supp_req_api5L: Optional[List[Literal[S, O, N]]] = PydanticUndefined Supplementary requirements from the purchaser, as per DNV.
- Constraints and examples:
example = [“[‘O’, ‘S’]”, “[‘O’]”]
-
supp_req_dnv: Optional[List[Literal[D, F, P, S, U]]] = PydanticUndefined Supplementary requirements from the purchaser, as per DNV.
- Constraints and examples:
example = [“[‘S’, ‘P’]”, “[‘U’]”]
-
wth_avg_end_a: Optional[pdef.model.measure.Length] = PydanticUndefined Wall thickness of the linepipe, average, end A, measured.
- Constraints and examples:
example = [{‘val’: 19.1, ‘unit’: ‘mm’}]
-
wth_avg_end_b: Optional[pdef.model.measure.Length] = PydanticUndefined Wall thickness of the linepipe, average, end B, measured.
- Constraints and examples:
example = [{‘val’: 19.1, ‘unit’: ‘mm’}]
4.3.17.4. List BarePipe¶
Variable |
Type |
Description |
|---|---|---|
pdef_id |
<class ‘str’> |
pdef_id is the unique identifier for the object. |
pdef_type |
<class ‘str’> |
|
meta_data |
<class ‘pdef.model.metadata.MetaData’> |
Optional user free structured MetaData object. |
additional_data |
<class ‘pdef.model.additional_data.AdditionalData’> |
Optional user free structured Additional Data object. |
part_number |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Object part_number, ie the manufacturer or purchaser part design number. |
serial_number |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Object serial_number, ie the manufacturer or purchaser item serial number. |
heat_ref |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Reference of the heat used to make the pipe. |
plate_ref |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Reference of the plate used to make the pipe. |
billet_ref |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Reference of the billet used to make the pipe. |
length_act |
<class ‘pdef.model.measure.Length’> |
The linepipe actual Length. |
mass |
<class ‘pdef.model.measure.Mass’> |
Linepipe nominal Mass, empty in air. |
manuf_date_time |
<class ‘datetime.datetime’> |
Date of manufacturing. |
manuf_cpy |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Name of the company who manufactured the linepipe. |
manuf_mill |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Mill facilities that made the linepipe. |
manuf_process |
typing.Literal[‘EBW’, ‘LBW’, ‘HFI’, ‘MWPHFW’, ‘SAW’, ‘SAWL’, ‘SAWH’, ‘SMLS’] |
Process used to make the main pipe. |
marking |
<class ‘str’> |
Marking for the linepipe. |
material_type |
typing.Literal[‘C-Mn’, ‘CRA’, ‘LINED/CLAD’] |
Material type used to make the pipe. |
delivery_condition_api5L |
typing.Literal[‘R’, ‘N’, ‘Q’, ‘M’] |
Delivery condition for the pipe. |
supp_req_api5L |
typing.Literal[‘S’, ‘O’, ‘N’] |
Supplementary requirements from the purchaser, as per DNV. |
supp_req_dnv |
typing.Literal[‘D’, ‘F’, ‘P’, ‘S’, ‘U’] |
Supplementary requirements from the purchaser, as per DNV. |
mill_test_pressure |
<class ‘pdef.model.measure.Pressure’> |
Pressure at which the linepipe is hydrotested at the mill. |
int_dia_avg_end_a |
<class ‘pdef.model.measure.Length’> |
Internal diameter of the linepipe, average, end A, measured. |
int_dia_avg_end_b |
<class ‘pdef.model.measure.Length’> |
Internal diameter of the linepipe, average, end B, measured. |
wth_avg_end_a |
<class ‘pdef.model.measure.Length’> |
Wall thickness of the linepipe, average, end A, measured. |
wth_avg_end_b |
<class ‘pdef.model.measure.Length’> |
Wall thickness of the linepipe, average, end B, measured. |
oor_avg_end_a |
<class ‘pdef.model.measure.Length’> |
Actual out-of-roundness of the linepipe, average, end A, measured. |
oor_avg_end_b |
<class ‘pdef.model.measure.Length’> |
Actual out-of-roundness of the linepipe, average, end B, measured. |
oor_avg_body |
<class ‘pdef.model.measure.Length’> |
Actual out-of-roundness of the linepipe body,average, measured. |
related_bare_pipe_spec |
<class ‘str’> |
Related instances of BarePipeSpec, provided as array of pdef_id. |
records_of_pipe_damage |
<class ‘pdef.model.bare_pipe.PipeDamage’> |
Embedded records of PipeDamage. |
4.3.17.5. PipeDamage¶
4.3.17.5.1. Example PipeDamage¶
{
"pdef_id": "8d1ba434-c385-4166-883c-07f982cfaa32",
"pdef_type": "pipe_damage",
"meta_data": {},
"additional_data": {},
"descr": "Small shallow scratch at 2.4m from north end, approx 0.8m long.",
"type": "shallow scratch.",
"raised_date_time": "2022-05-03T09:50:41.287633",
"resolution": "accepted as-is.",
"resolution_date_time": "2022-05-03T09:50:41.287633"
}
4.3.17.5.2. Documentation PipeDamage¶
PipeDamage describes the damage and resolution that have to be reported about one BarePipe.
The various PipeDamage relevant for one tube are reported as an Nested Object into BarePipe.
4.3.17.5.3. Schema PipeDamage¶
-
pdef.model.bare_pipe.PipeDamage Gathers the records of damage observed and reported on a BarePipe instance.
PipeDamage instances are stored in the pipe_damage member of BarePipe.
Show JSON schema
{ "title": "PipeDamage", "description": "Gathers the records of damage observed and reported on a :ref:`BarePipe` instance. \n\n`PipeDamage` instances are stored in the `pipe_damage` member of :ref:`BarePipe`.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "pipe_damage", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "descr": { "title": "Description", "description": "Descriptive text for the Pipe Damage.", "maxLength": 1000, "type": "string" }, "type": { "title": "Type of Damage", "description": "Descriptive text for the Pipe Damage.", "maxLength": 256, "type": "string" }, "raised_date_time": { "title": "Damage Detection Date and Time", "description": "Date and time when the damage was raised.", "example": "2032-04-23T10:20:30.400+02:30", "type": "string", "format": "date-time" }, "resolution": { "title": "Resolution", "description": "Descriptive text for the resolution.", "maxLength": 256, "type": "string" }, "resolution_date_time": { "title": "Damage resolution Date and Time", "description": "Date and time when the damage was resolved.", "example": "2032-04-23T10:20:30.400+02:30", "type": "string", "format": "date-time" } }, "additionalProperties": false, "definitions": { "MetaData": { "title": "MetaData", "description": "Optional base JSON-fragment used to report meta data. User free structure.", "type": "object", "properties": {} }, "AdditionalData": { "title": "AdditionalData", "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.", "type": "object", "properties": {} } } }
- Config
extra: str = forbid
-
descr: Optional[str] = PydanticUndefined Descriptive text for the Pipe Damage.
- Constraints and examples:
maxLength = 1000
-
pdef_type: str = 'pipe_damage' - Constraints and examples:
const = pipe_damage
-
raised_date_time: Optional[datetime.datetime] = PydanticUndefined Date and time when the damage was raised.
- Constraints and examples:
example = 2032-04-23T10:20:30.400+02:30
-
resolution: Optional[str] = PydanticUndefined Descriptive text for the resolution.
- Constraints and examples:
maxLength = 256
-
resolution_date_time: Optional[datetime.datetime] = PydanticUndefined Date and time when the damage was resolved.
- Constraints and examples:
example = 2032-04-23T10:20:30.400+02:30
-
type: Optional[str] = PydanticUndefined Descriptive text for the Pipe Damage.
- Constraints and examples:
maxLength = 256
4.3.17.5.4. List PipeDamage¶
Variable |
Type |
Description |
|---|---|---|
pdef_id |
<class ‘str’> |
pdef_id is the unique identifier for the object. |
pdef_type |
<class ‘str’> |
|
meta_data |
<class ‘pdef.model.metadata.MetaData’> |
Optional user free structured MetaData object. |
additional_data |
<class ‘pdef.model.additional_data.AdditionalData’> |
Optional user free structured Additional Data object. |
descr |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Descriptive text for the Pipe Damage. |
type |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Descriptive text for the Pipe Damage. |
raised_date_time |
<class ‘datetime.datetime’> |
Date and time when the damage was raised. |
resolution |
<class ‘pdef.model.bare_pipe.ConstrainedStrValue’> |
Descriptive text for the resolution. |
resolution_date_time |
<class ‘datetime.datetime’> |
Date and time when the damage was resolved. |