Jump to

• Request
• Response
• Examples

Update a comment

patch

/fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}/child/IdeaComment/{IdeaCommentId}

Request

Path Parameters

• IdeaCommentId(required): integer(int64)
  Value that uniquely identifies the comment.
• IdeaId(required): integer(int64)
  Value that uniquely identifies an idea.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• IdeaComment: string (byte)
  Text that describes the comment.
• IdeaId: integer (int64)
  Value that uniquely identifies the idea.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the record in the database.

{
    "type":"object",
    "properties":{
        "IdeaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the idea.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the record in the database.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "IdeaComment":{
            "type":"string",
            "description":"Text that describes the comment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : ideas-IdeaComment-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the comment.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the comment record.
• DisplayName: string
  Read Only: true

  Display name of the user who added the comment.
• IdeaComment: string (byte)
  Text that describes the comment.
• IdeaCommentId: integer (int64)
  Value that uniquely identifies the comment.
• IdeaId: integer (int64)
  Value that uniquely identifies the idea.
• IdeaName: string
  Read Only: true

  Name of the idea.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the comment.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the record in the database.
• PersonId: integer
  Read Only: true

  Value that uniquely identifies the user.
• UserName: string
  Read Only: true

  Maximum Length: 100

  Login that the user used when adding the comment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the comment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"100",
            "type":"string",
            "description":"Login that the user used when adding the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaCommentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IdeaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the idea.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the record in the database.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "IdeaName":{
            "type":"string",
            "description":"Name of the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "type":"string",
            "description":"Display name of the user who added the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the comment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaComment":{
            "type":"string",
            "description":"Text that describes the comment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update a comment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/ideas/IdeaId/child/IdeaComment/IdeaCommentId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"IdeaComment": "VGVzdCBjcmVhdGUgY29tbWVudHMgZnJvbSByZXN0ZnVsbCBXUy4K"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"CreatedBy": "PRODUCT_MANAGER",
	"CreationDate": "2020-12-11T09:00:08+00:00",
	"IdeaCommentId": 300100240929920,
	"IdeaId": 300100240921318,
	"IdeaName": "Flying-Bike-Idea-202012110938",
	"LastUpdateDate": "2020-12-11T09:03:17+00:00",
	"LastUpdatedBy": "PRODUCT_MANAGER",
	"ObjectVersionNumber": 2,
	"UserName": "PRODUCT_MANAGER",
	"PersonId": 100010038038308,
	"DisplayName": "Product Manager",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaComment/300100240929920",
		"name": "IdeaComment",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaComment/300100240929920",
		"name": "IdeaComment",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318",
		"name": "ideas",
		"kind": "item"
	},
	{
		"rel": "enclosure",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaComment/300100240929920/enclosure/IdeaComment",
		"name": "IdeaComment",
		"kind": "other"
	}
	]
}

Back to Top