Create a set of hearing hierarchy
post
/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies
Request
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 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. -
Description: string
Title:
Description
Maximum Length:800
The description of the hearing hierarchy. -
EnabledFlag(required): 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(required): string
Title:
Hierarchy Code
Maximum Length:60
The unique identifier of the hearing hierarchy. -
Name(required): 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 : publicSectorHearingHierarchies-Bodies-item-post-request
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. -
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. -
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-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: