Jump to

• Request
• Response

Change Owning Workspace of a Configured Field

put

/api/restapi/configuredField/move

Send a request to this endpoint to change the owning workspace of a configured field.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityConfiguredFieldMoveRequestInput

Type: object

Title: ApiEntityConfiguredFieldMoveRequestInput

This entity represents a ConfiguredFieldMoveRequest object, a unique ConfiguredFieldMoveRequest object can be identified by the following combinations of the fields.

• columnDefinitionId, targetWorkspaceId
• columnDefinitionId, targetWorkspaceCode
• viewColumnName, owningWorkspaceId, targetWorkspaceId
• viewColumnName, owningWorkspaceCode, targetWorkspaceCode
• columnDefinitionId, targetWorkspaceId, objectType
• columnDefinitionId, targetWorkspaceCode, objectType
• viewColumnName, owningWorkspaceId, targetWorkspaceId, objectType
• viewColumnName, owningWorkspaceCode, targetWorkspaceCode, objectType

Show Source

• columnDefinitionId: integer (int64)
  The system-generated identifier of a configured field.
• objectType: string
  Allowed Values: [ "DOCUMENT", "IDEA", "PROGRAM", "STRATEGY" ]

  This is a required field for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.
• owningWorkspaceCode: string
  The user-specified identifier of the workspace that currently owns the configured field.
• owningWorkspaceId: integer (int64)
  The system-generated identifier of the workspace that currently owns the configured field.
• targetWorkspaceCode: string
  The user-specified identifier of the target workspace to which ownership of the configured field is moved.
• targetWorkspaceId: integer (int64)
  The system-generated identifier of the target workspace to which ownership of the configured field is moved.
• viewColumnName: string
  The view column name of a configured field.

{
    "title":"ApiEntityConfiguredFieldMoveRequestInput",
    "type":"object",
    "properties":{
        "objectType":{
            "type":"string",
            "description":"This is a required field for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DOCUMENT",
                "IDEA",
                "PROGRAM",
                "STRATEGY"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"The system-generated identifier of a configured field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "owningWorkspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of the workspace that currently owns the configured field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "owningWorkspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of the workspace that currently owns the configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetWorkspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of the target workspace to which ownership of the configured field is moved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetWorkspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of the target workspace to which ownership of the configured field is moved.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "viewColumnName":{
            "type":"string",
            "description":"The view column name of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ConfiguredFieldMoveRequest object, a unique ConfiguredFieldMoveRequest object can be identified by the following combinations of the fields.<ul><li>columnDefinitionId, targetWorkspaceId</li><li>columnDefinitionId, targetWorkspaceCode</li><li>viewColumnName, owningWorkspaceId, targetWorkspaceId</li><li>viewColumnName, owningWorkspaceCode, targetWorkspaceCode</li><li>columnDefinitionId, targetWorkspaceId, objectType</li><li>columnDefinitionId, targetWorkspaceCode, objectType</li><li>viewColumnName, owningWorkspaceId, targetWorkspaceId, objectType</li><li>viewColumnName, owningWorkspaceCode, targetWorkspaceCode, objectType</li>",
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request.

Back to Top