Jump to

• Request
• Response

Get a case

get

/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}

Request

Path Parameters

• CaseKey: integer
  The unique identifier of the case.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : publicSectorListCases-item

Type: object

Show Source

• AccessCode(optional): string
  Title: Access Number

  Maximum Length: 5

  The access code to claim the case.
• AdministerCaseStatusAccess(optional): array Administer Case Status Permissions
  Title: Administer Case Status Permissions

  The administer case status access resource is used to determine whether the status of a case can be modified.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency of the case.
• AppealDueDate(optional): string(date)
  Title: Appeal By

  The appeal due date for the case.
• AssignedCodeOfficerEmail(optional): string
  Title: Code Officer Email

  Maximum Length: 240

  The email address of the code officer assigned to the case.
• AssignedCodeOfficerName(optional): string
  Title: Code Officer Name

  Maximum Length: 240

  The name of the code officer assigned to the case.
• AssignedCodeOfficerPhone(optional): string
  Title: Code Officer Phone Number

  Maximum Length: 60

  The phone number of the code officer assigned to the case.
• AssignedCodeTechnicianEmail(optional): string
  Title: Code Technician Email

  Maximum Length: 240

  The email address of the code technician assigned to the case.
• AssignedCodeTechnicianName(optional): string
  Title: Code Technician Name

  Maximum Length: 240

  The name of the code technician assigned to the case.
• AssignedCodeTechnicianPhone(optional): string
  Title: Code Technician Phone

  Maximum Length: 60

  The phone number of the code technician assigned to the case.
• AssignedId(optional): integer(int64)
  Title: Inspector Assigned

  The unique identifier of the code officer assigned to the case.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The identifier of the case.
• CaseKey(optional): integer(int64)
  Title: Case Key

  The unique identifier of the case.
• ChangeReason(optional): string
  Title: Reason

  Maximum Length: 1000

  The reason for change of the case status.
• ClosedBy(optional): string
  Title: Closed By

  Maximum Length: 64

  The name of the user who closed the case.
• ClosedDate(optional): string(date-time)
  Title: Closed On

  The date when the case was closed.
• ClosedReason(optional): string
  Title: Reason for Closing

  Maximum Length: 450

  The reason for closing the case.
• ComplianceDueDate(optional): string(date)
  Title: Compliance Date

  The compliance date of the case.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time when the row was created.
• CriticalFlag(optional): boolean
  Title: Critical

  The switch to indicate that the case is critical.
• DistrictId(optional): string
  Title: District ID

  Maximum Length: 30

  The unique identifier of the district of the location of the case.
• DistrictType(optional): string
  Title: District Type

  Maximum Length: 50

  The type of the district of the location of the case.
• FunctionalStatus(optional): string
  Maximum Length: 15

  The user defined case status name that maps to a delivered system status.
• IntakeKey(optional): integer(int64)
  Title: Intake Key

  The unique identifier of the intake.
• IntakeSource(optional): string
  Title: Intake Source

  Maximum Length: 30

  The source of the case intake.
• InternalPriority(optional): string
  Title: Internal Priority

  Maximum Length: 30

  The internal priority of the case.
• IssueDescription(optional): string
  Title: Issue Description

  Maximum Length: 1000

  The description of the issue.
• IssueSubtype(optional): string
  Title: Issue Subtype

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId(optional): string
  Title: Issue Subtype ID

  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType(optional): string
  Title: Issue Type

  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId(optional): string
  Title: Issue Type ID

  Maximum Length: 50

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

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

  Maximum Length: 64

  The name of the user who last updated the row.
• Latitude(optional): number
  Title: Latitude

  The latitude of the location of the case.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationDescription(optional): string
  Title: Location Description

  Maximum Length: 1000

  The description of the location.
• Longitude(optional): number
  Title: Longitude

  The longitude of the location of the case.
• MigratedDataFlag(optional): string
  Title: Migrated Case

  Maximum Length: 3

  The identifier for the migrated data.
• ObsoleteFlag(optional): boolean
  Title: Obsolete

  The switch to indicate that the case is obsolete.
• Priority(optional): string
  Title: Priority

  Maximum Length: 30

  The priority of the case.
• ProcessInconsistent(optional): string
  Maximum Length: 10

  The flag to indicate whether the workflow associated with the case is in an inconsistent state.
• ProcessInstanceId(optional): string
  Title: Workflow Process ID

  Maximum Length: 500

  The process instance identifier of the workflow associated with the case.
• ProcessInstStatus(optional): string
  Title: Workflow Process Status

  Maximum Length: 15

  The process instance status of the workflow that is associated with the case.
• PropertyAddress1(optional): string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the property address of the case.
• PropertyAddress2(optional): string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the property address of the case.
• PropertyAddress3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the property address of the case.
• PropertyAddress4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the property address of the case.
• PropertyAddressId(optional): integer(int64)
  Title: Property Address ID

  The unique identifier of the property address of the case.
• PropertyCity(optional): string
  Title: City

  Maximum Length: 60

  The city of the property address of the case.
• PropertyCoordinateX(optional): number
  Title: X Coordinate

  The x-coordinate of the property address of the case.
• PropertyCoordinateY(optional): number
  Title: Y Coordinate

  The y-coordinate of the property address of the case.
• PropertyCountry(optional): string
  Title: Country

  Maximum Length: 3

  The country of the property address of the case.
• PropertyCounty(optional): string
  Title: County

  Maximum Length: 60

  The county of the property address of the case.
• PropertyParcelId(optional): integer(int64)
  Title: Parcel ID

  The unique identifier of the property parcel of the case.
• PropertyPostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourcode(optional): string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince(optional): string
  Title: Province

  Maximum Length: 60

  The province of the property address of the case.
• PropertyState(optional): string
  Title: State

  Maximum Length: 60

  The state of the property address of the case.
• ReferralCode(optional): string
  Title: Referral Code

  Maximum Length: 100

  The unique identifier of the referral body of the case.
• ReportedById(optional): string
  Title: Reported By

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ResponsiblePartyEmail(optional): string
  Title: Responsible Party Email

  Maximum Length: 254

  The email address of the primary responsible party associated with the case.
• ResponsiblePartyName(optional): string
  Title: Responsible Party

  Maximum Length: 301

  The name of the primary responsible party associated with the case.
• ResponsiblePartyPhone(optional): string
  Title: Responsible Party Phone

  Maximum Length: 100

  The phone number of the primary responsible party associated with the case.
• ReviewerId(optional): integer(int64)
  Title: Technician Assigned

  The unique identifier of the code technician assigned to the case.
• SourceTrxId(optional): string
  Title: Source Transaction ID

  Maximum Length: 50

  The unique identifier of the source transaction that created the case.
• Status(optional): string
  Title: Status

  Maximum Length: 15

  The status of the case.
• StatusDescription(optional): string
  Title: Case Status

  Maximum Length: 30

  The description of the status of the case.
• SubmitDate(optional): string(date-time)
  Title: Submitted On

  The date when the case was submitted.
• TotalFeeDue(optional): number
  Title: Total Due

  The total fees due for the case.
• TotalFees(optional): number
  Title: Total Fees

  The total fees for the case.
• TotalPaid(optional): number
  Title: Total Paid

  The total paid fees for the case.
• TotalPayableFees(optional): number
  Title: Total Payable

  The total payable fees for the case.
• TotalPaymentInProcess(optional): number
  Title: Total Payments in Process

  The total fees for the case for which payment is in progress.
• UpdateAccess(optional): array Update Case Permissions
  Title: Update Case Permissions

  The update case access resource is used to determine whether a case can be modified.
• UpdateCaseStatusAccess(optional): array Case Status Change Permissions
  Title: Case Status Change Permissions

  The update case status access resource is used to determine whether the status of a case can be modified.

{
    "properties":{
        "AccessCode":{
            "maxLength":5,
            "type":"string",
            "description":"The access code to claim the case.",
            "title":"Access Number"
        },
        "AdministerCaseStatusAccess":{
            "items":{
                "$ref":"#/definitions/publicSectorListCases-AdministerCaseStatusAccess-item"
            },
            "type":"array",
            "description":"The administer case status access resource is used to determine whether the status of a case can be modified.",
            "title":"Administer Case Status Permissions"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "title":"Agency ID"
        },
        "AppealDueDate":{
            "format":"date",
            "type":"string",
            "description":"The appeal due date for the case.",
            "title":"Appeal By"
        },
        "AssignedCodeOfficerEmail":{
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code officer assigned to the case.",
            "title":"Code Officer Email"
        },
        "AssignedCodeOfficerName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the code officer assigned to the case.",
            "title":"Code Officer Name"
        },
        "AssignedCodeOfficerPhone":{
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code officer assigned to the case.",
            "title":"Code Officer Phone Number"
        },
        "AssignedCodeTechnicianEmail":{
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code technician assigned to the case.",
            "title":"Code Technician Email"
        },
        "AssignedCodeTechnicianName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the code technician assigned to the case.",
            "title":"Code Technician Name"
        },
        "AssignedCodeTechnicianPhone":{
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code technician assigned to the case.",
            "title":"Code Technician Phone"
        },
        "AssignedId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code officer assigned to the case.",
            "title":"Inspector Assigned"
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "title":"Case Key"
        },
        "ChangeReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason for change of the case status.",
            "title":"Reason"
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who closed the case.",
            "title":"Closed By"
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was closed.",
            "title":"Closed On"
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the case.",
            "title":"Reason for Closing"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case.",
            "title":"Compliance Date"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CriticalFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is critical.",
            "title":"Critical"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the district of the location of the case.",
            "title":"District ID"
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of the district of the location of the case.",
            "title":"District Type"
        },
        "FunctionalStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status."
        },
        "IntakeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the intake.",
            "title":"Intake Key"
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the case intake.",
            "title":"Intake Source"
        },
        "InternalPriority":{
            "maxLength":30,
            "type":"string",
            "description":"The internal priority of the case.",
            "title":"Internal Priority"
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the issue.",
            "title":"Issue Description"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "title":"Issue Subtype"
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "title":"Issue Subtype ID"
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "title":"Issue Type"
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "title":"Issue Type ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the location of the case.",
            "title":"Latitude"
        },
        "LocationDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the location.",
            "title":"Location Description"
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the location of the case.",
            "title":"Longitude"
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier for the migrated data.",
            "title":"Migrated Case"
        },
        "ObsoleteFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is obsolete.",
            "title":"Obsolete"
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The priority of the case.",
            "title":"Priority"
        },
        "ProcessInconsistent":{
            "maxLength":10,
            "type":"string",
            "description":"The flag to indicate whether the workflow associated with the case is in an inconsistent state."
        },
        "ProcessInstStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The process instance status of the workflow that is associated with the case.",
            "title":"Workflow Process Status"
        },
        "ProcessInstanceId":{
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier of the workflow associated with the case.",
            "title":"Workflow Process ID"
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address of the case.",
            "title":"Address Line 1"
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address of the case.",
            "title":"Address Line 2"
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address of the case.",
            "title":"Address Line 3"
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "title":"Address Line 4"
        },
        "PropertyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property address of the case.",
            "title":"Property Address ID"
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address of the case.",
            "title":"City"
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The x-coordinate of the property address of the case.",
            "title":"X Coordinate"
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y-coordinate of the property address of the case.",
            "title":"Y Coordinate"
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the property address of the case.",
            "title":"Country"
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address of the case.",
            "title":"County"
        },
        "PropertyParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property parcel of the case.",
            "title":"Parcel ID"
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address of the case.",
            "title":"Postal Code"
        },
        "PropertyPostalPlusFourcode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the property address of the case.",
            "title":"Postal Plus 4 Code"
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address of the case.",
            "title":"Province"
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address of the case.",
            "title":"State"
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the referral body of the case.",
            "title":"Referral Code"
        },
        "ReportedById":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the person who reported the case.",
            "title":"Reported By"
        },
        "ResponsiblePartyEmail":{
            "maxLength":254,
            "type":"string",
            "description":"The email address of the primary responsible party associated with the case.",
            "title":"Responsible Party Email"
        },
        "ResponsiblePartyName":{
            "maxLength":301,
            "type":"string",
            "description":"The name of the primary responsible party associated with the case.",
            "title":"Responsible Party"
        },
        "ResponsiblePartyPhone":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the primary responsible party associated with the case.",
            "title":"Responsible Party Phone"
        },
        "ReviewerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "title":"Technician Assigned"
        },
        "SourceTrxId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case.",
            "title":"Source Transaction ID"
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Status"
        },
        "StatusDescription":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the status of the case.",
            "title":"Case Status"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was submitted.",
            "title":"Submitted On"
        },
        "TotalFeeDue":{
            "type":"number",
            "description":"The total fees due for the case.",
            "title":"Total Due"
        },
        "TotalFees":{
            "type":"number",
            "description":"The total fees for the case.",
            "title":"Total Fees"
        },
        "TotalPaid":{
            "type":"number",
            "description":"The total paid fees for the case.",
            "title":"Total Paid"
        },
        "TotalPayableFees":{
            "type":"number",
            "description":"The total payable fees for the case.",
            "title":"Total Payable"
        },
        "TotalPaymentInProcess":{
            "type":"number",
            "description":"The total fees for the case for which payment is in progress.",
            "title":"Total Payments in Process"
        },
        "UpdateAccess":{
            "items":{
                "$ref":"#/definitions/publicSectorListCases-UpdateAccess-item"
            },
            "type":"array",
            "description":"The update case access resource is used to determine whether a case can be modified.",
            "title":"Update Case Permissions"
        },
        "UpdateCaseStatusAccess":{
            "items":{
                "$ref":"#/definitions/publicSectorListCases-UpdateCaseStatusAccess-item"
            },
            "type":"array",
            "description":"The update case status access resource is used to determine whether the status of a case can be modified.",
            "title":"Case Status Change Permissions"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Administer Case Status Permissions

Type: array

Title: Administer Case Status Permissions

The administer case status access resource is used to determine whether the status of a case can be modified.

Show Source

• Array of: object publicSectorListCases-AdministerCaseStatusAccess-item

{
    "items":{
        "$ref":"#/definitions/publicSectorListCases-AdministerCaseStatusAccess-item"
    },
    "type":"array",
    "description":"The administer case status access resource is used to determine whether the status of a case can be modified.",
    "title":"Administer Case Status Permissions"
}

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 : Update Case Permissions

Type: array

Title: Update Case Permissions

The update case access resource is used to determine whether a case can be modified.

Show Source

• Array of: object publicSectorListCases-UpdateAccess-item

{
    "items":{
        "$ref":"#/definitions/publicSectorListCases-UpdateAccess-item"
    },
    "type":"array",
    "description":"The update case access resource is used to determine whether a case can be modified.",
    "title":"Update Case Permissions"
}

Nested Schema : Case Status Change Permissions

Type: array

Title: Case Status Change Permissions

The update case status access resource is used to determine whether the status of a case can be modified.

Show Source

• Array of: object publicSectorListCases-UpdateCaseStatusAccess-item

{
    "items":{
        "$ref":"#/definitions/publicSectorListCases-UpdateCaseStatusAccess-item"
    },
    "type":"array",
    "description":"The update case status access resource is used to determine whether the status of a case can be modified.",
    "title":"Case Status Change Permissions"
}

Nested Schema : publicSectorListCases-AdministerCaseStatusAccess-item

Type: object

Show Source

• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "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"
}

Nested Schema : publicSectorListCases-UpdateAccess-item

Type: object

Show Source

• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "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 : publicSectorListCases-UpdateCaseStatusAccess-item

Type: object

Show Source

• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "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"
}

Back to Top