Get an inspection comment
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}
Request
Path Parameters
-
publicSectorInspectionCommentsUniqID: integer
This is the hash key of the attributes which make up the composite key--- InspectionAgencyId and InspectionCommentKey ---for the Inspection Comments resource and used to uniquely identify an instance of Inspection Comments. The client should not generate the hash key value. Instead, the client should query on the Inspection Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Comments.
For example: publicSectorInspectionComments?q=InspectionAgencyId=<value1>;InspectionCommentKey=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspectionComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The identifier of an inspection checklist associated with the comment. -
ChecklistItemId(optional):
string
Title:
Checklist Item
Maximum Length:15
The identifier of an inspection checklist item associated with the comment. -
CommentId(optional):
integer(int64)
The unique identifier of a comment in the PSC_COM_COMMENT table.
-
CommentPreview(optional):
string
Title:
Comment Preview
The flag for the comments summary section to enable preview of comments. The value is Y or N. -
CommentText(optional):
string
Title:
Comments
The comments in HTML or plain text. -
CreatedByName(optional):
string
Title:
Created By
The name of the user who created the comments. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the comments were created. -
InspectionAgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
InspectionCommentId(optional):
integer(int64)
Title:
Comment
The unique identifier of a comment in the PSC_COM_COMMENT table. -
InspectionCommentKey(optional):
integer(int64)
Title:
Comment
The unique identifier of an inspection comment in the PSC_INS_COMMENT table. -
InspectionCommentType(optional):
string
Title:
Comment Type
Maximum Length:15
The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The identifier of an inspection associated with the comment. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the comments were last updated. -
LastUpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the comments. -
links(optional):
array Items
Title:
Items
Link Relations -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The flag for indicating that the comment will not be visible to public users. The value is Y or N.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.