Create a comment
post
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment
Request
Path Parameters
-
IncidentKey(required): integer(int64)
The unique identifier for an incident. This number is created using autonumbering.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
CommentId: integer
(int64)
The unique identifier of the comment.
-
CommentKey: integer
(int64)
The comment key.
-
CommentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated comment record. -
CommentText: string
(byte)
Title:
Comments
The text of the comment in HTML format. -
IncidentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated parent incident record. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
TransactionKey: integer
(int64)
The transaction key for the transaction that the comment is associated with.
-
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
Indicates whether the comment is visible.
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.
Root Schema : publicSectorIncidents-IncidentComment-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
CommentId: integer
(int64)
The unique identifier of the comment.
-
CommentKey: integer
(int64)
The comment key.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The text of the comment in plain text format. This is used to preview the comment. -
CommentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated comment record. -
CommentText: string
(byte)
Title:
Comments
The text of the comment in HTML format. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the row was created. -
IncidentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated parent incident record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
TransactionKey: integer
(int64)
The transaction key for the transaction that the comment is associated with.
-
TransactionType: string
Read Only:
true
Maximum Length:10
Default Value:INC
The type of transaction that the comment is associated with. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
Indicates whether the comment is visible.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.