Skip to main content
Browse Documentation
HTTP - Management

Update a component

Created by Contensis product team, last modified by zengenti on 29 Sep 2021

Updates an existing component resource.

PUT/api/management/projects/{projectId}/components/{componentId}

Parameters

NameParameter typeTypeDescriptionExampleRequired
projectIdpathstringThe project identifier found in the project overview screen of the management consolemovieDbtrue
componentIdpathstringThe component identifier.true

Example

JSON
PUT: /api/management/projects/movieDb/components/movieRole { "id": "movieRole", "projectId": "website", "name": { "en-GB": "Movie Role" }, "description": { "en-GB": "A Persons role within a movie" }, "fields": [ { "id": "person", "name": { "en-GB": "Person" }, "dataType": "object", "dataFormat": "entry", "description": { "en-GB": "The actor or crew member" }, "default": {}, "validations": { "allowedContentTypes": { "contentTypes": ["person"] } }, "editor": { "id": "entry", "instructions": { "en-GB": "" }, "properties": { "placeholderText": { "en-GB": "" } } } }, { "id": "role", "name": { "en-GB": "Role" }, "dataType": "String", "dataFormat": null, "description": {}, "default": {}, "validations": null, "editor": null } ], "workflowId": "ContensisDefault", "dataFormat": "component", }

Responses

HTTP status codeReasonModel
200SuccessComponent
401UnauthorizedError
404Component not foundError
409Resource already existsError
422Validation errorError
500Internal server errorError