Jump to

• Request
• Response

View Ideas by Name and Workspace

get

/api/restapi/idea/{ideaName}/workspace/{workspaceId}

Returns an idea object under a workspace with the specified code.

Request

Path Parameters

• ideaName(required): string
  The user-specified name of the idea.
• workspaceId(required): integer(int64)
  The system-generated identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityIdea

Type: object

Title: ApiEntityIdea

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.
• createDate: string (date-time)
  The date and time when the idea was created.
• createUser: string
  Maximum Length: 255

  The user who created the 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: string
  Maximum Length: 255

  The name of the Idea.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• statusDate: string (date-time)
  The date and time the idea status was changed.
• statusReason: string
  Maximum Length: 4000

  The reason the idea status was changed.
• submitDate: string (date-time)
  The date and time the idea was submitted.
• submitUser: string
  Maximum Length: 255

  The user who submitted the idea.
• updateDate: string (date-time)
  Date when the record was last updated.
• updateUser: string
  Maximum Length: 255

  The user who last updated the idea.
• workspaceCode: string
  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":"ApiEntityIdea",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The date and time when the idea was created.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for an idea.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityIdeaConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the problem or opportunity the idea addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusDate":{
            "type":"string",
            "description":"The date and time the idea status was changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"The date and time the idea was submitted.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefits":{
            "maxLength":"4000",
            "type":"string",
            "description":"A description of the anticipated benefits of implementing the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusReason":{
            "maxLength":"4000",
            "type":"string",
            "description":"The reason the idea status was changed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who submitted the idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedSolution":{
            "maxLength":"4000",
            "type":"string",
            "description":"The proposed solution to the problem the idea addresses.",
            "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/ApiEntityCodeValueIdea",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "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 ApiEntityCodeValueIdea
  Title: ApiEntityCodeValueIdea

{
    "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/ApiEntityCodeValueIdea",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for an idea.

Show Source

• Array of: object ApiEntityIdeaConfiguredFieldValue
  Title: ApiEntityIdeaConfiguredFieldValue

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

Nested Schema : ApiEntityCodeValueIdea

Type: object

Title: ApiEntityCodeValueIdea

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.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueIdea",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "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"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"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"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityIdeaConfiguredFieldValue

Type: object

Title: ApiEntityIdeaConfiguredFieldValue

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.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityIdeaConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested idea does not exist, or you do not have access to it.

Back to Top