Plant concepts

Upload plant concepts

post/plant-concepts

Query parameters

dry_runboolean

If true, validates and previews the upload without persisting any data. The response will be wrapped in a dry_run_data envelope.

deactivation'none' | 'by_party'

Which existing concepts to deactivate in VegBank by setting their status stop date to now:

none: Don't dactivate any concepts
by_party: Deactivate all concepts associated with any party linked to concepts in the uploaded data
by_party_below_order: Like by_party, but only for concepts at Family level and below

Response

Upload accepted. When dry_run=false (default), returns an upload summary. When dry_run=true, the same summary is nested under dry_run_data and the data is not actually inserted into VegBank.

Example response

{
  "counts": {
    "xx": {
      "inserted": 1
    },
    "yy": {
      "inserted": 2
    },
    "ds": {
      "inserted": 1
    }
  },
  "resources": {
    "xx": [
      {
        "action": "INSERT",
        "user_xx_code": "my_xx_code",
        "vb_xx_code": "xx.123"
      }
    ],
    "yy": [
      {
        "action": "INSERT",
        "user_yy_code": "my_yy_code_1",
        "vb_yy_code": "yy.123"
      }
    ],
    "ds": [
      {
        "action": "INSERT",
        "user_ds_code": "upload_dataset_20260325110254",
        "vb_ds_code": "ds.123"
      }
    ]
  }
}

Changes

Changed in 8 of the 50 revisions of this API.8315

Mar 26, 20264c741713474d56See the full diff
- ▲
  added the new required request property plant_concepts
  new-required-request-property
- ▲
  request body became required
  request-body-became-required
- ▲
  the request's body type/format changed from array/ to object/
  request-body-type-changed
- ▲
  added UploadSummary subschema #2: DryRunSummary to the response body oneOf list for the response status 200
  response-body-one-of-added
- ▲
  the response's body type/format changed from array/ to / for status 200
  response-body-type-changed
- ○
  added the new optional query request parameter deactivation
  new-optional-request-parameter
- ○
  added the new optional query request parameter dry_run
  new-optional-request-parameter
- ○
  added the new optional request property parties
  new-optional-request-property
- ○
  added the new optional request property plant_correlations
  new-optional-request-property
- ○
  added the new optional request property plant_names
  new-optional-request-property
- ○
  added the new optional request property references
  new-optional-request-property
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 202631e82224728b11See the full diff
- ▲
  the items/ request property type/format changed from / to object/
  request-property-type-changed
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 3, 20268dc2742f6a172See the full diff
- ○
  the endpoint scheme security oauth2 was removed from the API
  api-security-removed
- ○
  the items/ request property type/format was generalized from object/ to /
  request-property-type-generalized
This revision also has 37 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 2, 20268e27e0e126e71See the full diff
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 2, 20268abfd084d7aa1See the full diff
- ▲
  the items/ request property type/format changed from / to object/
  request-property-type-changed
Jan 18, 20262e123831df6e34See the full diff
- ●
  removed the request property items/accession_code
  request-property-removed
- ●
  removed the request property items/plant_name
  request-property-removed
- ●
  removed the request property items/reference
  request-property-removed
- ○
  api operation id upload-pc was added
  api-operation-id-added
- ○
  api tag Plant concepts added
  api-tag-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 24, 202516a2946a00d01See the full diff
- ○
  endpoint added
  endpoint-added
Apr 29, 2025c9e23cb778c91See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 83 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history