Jump to

• Request
• Response

Create a set of hearing events

post

/fscmRestApi/resources/11.13.18.05/publicSectorHearingEvents

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments on the decision.
• HearingDecisionCode: string
  Title: Decision

  Maximum Length: 15

  The unique identifier of the hearing decision.
• HearingEventPuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing event record.
• HearingSequencePuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing sequence record.
• ParentEventKey: integer (int64)
  The unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.
• ParentEventPuid: string
  Maximum Length: 255

  The public unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.
• ParentHearingDecisionCode: string
  The hearing decision code of the parent hearing event.
• ParentHearingDecisionComments: string
  The hearing comments of the parent hearing event.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  The date and time when the hearing is scheduled.
• ScheduleOrder: integer (int32)
  Title: Sequence

  Default Value: 0

  The order of the hearings scheduled for a day.
• ScheduleStatus: string
  Title: Schedule Status

  Maximum Length: 15

  Default Value: ORA_UNSCHLD

  The status of the hearing schedule. For example Tentative, Final.
• StaffDecisionCode: string
  Maximum Length: 15

  The unique identifier of the staff decision.
• StaffDecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments of the staff decision.
• StaffDecisionDatetime: string (date-time)
  Title: Staff Recommendation Date

  The date and time when the staff decision was updated.

{
    "type":"object",
    "properties":{
        "HearingDecisionCode":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the hearing decision.",
            "nullable":true
        },
        "ParentEventKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ParentHearingDecisionCode":{
            "type":"string",
            "description":"The hearing decision code of the parent hearing event.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentHearingDecisionComments":{
            "type":"string",
            "description":"The hearing comments of the parent hearing event.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time when the hearing is scheduled.",
            "format":"date-time",
            "nullable":true
        },
        "HearingSequencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing sequence record.",
            "nullable":false,
            "default":"0"
        },
        "ScheduleOrder":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the hearings scheduled for a day.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            }
        },
        "StaffDecisionDatetime":{
            "title":"Staff Recommendation Date",
            "type":"string",
            "description":"The date and time when the staff decision was updated.",
            "format":"date-time",
            "nullable":true
        },
        "DecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments on the decision.",
            "nullable":true
        },
        "HearingEventPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing event record.",
            "nullable":false,
            "default":"0"
        },
        "ParentEventPuid":{
            "maxLength":255,
            "type":"string",
            "description":"The public unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.",
            "nullable":true,
            "x-queryable":false
        },
        "StaffDecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments of the staff decision.",
            "nullable":true
        },
        "StaffDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the staff decision.",
            "nullable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing schedule. For example Tentative, Final.",
            "nullable":false,
            "default":"ORA_UNSCHLD"
        }
    }
}

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 : publicSectorHearingEvents-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  Default Value: 1

  The unique identifier of the agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the hearing was created.
• DecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments on the decision.
• EventDecision: string
  Title: Decision

  Read Only: true

  Maximum Length: 15

  The hearing decision.
• EventDecisionDatetime: string (date-time)
  Read Only: true

  The date and time of the hearing decision.
• EventStatus: string
  Title: Decision Status

  Read Only: true

  Maximum Length: 15

  Default Value: ORA_NOTSTRTD

  The status of the hearing. For example Completed, Canceled.
• HearingDecisionCode: string
  Title: Decision

  Maximum Length: 15

  The unique identifier of the hearing decision.
• HearingEventKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing event.
• HearingEventPuid: string
  Maximum Length: 480

  Default Value: 0

  The public unique identifier of the hearing event record.
• HearingSequenceKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing sequence.
• HearingSequencePuid: string
  Maximum Length: 480

  Default Value: 0

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

  Read Only: true

  The date and time when the hearing was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentEventKey: integer (int64)
  The unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.
• ParentEventPuid: string
  Maximum Length: 255

  The public unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.
• ParentHearingDecisionCode: string
  The hearing decision code of the parent hearing event.
• ParentHearingDecisionComments: string
  The hearing comments of the parent hearing event.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  The date and time when the hearing is scheduled.
• ScheduleOrder: integer (int32)
  Title: Sequence

  Default Value: 0

  The order of the hearings scheduled for a day.
• ScheduleStatus: string
  Title: Schedule Status

  Maximum Length: 15

  Default Value: ORA_UNSCHLD

  The status of the hearing schedule. For example Tentative, Final.
• StaffDecisionCode: string
  Maximum Length: 15

  The unique identifier of the staff decision.
• StaffDecisionComments: string
  Title: Comments

  Maximum Length: 1000

  The comments of the staff decision.
• StaffDecisionDatetime: string (date-time)
  Title: Staff Recommendation Date

  The date and time when the staff decision was updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionCode":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier 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,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "HearingSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing sequence.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventDecision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The hearing decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEventKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentHearingDecisionCode":{
            "type":"string",
            "description":"The hearing decision code of the parent hearing event.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentHearingDecisionComments":{
            "type":"string",
            "description":"The hearing comments of the parent hearing event.",
            "nullable":true,
            "x-queryable":false
        },
        "EventStatus":{
            "title":"Decision Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing. For example Completed, Canceled.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_NOTSTRTD",
            "x-queryable":true
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time when the hearing is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HearingSequencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing sequence record.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "ScheduleOrder":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the hearings scheduled for a day.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "StaffDecisionDatetime":{
            "title":"Staff Recommendation Date",
            "type":"string",
            "description":"The date and time when the staff decision was updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments on the decision.",
            "nullable":true,
            "x-queryable":true
        },
        "HearingEventKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HearingEventPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the hearing event record.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "EventDecisionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing decision.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEventPuid":{
            "maxLength":255,
            "type":"string",
            "description":"The public unique identifier of the hearing that resulted in this hearing. For example a hearing in the past that was an appeal and resulted in an appeal hearing.",
            "nullable":true,
            "x-queryable":false
        },
        "StaffDecisionComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments of the staff decision.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StaffDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the staff decision.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing schedule. For example Tentative, Final.",
            "nullable":false,
            "default":"ORA_UNSCHLD",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing 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