Retrieve an existing resource

View a specific existing resource, using the appropriate resource type form, using the resource identifier and form identifier.
SecurityJWT
Request
path Parameters

resourceId required	string <uuid> Resource's resource identifier; available in Resource Summary Example: 98b00f41-e840-11ee-936a-26ee6306d735
formCode required	string Resource's form code; available in Resource Summary Example: RMS_PLASTICS_M_PARENT_EDIT
Responses
200
get/resource/{resourceId}/form/{formCode}/withForm
Response samples
application/json
{"entity": {"identifier": "e0c7bdbf-3031-11ec-b9d4-de0f29bf6378",
"establishingProgramVersion": {"code": "string",
"name": "string",
"version": "string"
},
"account": {"srcAcctIdentifier": "string",
"srcAcctId": "4edse581-b97a-11ef-ea69-b61606fd520c"
},
"naturalGeography": {"address": {"addressModelCode": "RESOURCE",
"countryIso2Code": "US",
"countrySubdivisionCode": "US-NJ",
"countrySubdivisionName": "New Jersey",
"identifier": "f789fb82-e840-11ee-8492-5e76882005f5",
"municipality": "Basking Ridge",
"postalCode": "07920",
"resourceIdentifier": "98b00f41-e840-11ee-936a-26ee6306d735",
"street": "69 Patriot Hill Drive",
"suiteOfficeNumber": "Suite 1004"
},
"area": 70.5,
"areaUnitCode": "HA",
"draft": false,
"geography": "OrderedMap {}",
"identifier": "98b00f41-e840-11ee-936a-26ee6306d735",
"latitude": 33.35566,
"longitude": -79.133,
"naturalGeographyModelCode": "RESOURCE",
"newTopologyFile": {"content": "string",
"fileTypeCode": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"originalFileName": "string"
},
"resourceIdentifier": "98b00f41-e840-11ee-936a-26ee6306d735"
},
"watermark": 0,
"inputs": [{"selector": "f791c353-e840-11ee-936a-26ee6306d735",
"identifier": "f791c353-e840-11ee-936a-26ee6306d735",
"resourceInputOutputType": "\"code\": \"PROJECT_SITE\"",
"streams": [{"identifier": "f7923885-e840-11ee-936a-26ee6306d735",
"resourceInputOutputStreamType": "\"code\": \"PROJECT_SITE\"",
"streamIntervalType": "\"code\": \"PROJECT_SITE\"",
"intervalPeriodicity": "string",
"reportingEntityStreamIdentifier": "string",
"unitOfMeasure": "\"code\": \"PROJECT_SITE\"",
"readingProfileCode": "string",
"timeIntervals": [{"id": null,
"intervalBegin": null,
"intervalEnd": null,
"value": null,
"status": null,
"statusTransition": null,
"viableStatusTransitions": [ ]
}
],
"productIdentifier": "c899dd7b-0fe5-4556-a79a-8f2abd89a4fa"
}
],
"protocols": [{"status": "\"code\": \"PROJECT_SITE\"",
"programVersion": {"code": "string",
"name": "string",
"version": "string"
},
"protocolVersion": {"code": "string",
"name": "string",
"version": "string"
},
"programAssignedIdentifier": "PLS1184",
"programQualificationIdentifier": "AD56TY3",
"effectiveAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
],
"producingLinkages": [{"linkageModel": "\"code\": \"PROJECT_SITE\"",
"producingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"consumingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
]
}
],
"consumingLinkages": [{"linkageModel": "\"code\": \"PROJECT_SITE\"",
"producingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"consumingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
]
}
],
"classifications": [{"id": 0,
"classificationType": "\"code\": \"PROJECT_SITE\"",
"classification": "\"code\": \"PROJECT_SITE\""
}
]
}
],
"outputs": [{"selector": "f791c353-e840-11ee-936a-26ee6306d735",
"identifier": "f791c353-e840-11ee-936a-26ee6306d735",
"resourceInputOutputType": "\"code\": \"PROJECT_SITE\"",
"streams": [{"identifier": "f7923885-e840-11ee-936a-26ee6306d735",
"resourceInputOutputStreamType": "\"code\": \"PROJECT_SITE\"",
"streamIntervalType": "\"code\": \"PROJECT_SITE\"",
"intervalPeriodicity": "string",
"reportingEntityStreamIdentifier": "string",
"unitOfMeasure": "\"code\": \"PROJECT_SITE\"",
"readingProfileCode": "string",
"timeIntervals": [{"id": null,
"intervalBegin": null,
"intervalEnd": null,
"value": null,
"status": null,
"statusTransition": null,
"viableStatusTransitions": [ ]
}
],
"productIdentifier": "c899dd7b-0fe5-4556-a79a-8f2abd89a4fa"
}
],
"protocols": [{"status": "\"code\": \"PROJECT_SITE\"",
"programVersion": {"code": "string",
"name": "string",
"version": "string"
},
"protocolVersion": {"code": "string",
"name": "string",
"version": "string"
},
"programAssignedIdentifier": "PLS1184",
"programQualificationIdentifier": "AD56TY3",
"effectiveAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
],
"producingLinkages": [{"linkageModel": "\"code\": \"PROJECT_SITE\"",
"producingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"consumingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
]
}
],
"consumingLinkages": [{"linkageModel": "\"code\": \"PROJECT_SITE\"",
"producingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"consumingResourceInputOutput": {"identifier": "f79a9cff-e840-11ee-936a-26ee6306d735"
},
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
]
}
],
"classifications": [{"id": 0,
"classificationType": "\"code\": \"PROJECT_SITE\"",
"classification": "\"code\": \"PROJECT_SITE\""
}
]
}
],
"parameters": [{"id": 0,
"resourceParameterType": "\"code\": \"PROJECT_SITE\"",
"resourceProcess": {"selectBy": "SELECTOR",
"selector": "f792fbd6-e840-11ee-936a-26ee6306d735"
},
"streams": [{"resourceParameterStreamType": "\"code\": \"PROJECT_SITE\"",
"timeIntervals": [{"id": null,
"intervalBegin": null,
"intervalEnd": null,
"value": null,
"status": null,
"statusTransition": null,
"viableStatusTransitions": [ ]
}
],
"currentTimeInterval": {"id": 0,
"intervalBegin": "2024-03-22T00:00:00-04:00",
"intervalEnd": "3000-01-01T00:00:00Z",
"value": 0,
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": "DELETE"
}
}
]
}
],
"programs": [{"programVersion": {"code": "string",
"name": "string",
"version": "string"
},
"name": "CY_RMSARCY_v1",
"resourceType": "\"code\": \"PROJECT_SITE\"",
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
],
"programAssignedIdentifier": "PLS1184",
"programQualificationIdentifier": "AD56TY3",
"resourceProgramWatermark": 0,
"aggregate": true,
"adminNotes": "string",
"programPeriodBeginInclusive": "2019-08-24T14:15:22Z",
"programPeriodEndExclusive": "2019-08-24T14:15:22Z",
"description": "string",
"initialProgramAuditor": {"programAuditorIdentifier": "eb3bafc0-e44a-4891-9ff0-58c047c5efae",
"legalEntity": {"adminNotes": "string",
"dbaName": "string",
"externalIdentifiers": [{"identifierType": null,
"identifierValue": null
}
],
"globalParent": true,
"identifier": "string",
"legalEntityNumber": "string",
"legalEntitySource": "\"code\": \"PROJECT_SITE\"",
"legalEntityType": "\"code\": \"PROJECT_SITE\"",
"name": "string",
"naturalGeography": {"address": {"addressModelCode": null,
"countryIso2Code": null,
"countrySubdivisionCode": null,
"countrySubdivisionName": null,
"identifier": null,
"municipality": null,
"postalCode": null,
"resourceIdentifier": null,
"street": null,
"suiteOfficeNumber": null
},
"area": 70.5,
"areaUnitCode": "HA",
"draft": false,
"geography": "OrderedMap {}",
"identifier": "98b00f41-e840-11ee-936a-26ee6306d735",
"latitude": 33.35566,
"longitude": -79.133,
"naturalGeographyModelCode": "RESOURCE",
"newTopologyFile": {"content": null,
"fileTypeCode": null,
"metadata": { },
"originalFileName": null
},
"resourceIdentifier": "98b00f41-e840-11ee-936a-26ee6306d735"
},
"parent": { },
"proposingSrcAcctId": "string",
"roles": [{"programs": [ ],
"roleType": null,
"status": null,
"statusEffectiveDate": null
}
],
"status": "\"code\": \"PROJECT_SITE\"",
"viableStatusTransitions": ["string"
],
"website": "string"
}
},
"priorProgram": "\"code\": \"PROJECT_SITE\"",
"priorProgramAssignedIdentifier": "string",
"priorProgramResourceDescription": "string",
"originalCreditingPeriodStartDate": "2019-08-24",
"classifications": [{"classificationType": "\"code\": \"PROJECT_SITE\"",
"classification": "\"code\": \"PROJECT_SITE\""
}
]
}
],
"processes": [{"selector": "string",
"identifier": "14d3030c-3b61-4070-b902-342f80e99364",
"status": "\"code\": \"PROJECT_SITE\"",
"name": "string",
"statusTransition": "string",
"viableStatusTransitions": ["string"
],
"processType": "\"code\": \"PROJECT_SITE\"",
"protocols": [{"id": 0,
"status": "\"code\": \"PROJECT_SITE\"",
"statusTransition": "string",
"viableStatusTransitions": ["string"
],
"protocolVersion": {"code": "string",
"name": "string",
"version": "string"
},
"programQualificationIdentifier": "string",
"effectiveAt": "2019-08-24T14:15:22Z"
}
],
"inputOutputs": [{"id": 0,
"resourceInputOutput": {"selectBy": "SELECTOR",
"selector": "f792fbd6-e840-11ee-936a-26ee6306d735"
},
"allowAllProtocols": true,
"protocols": [{"id": null,
"status": null,
"statusTransition": null,
"viableStatusTransitions": [ ],
"alwaysAdorn": null,
"protocolVersion": null,
"programQualificationIdentifier": null,
"effectiveAt": null
}
]
}
]
}
],
"projects": [{"resourceProjectType": "\"code\": \"PROJECT_SITE\"",
"identifier": "f79c4ab1-e840-11ee-936a-26ee6306d735",
"name": "RMSAR_CYTest",
"projectBegin": "2019-08-24T14:15:22Z",
"projectGoLive": "2022-12-31T18:30:00Z"
}
],
"proponents": [{"legalEntityIdentifier": "3a896df5-e840-11ee-90ea-2a6a898eb566",
"direct": true
}
],
"embeddedResources": [{ }
]
},
"cookedFormMetadata": {"code": "GHG_ENERGY_SINGLE_EDIT",
"action": "EDIT",
"entityEnriching": true,
"fields": [{"field": "string",
"edit": true,
"required": "EXCEPT_DRAFT",
"maxLength": 0,
"regex": "string",
"keyStatusField": "program[GHG_MEASUREMENT_PROGRAM:1.0.0].status",
"form": { },
"editForms": [{"key": "string",
"form": { }
}
],
"editFormKeyField": "string",
"onAdd": {"conditionalAuthorities": [{"criteria": [null
],
"editAuthorities": [null
],
"viewAuthorities": [null
]
}
]
},
"onEdit": {"conditionalAuthorities": [{"criteria": [null
],
"editAuthorities": [null
],
"viewAuthorities": [null
]
}
]
},
"intervalBeginIfNullBehavior": "START_OF_CURRENT_DAY",
"intervalEndIfNullBehavior": "END_OF_TIME",
"hints": "naturalGeographyProgramCode\": \"GHG_MEASUREMENT_PROGRAM"
}
],
"hints": [{"field": "string",
"collection": "DESIRED_STATE",
"create": "NEVER"
}
]
}
}