Jump to

• Request
• Response
• Examples

Create all comments

post

/fscmRestApi/resources/11.13.18.05/advancedControls/{Id}/child/incidents/{Id4}/child/comments

Request

Path Parameters

• Id(required): string
  The unique identifier of the advanced control.
• Id4(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• Delegated: string
  Default Value: N

  The flag indicating that the advanced-control comment was delegated.
• Id: integer
  The unique identifier of the advanced-control comment.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The text of the advanced-control comment.

{
    "type":"object",
    "properties":{
        "Delegated":{
            "type":"string",
            "description":"The flag indicating that the advanced-control comment was delegated.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the advanced-control comment.",
            "nullable":false
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The text of the advanced-control comment.",
            "nullable":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 : advancedControls-incidents-comments-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the advanced-control comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the advanced-control comment was created.
• Delegated: string
  Default Value: N

  The flag indicating that the advanced-control comment was delegated.
• Id: integer
  The unique identifier of the advanced-control comment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the advanced-control comment was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who updated the advanced-control comment most recently.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The text of the advanced-control comment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the advanced-control comment most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the advanced-control comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the advanced-control comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The text of the advanced-control comment.",
            "nullable":false,
            "x-queryable":true
        },
        "Delegated":{
            "type":"string",
            "description":"The flag indicating that the advanced-control comment was delegated.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the advanced-control comment.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the advanced-control comment was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

The following example shows how to create a comment for an incident by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A19/child/comments/3

Example Request Payload

The following example shows the contents of the request body in JSON format:

{  
	"ObjectId": "10011:19",
	"ObjectTypeCode": "GRCC_INCIDENT",
	"UserComment": "testing comment added by Rest" 
}

Example Response Body

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

{  
	"CreatedBy": "APPLICATION_CONTROL_MANAGER",
	"CreationDate": "2020-02-04T13:06:13-08:00",
	"Delegated": "N",
	"Id": 3,
	"LastUpdateDate": "2020-02-04T13:06:13.365-08:00",
	"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
	"ObjectId": "10011:19",
	"ObjectStateCode": "NEW",
	"ObjectTypeCode": "GRCC_INCIDENT",
	"UserComment": "testing comment added by Rest",
	"links": [    
		{      
			"rel": "self",
			"href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A19/child/comments/3",
			"name": "comments",
			"kind": "item",
			"properties": 
				{        
				"changeIndicator": "ACED00........78"      
				}    
		},    
		{      
			"rel": "canonical",
			"href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A19/child/comments/3",
			"name": "comments",
			"kind": "item"    
		},
		{      
			"rel": "parent",
			"href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A19",
			"name": "incidents",
			"kind": "item"    
		}  
	] 
}

Back to Top