Jump to

• Request
• Response

Update a hearing hierarchy body

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHearingHierarchyBodies/{publicSectorHearingHierarchyBodiesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorHearingHierarchyBodiesUniqID: integer
  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: publicSectorHearingHierarchyBodies?q=AgencyId=<value1>;HearingHierarchyCode=<value2>;HearingBodyCode=<value3>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorHearingHierarchyBodies-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• AppealFlag(optional): boolean
  Title: Appeal Allowed

  Indicates if an appeal is allowed for the hearing body.
• AppealPeriod(optional): integer(int32)
  Title: Appeal Period

  The period during which an appeal is allowed.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the hearing hierarchy.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the hearing hierarchy was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates if the hearing hierarchy body is available to use.
• ExpirationFlag(optional): boolean
  Title: Escalate after Expiration Period

  Indicates if an expiration is applicable for the hearing body.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• HearingHierarchyCode(optional): string
  Title: Hierarchy Code

  Maximum Length: 60

  The unique identifier of the hearing hierarchy.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the hearing hierarchy was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the hearing hierarchy.
• links(optional): array Items
  Title: Items

  Link Relations
• Sequence(optional): integer(int32)
  Title: Sequence

  The sequence that the hearing bodies follow in the hearing hierarchy.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "AppealFlag":{
            "type":"boolean",
            "description":"Indicates if an appeal is allowed for the hearing body.",
            "title":"Appeal Allowed"
        },
        "AppealPeriod":{
            "format":"int32",
            "type":"integer",
            "description":"The period during which an appeal is allowed.",
            "title":"Appeal Period"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the hearing hierarchy.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy body is available to use.",
            "title":"Enabled"
        },
        "ExpirationFlag":{
            "type":"boolean",
            "description":"Indicates if an expiration is applicable for the hearing body.",
            "title":"Escalate after Expiration Period"
        },
        "HearingBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "title":"Hearing Body Code"
        },
        "HearingHierarchyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing hierarchy.",
            "title":"Hierarchy Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the hearing hierarchy.",
            "title":"Last Updated By"
        },
        "Sequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence that the hearing bodies follow in the hearing hierarchy.",
            "title":"Sequence"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorHearingHierarchyBodies-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• AppealFlag(optional): boolean
  Title: Appeal Allowed

  Indicates if an appeal is allowed for the hearing body.
• AppealPeriod(optional): integer(int32)
  Title: Appeal Period

  The period during which an appeal is allowed.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the hearing hierarchy.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the hearing hierarchy was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates if the hearing hierarchy body is available to use.
• ExpirationFlag(optional): boolean
  Title: Escalate after Expiration Period

  Indicates if an expiration is applicable for the hearing body.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• HearingHierarchyCode(optional): string
  Title: Hierarchy Code

  Maximum Length: 60

  The unique identifier of the hearing hierarchy.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the hearing hierarchy was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the hearing hierarchy.
• links(optional): array Items
  Title: Items

  Link Relations
• Sequence(optional): integer(int32)
  Title: Sequence

  The sequence that the hearing bodies follow in the hearing hierarchy.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "AppealFlag":{
            "type":"boolean",
            "description":"Indicates if an appeal is allowed for the hearing body.",
            "title":"Appeal Allowed"
        },
        "AppealPeriod":{
            "format":"int32",
            "type":"integer",
            "description":"The period during which an appeal is allowed.",
            "title":"Appeal Period"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the hearing hierarchy.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the hearing hierarchy body is available to use.",
            "title":"Enabled"
        },
        "ExpirationFlag":{
            "type":"boolean",
            "description":"Indicates if an expiration is applicable for the hearing body.",
            "title":"Escalate after Expiration Period"
        },
        "HearingBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "title":"Hearing Body Code"
        },
        "HearingHierarchyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the hearing hierarchy.",
            "title":"Hierarchy Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the hearing hierarchy was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the hearing hierarchy.",
            "title":"Last Updated By"
        },
        "Sequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence that the hearing bodies follow in the hearing hierarchy.",
            "title":"Sequence"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top