Update a hearing hierarchy body
patch
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/Bodies/{BodiesUniqID}
Request
Path Parameters
-
BodiesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, HearingHierarchyCode and HearingBodyCode ---for the Hearing Hierarchy Bodies resource and used to uniquely identify an instance of Hearing Hierarchy Bodies. The client should not generate the hash key value. Instead, the client should query on the Hearing Hierarchy Bodies collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Hierarchy Bodies.
For example: Bodies?q=AgencyId=<value1>;HearingHierarchyCode=<value2>;HearingBodyCode=<value3> -
publicSectorHearingHierarchiesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and HearingHierarchyCode ---for the Hearing Hierarchies resource and used to uniquely identify an instance of Hearing Hierarchies. The client should not generate the hash key value. Instead, the client should query on the Hearing Hierarchies collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Hierarchies.
For example: publicSectorHearingHierarchies?q=AgencyId=<value1>;HearingHierarchyCode=<value2>
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
Root Schema : schema
Type:
Show Source
object
-
AppealFlag: boolean
Title:
Appeal Allowed
Maximum Length:1
Indicates if an appeal is allowed for the hearing body. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the hearing hierarchy body is available to use. -
ExpirationFlag: boolean
Title:
Escalate after Expiration Period
Maximum Length:1
Default Value:false
Indicates if an expiration is applicable for the hearing body. -
Sequence: integer
(int32)
Title:
Sequence
The sequence that the hearing bodies follow in the hearing hierarchy.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorHearingHierarchies-Bodies-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
AppealFlag: boolean
Title:
Appeal Allowed
Maximum Length:1
Indicates if an appeal is allowed for the hearing body. -
AppealPeriod: integer
Title:
Appeal Period in Days
Read Only:true
The period during which an appeal is allowed. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the hearing hierarchy. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the hearing hierarchy was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the hearing hierarchy body is available to use. -
ExpirationFlag: boolean
Title:
Escalate after Expiration Period
Maximum Length:1
Default Value:false
Indicates if an expiration is applicable for the hearing body. -
HearingBodyCode: string
Title:
Hearing Body Code
Maximum Length:60
The unique identifier of the hearing body in a hearing hierarchy. -
HearingHierarchyCode: string
Title:
Hierarchy Code
Maximum Length:60
The unique identifier of the hearing hierarchy. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the hearing hierarchy was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the hearing hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
(int32)
Title:
Sequence
The sequence that the hearing bodies follow in the hearing hierarchy.
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.