Skip to main content

Update a component

Log in to add to favourites
PUT/api/management/projects/{projectId}/components/{componentId}

Parameters

NameParameter typeTypeDescription
projectId(required)pathstringThe project identifier found in the project overview screen of the management console.
componentId(required)pathstringThe component identifier.

Responses

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

Examples

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",
 }

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request