4.3.1.1. Project (FV)¶
Note
Project is identified as Fully Validated.
4.3.1.1.1. Example Project¶
{
"pdef_id": "51e80923-68a8-4897-95ed-cf0800f4fbb1",
"pdef_type": "project",
"meta_data": {},
"additional_data": {},
"name": "Lapa SW Development",
"country": "Brazil",
"block": "BM-S-9",
"field": "Lapa",
"operator": "TotalEnergies",
"related_pipeline": [
"5782ab06-06e9-4d71-bc40-c9517412310f"
]
}
4.3.1.1.2. Schema Project¶
-
pdef.model.project.Project General project related data.
Show JSON schema
{ "title": "Project", "description": "General project related data.", "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": "project", "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" } ] }, "name": { "title": "name", "description": "The usual name of the project.", "maxLength": 256, "examples": [ "Lapa SW Development" ], "type": "string" }, "country": { "title": "country", "description": "The country of the project.", "examples": [ "Angola" ], "enum": [ "Afghanistan", "Aland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei Darussalam", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo, The Democratic Republic of the", "Cook Islands", "Costa Rica", "Cote D'Ivoire", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and Mcdonald Islands", "Holy See (Vatican City State)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran, Islamic Republic Of", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Democratic People's Republic of Korea", "Korea, Republic of", "Kosovo", "Kuwait", "Kyrgyzstan", "Lao People's Democratic Republic", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libyan Arab Jamahiriya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao", "Macedonia, The Former Yugoslav Republic of", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia, Federated States of", "Moldova, Republic of", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Territory, Occupied", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russian Federation", "Rwanda", "Saint Helena", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syrian Arab Republic", "Taiwan", "Tajikistan", "Tanzania, United Republic of", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Viet Nam", "Virgin Islands, British", "Virgin Islands, U.S.", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ], "type": "string" }, "block": { "title": "block", "description": "The main geographical Block to which the project is related.", "maxLength": 256, "examples": [ "Block 15" ], "type": "string" }, "field": { "title": "field", "description": "The main Field to which the project is related.", "maxLength": 256, "examples": [ "Begonia" ], "type": "string" }, "operator": { "title": "Operator", "description": "Name of the company operating the project.", "maxLength": 256, "examples": [ "ExxonMobil", "Petrobras", "Total E&P Angola", "Woodside" ], "type": "string" }, "related_pipeline": { "title": "Relations to :ref:`Pipeline`.", "description": "Related instances of :ref:`Pipeline`, provided as array of :ref:`pdef_id`.", "example": [ "pipeline_1", "pipeline_2" ], "type": "array", "items": { "type": "string" } } }, "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
-
block: Optional[str] = PydanticUndefined The main geographical Block to which the project is related.
- Constraints and examples:
maxLength = 256
examples = [‘Block 15’]
-
country: Optional[Literal[Afghanistan, Aland Islands, Albania, Algeria, American Samoa, Andorra, Angola, Anguilla, Antarctica, Antigua and Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Bouvet Island, Brazil, British Indian Ocean Territory, Brunei Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Cayman Islands, Central African Republic, Chad, Chile, China, Christmas Island, Cocos (Keeling) Islands, Colombia, Comoros, Congo, Congo, The Democratic Republic of the, Cook Islands, Costa Rica, Cote D’Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands (Malvinas), Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and Mcdonald Islands, Holy See (Vatican City State), Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Islamic Republic Of, Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Democratic People’s Republic of Korea, Korea, Republic of, Kosovo, Kuwait, Kyrgyzstan, Lao People’s Democratic Republic, Latvia, Lebanon, Lesotho, Liberia, Libyan Arab Jamahiriya, Liechtenstein, Lithuania, Luxembourg, Macao, Macedonia, The Former Yugoslav Republic of, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Micronesia, Federated States of, Moldova, Republic of, Monaco, Mongolia, Montenegro, Montserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norfolk Island, Northern Mariana Islands, Norway, Oman, Pakistan, Palau, Palestinian Territory, Occupied, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Puerto Rico, Qatar, Reunion, Romania, Russian Federation, Rwanda, Saint Helena, Saint Kitts and Nevis, Saint Lucia, Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syrian Arab Republic, Taiwan, Tajikistan, Tanzania, United Republic of, Thailand, Timor-Leste, Togo, Tokelau, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Turks and Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, United States Minor Outlying Islands, Uruguay, Uzbekistan, Vanuatu, Venezuela, Viet Nam, Virgin Islands, British, Virgin Islands, U.S., Wallis and Futuna, Western Sahara, Yemen, Zambia, Zimbabwe]] = PydanticUndefined The country of the project.
- Constraints and examples:
examples = [‘Angola’]
-
field: Optional[str] = PydanticUndefined The main Field to which the project is related.
- Constraints and examples:
maxLength = 256
examples = [‘Begonia’]
-
name: Optional[str] = PydanticUndefined The usual name of the project.
- Constraints and examples:
maxLength = 256
examples = [‘Lapa SW Development’]
-
operator: Optional[str] = PydanticUndefined Name of the company operating the project.
- Constraints and examples:
maxLength = 256
examples = [‘ExxonMobil’, ‘Petrobras’, ‘Total E&P Angola’, ‘Woodside’]
-
pdef_type: str = 'project' - Constraints and examples:
const = project
-
related_pipeline: Optional[List[str]] = PydanticUndefined Related instances of Pipeline (FV), provided as array of pdef_id.
- Constraints and examples:
example = [‘pipeline_1’, ‘pipeline_2’]
4.3.1.1.3. List Project¶
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. |
name |
<class ‘pdef.model.project.ConstrainedStrValue’> |
The usual name of the project. |
country |
typing.Literal[‘Afghanistan’, ‘Aland Islands’, ‘Albania’, ‘Algeria’, ‘American Samoa’, ‘Andorra’, ‘Angola’, ‘Anguilla’, ‘Antarctica’, ‘Antigua and Barbuda’, ‘Argentina’, ‘Armenia’, ‘Aruba’, ‘Australia’, ‘Austria’, ‘Azerbaijan’, ‘Bahamas’, ‘Bahrain’, ‘Bangladesh’, ‘Barbados’, ‘Belarus’, ‘Belgium’, ‘Belize’, ‘Benin’, ‘Bermuda’, ‘Bhutan’, ‘Bolivia’, ‘Bosnia and Herzegovina’, ‘Botswana’, ‘Bouvet Island’, ‘Brazil’, ‘British Indian Ocean Territory’, ‘Brunei Darussalam’, ‘Bulgaria’, ‘Burkina Faso’, ‘Burundi’, ‘Cambodia’, ‘Cameroon’, ‘Canada’, ‘Cape Verde’, ‘Cayman Islands’, ‘Central African Republic’, ‘Chad’, ‘Chile’, ‘China’, ‘Christmas Island’, ‘Cocos (Keeling) Islands’, ‘Colombia’, ‘Comoros’, ‘Congo’, ‘Congo, The Democratic Republic of the’, ‘Cook Islands’, ‘Costa Rica’, “Cote D’Ivoire”, ‘Croatia’, ‘Cuba’, ‘Cyprus’, ‘Czech Republic’, ‘Denmark’, ‘Djibouti’, ‘Dominica’, ‘Dominican Republic’, ‘Ecuador’, ‘Egypt’, ‘El Salvador’, ‘Equatorial Guinea’, ‘Eritrea’, ‘Estonia’, ‘Ethiopia’, ‘Falkland Islands (Malvinas)’, ‘Faroe Islands’, ‘Fiji’, ‘Finland’, ‘France’, ‘French Guiana’, ‘French Polynesia’, ‘French Southern Territories’, ‘Gabon’, ‘Gambia’, ‘Georgia’, ‘Germany’, ‘Ghana’, ‘Gibraltar’, ‘Greece’, ‘Greenland’, ‘Grenada’, ‘Guadeloupe’, ‘Guam’, ‘Guatemala’, ‘Guernsey’, ‘Guinea’, ‘Guinea-Bissau’, ‘Guyana’, ‘Haiti’, ‘Heard Island and Mcdonald Islands’, ‘Holy See (Vatican City State)’, ‘Honduras’, ‘Hong Kong’, ‘Hungary’, ‘Iceland’, ‘India’, ‘Indonesia’, ‘Iran, Islamic Republic Of’, ‘Iraq’, ‘Ireland’, ‘Isle of Man’, ‘Israel’, ‘Italy’, ‘Jamaica’, ‘Japan’, ‘Jersey’, ‘Jordan’, ‘Kazakhstan’, ‘Kenya’, ‘Kiribati’, “Democratic People’s Republic of Korea”, ‘Korea, Republic of’, ‘Kosovo’, ‘Kuwait’, ‘Kyrgyzstan’, “Lao People’s Democratic Republic”, ‘Latvia’, ‘Lebanon’, ‘Lesotho’, ‘Liberia’, ‘Libyan Arab Jamahiriya’, ‘Liechtenstein’, ‘Lithuania’, ‘Luxembourg’, ‘Macao’, ‘Macedonia, The Former Yugoslav Republic of’, ‘Madagascar’, ‘Malawi’, ‘Malaysia’, ‘Maldives’, ‘Mali’, ‘Malta’, ‘Marshall Islands’, ‘Martinique’, ‘Mauritania’, ‘Mauritius’, ‘Mayotte’, ‘Mexico’, ‘Micronesia, Federated States of’, ‘Moldova, Republic of’, ‘Monaco’, ‘Mongolia’, ‘Montenegro’, ‘Montserrat’, ‘Morocco’, ‘Mozambique’, ‘Myanmar’, ‘Namibia’, ‘Nauru’, ‘Nepal’, ‘Netherlands’, ‘Netherlands Antilles’, ‘New Caledonia’, ‘New Zealand’, ‘Nicaragua’, ‘Niger’, ‘Nigeria’, ‘Niue’, ‘Norfolk Island’, ‘Northern Mariana Islands’, ‘Norway’, ‘Oman’, ‘Pakistan’, ‘Palau’, ‘Palestinian Territory, Occupied’, ‘Panama’, ‘Papua New Guinea’, ‘Paraguay’, ‘Peru’, ‘Philippines’, ‘Pitcairn’, ‘Poland’, ‘Portugal’, ‘Puerto Rico’, ‘Qatar’, ‘Reunion’, ‘Romania’, ‘Russian Federation’, ‘Rwanda’, ‘Saint Helena’, ‘Saint Kitts and Nevis’, ‘Saint Lucia’, ‘Saint Pierre and Miquelon’, ‘Saint Vincent and the Grenadines’, ‘Samoa’, ‘San Marino’, ‘Sao Tome and Principe’, ‘Saudi Arabia’, ‘Senegal’, ‘Serbia’, ‘Seychelles’, ‘Sierra Leone’, ‘Singapore’, ‘Slovakia’, ‘Slovenia’, ‘Solomon Islands’, ‘Somalia’, ‘South Africa’, ‘South Georgia and the South Sandwich Islands’, ‘Spain’, ‘Sri Lanka’, ‘Sudan’, ‘Suriname’, ‘Svalbard and Jan Mayen’, ‘Swaziland’, ‘Sweden’, ‘Switzerland’, ‘Syrian Arab Republic’, ‘Taiwan’, ‘Tajikistan’, ‘Tanzania, United Republic of’, ‘Thailand’, ‘Timor-Leste’, ‘Togo’, ‘Tokelau’, ‘Tonga’, ‘Trinidad and Tobago’, ‘Tunisia’, ‘Turkey’, ‘Turkmenistan’, ‘Turks and Caicos Islands’, ‘Tuvalu’, ‘Uganda’, ‘Ukraine’, ‘United Arab Emirates’, ‘United Kingdom’, ‘United States’, ‘United States Minor Outlying Islands’, ‘Uruguay’, ‘Uzbekistan’, ‘Vanuatu’, ‘Venezuela’, ‘Viet Nam’, ‘Virgin Islands, British’, ‘Virgin Islands, U.S.’, ‘Wallis and Futuna’, ‘Western Sahara’, ‘Yemen’, ‘Zambia’, ‘Zimbabwe’] |
The country of the project. |
block |
<class ‘pdef.model.project.ConstrainedStrValue’> |
The main geographical Block to which the project is related. |
field |
<class ‘pdef.model.project.ConstrainedStrValue’> |
The main Field to which the project is related. |
operator |
<class ‘pdef.model.project.ConstrainedStrValue’> |
Name of the company operating the project. |
related_pipeline |
<class ‘str’> |
Related instances of Pipeline (FV), provided as array of pdef_id. |