Create a new draft resource.

Create a draft (do not submit) a new resource, using the appropriate form identifier. The new resource can be updated and submitted at a later time (Update an existing resource).

SecurityJWT
Request
path Parameters
formCode
required
string

The Resource form associated with the Resource; available from resource/v1/resource/summary.

Example: GHG_FOREST_SINGLE_NEW
Request Body schema: application/json
required

Use response from /form/core/cooked/metadata/{formCode}

identifier
string <uuid>

The Resource's unique system identifier; used for API calls

object (CodeVersion)

A code version data object

object (Account)

Account record

object (NaturalGeography)

Natural Geography

watermark
integer <int64>

Resource's watermark (read only). This is used for internal synchronization purposes

Array of objects (ResourceInputOutput)

A list of Resource's Inputs

Array of objects (ResourceInputOutput)

A list of Resource's outputs

Array of objects (ResourceParameter)

A list of Resource's Parameters

Array of objects (ResourceProgram)

A list of Registry Programs the Resource has registered for

Array of objects (ResourceProcess) unique

A list of Processes associated with the Resource

Array of objects (ResourceProject) unique

A list of Projects associated with the Resource, if applicable

Array of objects (ResourceProponent) unique

A list of the Resource's Proponents

embeddedResources
Array of objects (Resource) unique

A list of Embedded Resources, if applicable

Responses
200

OK

post/resource/draft/form/{formCode}/withForm
Request samples
application/json
{
  • "identifier": "e0c7bdbf-3031-11ec-b9d4-de0f29bf6378",
  • "establishingProgramVersion": {
    },
  • "account": {
    },
  • "naturalGeography": {
    },
  • "watermark": 0,
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "parameters": [
    ],
  • "programs": [
    ],
  • "processes": [
    ],
  • "projects": [
    ],
  • "proponents": [
    ],
  • "embeddedResources": [
    ]
}
Response samples
application/json
{
  • "entity": {
    },
  • "cookedFormMetadata": {
    },
  • "uiCode": "string"
}