Jump to

• Request
• Response

Batch Update Ideas

put

/api/restapi/idea/batch

Update multiple ideas with the list of json objects provided.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityIdeaInput>

Type: array

Title: List<ApiEntityIdeaInput>

Show Source

• Array of: object ApiEntityIdeaInput
  Title: ApiEntityIdeaInput

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

  • ideaId
  • ideaName,workspaceId
  • ideaName,workspaceCode

{
    "title":"List<ApiEntityIdeaInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityIdeaInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityIdeaInput

Type: object

Title: ApiEntityIdeaInput

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

• ideaId
• ideaName,workspaceId
• ideaName,workspaceCode

Show Source

• benefits: string
  Maximum Length: 4000

  A description of the anticipated benefits of implementing the idea.
• codeValuesIdea: array codeValuesIdea
  The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for an idea.
• evaluationScore: number (double)
  Details describing the evaluation matrix.
• ideaCode: string
  Maximum Length: 60

  The unique identifier for the Idea.
• ideaId: integer (int64)
  The system-generated identifier of an idea.
• ideaName(required): string
  Maximum Length: 255

  The name of the Idea.
• owner: string
  Maximum Length: 255

  The user responsible for the idea.
• problemOrOpportunity: string
  Maximum Length: 4000

  A detailed description of the problem or opportunity the idea addresses.
• proposedSolution: string
  Maximum Length: 4000

  The proposed solution to the problem the idea addresses.
• status: string
  Allowed Values: [ "NEW", "SUBMITTED", "ACCEPTED", "REJECTED", "OWNER_ASSIGNED", "PROPOSAL" ]

  The status of the idea. Valid values are new, accepted, rejected, and owner assigned.
• statusReason: string
  Maximum Length: 4000

  The reason the idea status was changed.
• workspaceCode: string
  Maximum Length: 60

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

{
    "title":"ApiEntityIdeaInput",
    "required":[
        "ideaName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "evaluationScore":{
            "type":"number",
            "description":"Details describing the evaluation matrix.",
            "format":"double",
            "exampleSetFlag":false
        },
        "owner":{
            "maxLength":255,
            "type":"string",
            "description":"The user responsible for the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the idea. Valid values are new, accepted, rejected, and owner assigned.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "SUBMITTED",
                "ACCEPTED",
                "REJECTED",
                "OWNER_ASSIGNED",
                "PROPOSAL"
            ]
        },
        "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"
            ]
        },
        "proposedSolution":{
            "maxLength":4000,
            "type":"string",
            "description":"The proposed solution to the problem the idea addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefits":{
            "maxLength":4000,
            "type":"string",
            "description":"A description of the anticipated benefits of implementing the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for an idea.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityIdeaConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "statusReason":{
            "maxLength":4000,
            "type":"string",
            "description":"The reason the idea status was changed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValuesIdea":{
            "type":"array",
            "description":"The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueIdeaInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":4000,
            "type":"string",
            "description":"A detailed description of the problem or opportunity the idea addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Idea object, a unique Idea object can be identified by the following combinations of the fields.<ul><li>ideaId</li><li>ideaName,workspaceId</li><li>ideaName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValuesIdea

Type: array

The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueIdeaInput
  Title: ApiEntityCodeValueIdeaInput

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

  • codeValueIdeaId
  • codeValueId
  • codeTypeCode,codeValueCode
  • codeTypeCode,codeValueCode,parentId
  • codeValueCode,codeTypeId,parentId
  • codeTypeId,codeValueCode

{
    "type":"array",
    "description":"The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueIdeaInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for an idea.

Show Source

• Array of: object ApiEntityIdeaConfiguredFieldValueInput
  Title: ApiEntityIdeaConfiguredFieldValueInput

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

  • ideaConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for an idea.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityIdeaConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueIdeaInput

Type: object

Title: ApiEntityCodeValueIdeaInput

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

• codeValueIdeaId
• codeValueId
• codeTypeCode,codeValueCode
• codeTypeCode,codeValueCode,parentId
• codeValueCode,codeTypeId,parentId
• codeTypeId,codeValueCode

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueIdeaId: integer (int64)
  The system-generated identifier of a code value idea assignment.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• ideaId: integer (int64)
  The system-generated identifier of an idea.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.

{
    "title":"ApiEntityCodeValueIdeaInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueIdeaId":{
            "type":"integer",
            "description":"The system-generated identifier of a code value idea assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueIdea object, a unique CodeValueIdea object can be identified by the following combinations of the fields.<ul><li>codeValueIdeaId</li><li>codeValueId</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,codeValueCode,parentId</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeId,codeValueCode</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityIdeaConfiguredFieldValueInput

Type: object

Title: ApiEntityIdeaConfiguredFieldValueInput

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

• ideaConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• 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.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• ideaConfiguredFieldValueId: integer (int64)
  The unique identifier for the idea configured field.
• ideaId: integer (int64)
  The system-generated identifier of an idea.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityIdeaConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "ideaConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the idea configured field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "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"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a IdeaConfiguredFieldValue object, a unique IdeaConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>ideaConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Ideas Batch Update Ideas by Assigning Hierarchical Code Values Using Codes Batch Update Ideas to Assign Configured Field Batch Update Ideas by Assigning Code Values Using Codes or IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the idea service.

Back to Top