Jump to

• Request
• Response

Update a hearing hierarchy

patch

/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>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the hearing hierarchy is available to use.
• Name: string
  Title: Hierarchy Name

  Maximum Length: 200

  The name of the hearing hierarchy.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing hierarchy.",
            "nullable":true
        },
        "Bodies":{
            "title":"Hearing Hierarchy Bodies",
            "type":"array",
            "description":"The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingHierarchies-Bodies-item-patch-request"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy is available to use.",
            "nullable":false
        },
        "Name":{
            "title":"Hierarchy Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the hearing hierarchy.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Hearing Hierarchy Bodies",
    "type":"array",
    "description":"The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingHierarchies-Bodies-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ExpirationFlag":{
            "title":"Escalate after Expiration Period",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an expiration is applicable for the hearing body.",
            "nullable":false,
            "default":false
        },
        "AppealFlag":{
            "title":"Appeal Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an appeal is allowed for the hearing body.",
            "nullable":false
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence that the hearing bodies follow in the hearing hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy body is available to use.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorHearingHierarchies-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the hearing hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the hearing hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FirstHearingBodyCode":{
            "type":"string",
            "description":"The code for the first hearing body associated with the hearing hierarchy.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Bodies":{
            "title":"Hearing Hierarchy Bodies",
            "type":"array",
            "description":"The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingHierarchies-Bodies-item-response"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy is available to use.",
            "nullable":false,
            "x-queryable":true
        },
        "HearingHierarchyCode":{
            "title":"Hierarchy Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Hierarchy Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the hearing hierarchy.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorHearingHierarchies-Bodies-item-response

{
    "title":"Hearing Hierarchy Bodies",
    "type":"array",
    "description":"The hearing hierarchy body resource is used to view, create, or modify a hearing body in a hearing hierarchy.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingHierarchies-Bodies-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorHearingHierarchies-Bodies-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the hearing hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the hearing hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing body in a hearing hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence that the hearing bodies follow in the hearing hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "HearingHierarchyCode":{
            "title":"Hierarchy Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpirationFlag":{
            "title":"Escalate after Expiration Period",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an expiration is applicable for the hearing body.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AppealFlag":{
            "title":"Appeal Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an appeal is allowed for the hearing body.",
            "nullable":false,
            "x-queryable":true
        },
        "AppealPeriod":{
            "title":"Appeal Period in Days",
            "type":"integer",
            "description":"The period during which an appeal is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy body is available to use.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Bodies

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchies/{publicSectorHearingHierarchiesUniqID}/child/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.

Back to Top