Get a hearing hierarchy
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}
Request
Path Parameters
-
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
Bodies: array
Hearing Hierarchy Bodies
Title:
Hearing Hierarchy Bodies
The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy. -
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. -
Description: string
Title:
Description
Maximum Length:800
The description of the hearing hierarchy. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the hearing hierarchy is available to use. -
FirstHearingBodyCode: string
The code for the first hearing body associated with the 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. -
Name: string
Title:
Hierarchy Name
Maximum Length:200
The name of the hearing hierarchy.
Nested Schema : Hearing Hierarchy Bodies
Type:
array
Title:
Hearing Hierarchy Bodies
The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Links
- Bodies
-
Parameters:
- publicSectorHearingHierarchiesUniqID:
$request.path.publicSectorHearingHierarchiesUniqID
The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy. - publicSectorHearingHierarchiesUniqID: