Jump to

• Request
• Response

Sort Values of a List type Configured Field

post

/api/restapi/configuredField/list/values/sort

This endpoint reorders the values of a list type configured field alpha-numerically either in ascending or descending order.

The required input combinations are:
For Configured Fields with flexObject as PROGRAM, DOCUMENT, IDEA or STRATEGY -

• flexObject,columnDefinitionId
• flexObject,viewColumnName,workspaceId
• flexObject,viewColumnName,workspaceCode
• flexObject,label,workspaceId
• flexObject,label,workspaceCode

For Configured Fields with flexObject other than PROGRAM, DOCUMENT, IDEA or STRATEGY like PROJECT, ACTIVITY etc -

• flexObject,columnDefinitionId
• flexObject,viewColumnName
• flexObject,label

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityColumnDefinitionSortInput

Type: object

Title: ApiEntityColumnDefinitionSortInput

Show Source

• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• flexObject: string
  Allowed Values: [ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ]

  Flex Object to be saved.
• label: string
  The label of a configured field.
• sortOrder: string
  Allowed Values: [ "ASCENDING", "DESCENDING" ]

  The order in which the list values needs to be alpha-numerically sorted. Order default to ASCENDING if no value is provided in request.
• viewColumnName: string
  The view column name of a configured field.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityColumnDefinitionSortInput",
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"The label of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flexObject":{
            "type":"string",
            "description":"Flex Object to be saved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY",
                "ASSIGNMENT",
                "BUDGET_CHANGE",
                "BUDGET_ITEM",
                "BUDGET_TRANSACTION",
                "BUDGET_TRANSFER",
                "COMPANY",
                "CUSTOM_LOG",
                "DOCUMENT",
                "FUND",
                "IDEA",
                "PORTFOLIO",
                "PROGRAM",
                "PROGRAM_BUDGET",
                "PROGRAM_BUDGET_CHANGES",
                "PROGRAM_BUDGET_TRANSACTIONS",
                "PROGRAM_BUDGET_TRANSFERS",
                "PROJECT",
                "PROJECT_ACTUALS",
                "PROJECT_COST_SHEET",
                "RISK",
                "SCOPE_ITEM",
                "SCOPE_ITEM_ASSIGNMENT",
                "STRATEGY",
                "WBS",
                "WORK_MANAGER_TASK",
                "WORK_PACKAGE",
                "WORKSPACE_COST_SHEET"
            ]
        },
        "viewColumnName":{
            "type":"string",
            "description":"The view column name of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sortOrder":{
            "type":"string",
            "description":"The order in which the list values needs to be alpha-numerically sorted. Order default to ASCENDING if no value is provided in request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASCENDING",
                "DESCENDING"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

200 Response

The object was successfully created.

400 Response

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

Back to Top