Framework

Update Framework Name

Changed on

Update the name of a framework.

patch/v2/framework/{framework_id}/name

Request

  • Base URL: https://api.carbonarc.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.carbonarc.co/v2/framework/{framework_id}/name
  • Auth: none declared

Path parameters

framework_idstring uuid required

Request body

namestring required
configobject nullable

Response

Successful Response

idstring uuid nullable
namestring nullable
refreshed_datestring nullable required
reinstated_datestring nullable required
reinstatement_reason'Ontology Change' | 'Full Refresh' | 'Vendor Reinstatement' | 'Vendor Backfill' | 'Logic Enhancement' required
ontology_versionstring required
pricenumber required
table_max_datestring nullable required
data_typestring[] nullable
messagestring nullable
latest_framework_idstring uuid nullable
is_supersededboolean

Changes

  • 766fe5f73174Revision changes
    • warning

      added the new latest enum value to the // response property for the response status

    • warning

      added the new max enum value to the // response property for the response status

  • 1d445d2a69b5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status