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
Root Schema : List<ApiEntityIdeaInput>
Type:
array
Title:
Show Source
List<ApiEntityIdeaInput>
-
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
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.
Show Source
- ideaId
- ideaName,workspaceId
- ideaName,workspaceCode
-
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.
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
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
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.
Show Source
- codeValueIdeaId
- codeValueId
- codeTypeCode,codeValueCode
- codeTypeCode,codeValueCode,parentId
- codeValueCode,codeTypeId,parentId
- codeTypeId,codeValueCode
-
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.
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.
Show Source
- ideaConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
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.
Examples
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.