Jump to

• Request
• Response

Update a hearing body day decision

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHearingDecisions/{publicSectorHearingDecisionsUniqID}

Request

Path Parameters

• publicSectorHearingDecisionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and HearingDecisionCode ---for the Hearing Decisions resource and used to uniquely identify an instance of Hearing Decisions. The client should not generate the hash key value. Instead, the client should query on the Hearing Decisions collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Decisions.
  
  For example: publicSectorHearingDecisions?q=AgencyId=<value1>;HearingDecisionCode=<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 ()

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

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  Default Value: ORA_PZ

  The classification of the hearing body .
• Description: string
  Title: Description

  Maximum Length: 800

  The description of the hearing decision.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the hearing decision is available to use.
• EventDecision: string
  Title: System Status

  Maximum Length: 15

  The system defined decisions. For example Approved.
• HearingDecisionFlag: boolean
  Title: Hearing Decision

  Maximum Length: 1

  Default Value: true

  Indicates that the hearing decision is applicable to the public hearing decision.
• Name: string
  Title: Name

  Maximum Length: 60

  The name of the hearing decision. For example, Approved with Conditions.
• StaffDecisionFlag: boolean
  Title: Staff Recommendation

  Maximum Length: 1

  Default Value: false

  Indicates that the hearing decision is applicable to the staff decision.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":800,
            "type":"string",
            "description":"The description of the hearing decision.",
            "nullable":true
        },
        "EventDecision":{
            "title":"System Status",
            "maxLength":15,
            "type":"string",
            "description":"The system defined decisions. For example Approved.",
            "nullable":false
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification of the hearing body .",
            "nullable":false,
            "default":"ORA_PZ"
        },
        "StaffDecisionFlag":{
            "title":"Staff Recommendation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is applicable to the staff decision.",
            "nullable":true,
            "default":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is available to use.",
            "nullable":false
        },
        "HearingDecisionFlag":{
            "title":"Hearing Decision",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is applicable to the public hearing decision.",
            "nullable":true,
            "default":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the hearing decision. For example, Approved with Conditions.",
            "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(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.

Body ()

Root Schema : publicSectorHearingDecisions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency.
• Classification: string
  Maximum Length: 10

  Default Value: ORA_PZ

  The classification of the hearing body .
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the hearing decision setup was created.
• Description: string
  Title: Description

  Maximum Length: 800

  The description of the hearing decision.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the hearing decision is available to use.
• EventDecision: string
  Title: System Status

  Maximum Length: 15

  The system defined decisions. For example Approved.
• HearingDecisionCode: string
  Title: Code

  Maximum Length: 15

  The unique identifier of the hearing decision.
• HearingDecisionFlag: boolean
  Title: Hearing Decision

  Maximum Length: 1

  Default Value: true

  Indicates that the hearing decision is applicable to the public hearing decision.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the hearing decision setup 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 decision setup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 60

  The name of the hearing decision. For example, Approved with Conditions.
• StaffDecisionFlag: boolean
  Title: Staff Recommendation

  Maximum Length: 1

  Default Value: false

  Indicates that the hearing decision is applicable to the staff decision.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the hearing decision setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing decision setup 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 decision setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionCode":{
            "title":"Code",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the hearing decision.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":800,
            "type":"string",
            "description":"The description of the hearing decision.",
            "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
        },
        "EventDecision":{
            "title":"System Status",
            "maxLength":15,
            "type":"string",
            "description":"The system defined decisions. For example Approved.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the hearing decision. For example, Approved with Conditions.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification of the hearing body .",
            "nullable":false,
            "default":"ORA_PZ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StaffDecisionFlag":{
            "title":"Staff Recommendation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is applicable to the staff decision.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is available to use.",
            "nullable":false,
            "x-queryable":true
        },
        "HearingDecisionFlag":{
            "title":"Hearing Decision",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the hearing decision is applicable to the public hearing decision.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing decision setup 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."
        }
    }
}

Back to Top