Jump to

• Request
• Response

Get all hearing notifications

get

/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotificationsWithoutTransients

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Retrieves the hearing notification that matches the specified hearing key, hearing sequence, and hearing event.
    Finder Variables:
    • HearingEventKey; integer; The unique identifier for the hearing event.
    • HearingKey; integer; The unique identifier for the hearing.
    • HearingSeqKey; integer; The unique identifier for the hearing sequence.
    • LnpRecordKey; integer; The unique identifier for the planning and zoning application.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first address line for the applicant.
  • Address2; string; The second address line for the applicant.
  • Address3; string; The third address line for the applicant.
  • Address4; string; The fourth address line for the applicant.
  • AgencyId; integer; The unique identifier for the agency.
  • AgencyPreferredTime; string; Indicates the agency???s preferred time format for displaying hearing-related date and time values.
  • AppealAllowedFlag; string; Indicates whether an appeal is currently permitted for the hearing sequence based on business rules.
  • AppealPeriod; integer; Specifies the time period within which an appeal can be submitted.
  • CityName; string; The city in the applicant???s address.
  • Classification; string; The record classification, such as permit, business license, professional license, or planning and zoning.
  • CountryCode; string; The country code in the applicant???s address.
  • CountyCodeIncits; string; The county code in the applicant???s address.
  • EmailAddress1; string; The applicant???s email address.
  • EmailAddress2; string; The applicant???s alternate email address.
  • EventDecisionDatetime; string; Indicates the date and time when the hearing decision was issued.
  • HearingAppealKey; integer; Unique identifier for the hearing appeal.
  • HearingAppealStatus; string; Indicates the current status of the hearing appeal.
  • HearingBodyDescription; string; The description of the hearing body for the record.
  • HearingBodyName; string; The name of the hearing body for the record.
  • HearingDecisionDescription; string; The description of the hearing decision for the record.
  • HearingDecisionName; string; The name of the hearing decision for the record.
  • HearingEventKey; integer; The unique identifier for the hearing event record.
  • HearingKey; integer; The unique identifier for the hearing record.
  • HearingSeqKey; integer; Unique sequence identifier for the hearing record.
  • HrgBodyCode; string; Code identifying the hearing body or authority.
  • HrgDecisionCode; string; Code representing the outcome of the hearing decision.
  • LnpRecordId; string; The unique identifier for the planning and zoning application.
  • LnpRecordKey; integer; The unique identifier for the planning and zoning application.
  • LookupCode; string; Code representing a lookup reference value.
  • LookupType; string; Indicates the type or category of lookup value.
  • PersonFirstName; string; The applicant???s first name.
  • PersonLastName; string; The applicant???s last name.
  • Province; string; The province in the applicant???s address.
  • RecordType; string; The application type for the planning and zoning application.
  • RecordTypeCode; string; The unique identifier for the application type.
  • RecordTypeId; string; Unique identifier for the record type.
  • ScheduleDatetime; string; The date and time the hearing is scheduled.
  • ScheduleStatus; string; The status of the hearing schedule.
  • StateCodeIso; string; ISO-standard code representing the state or region.
  • Subclassification; string; Indicates that the record type is used for the pre-application process.
  • SubmitDatetime; string; Indicates the date and time when the record was submitted.
  • ViewApplicationId; integer; Unique identifier for the associated application view.
  • WfProcessId; number; The unique identifier for the workflow process ID.
  • ZipCode; string; The ZIP code in the applicant???s address.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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 : publicSectorHearingNotificationsWithoutTransients

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingNotificationsWithoutTransients-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorHearingNotificationsWithoutTransients-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingNotificationsWithoutTransients-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 : publicSectorHearingNotificationsWithoutTransients-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first address line for the applicant.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second address line for the applicant.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third address line for the applicant.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth address line for the applicant.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier for the agency.
• AgencyPreferredTime: string
  Title: Time Format

  Read Only: true

  Maximum Length: 30

  Indicates the agency???s preferred time format for displaying hearing-related date and time values.
• AppealAllowedFlag: string
  Read Only: true

  Maximum Length: 9

  Indicates whether an appeal is currently permitted for the hearing sequence based on business rules.
• AppealPeriod: integer (int32)
  Title: Appeal Period in Days

  Read Only: true

  Specifies the time period within which an appeal can be submitted.
• CityName: string
  Read Only: true

  Maximum Length: 60

  The city in the applicant???s address.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The record classification, such as permit, business license, professional license, or planning and zoning.
• CountryCode: string
  Read Only: true

  Maximum Length: 3

  The country code in the applicant???s address.
• CountyCodeIncits: string
  Read Only: true

  Maximum Length: 60

  The county code in the applicant???s address.
• EmailAddress1: string
  Title: Applicant Email Address 1

  Read Only: true

  Maximum Length: 320

  The applicant???s email address.
• EmailAddress2: string
  Title: Applicant Email Address 2

  Read Only: true

  Maximum Length: 320

  The applicant???s alternate email address.
• EventDecisionDatetime: string (date-time)
  Read Only: true

  Indicates the date and time when the hearing decision was issued.
• HearingAppealKey: integer (int64)
  Read Only: true

  Unique identifier for the hearing appeal.
• HearingAppealStatus: string
  Read Only: true

  Maximum Length: 15

  Indicates the current status of the hearing appeal.
• HearingBodyDescription: string
  Read Only: true

  Maximum Length: 800

  The description of the hearing body for the record.
• HearingBodyName: string
  Title: Decision Making Body

  Read Only: true

  Maximum Length: 200

  The name of the hearing body for the record.
• HearingDecisionDescription: string
  Title: Hearing Decision Description

  Read Only: true

  Maximum Length: 800

  The description of the hearing decision for the record.
• HearingDecisionName: string
  Title: Decision

  Read Only: true

  Maximum Length: 60

  The name of the hearing decision for the record.
• HearingEventKey: integer (int64)
  Read Only: true

  The unique identifier for the hearing event record.
• HearingKey: integer (int64)
  Read Only: true

  The unique identifier for the hearing record.
• HearingSeqKey: integer (int64)
  Read Only: true

  Unique sequence identifier for the hearing record.
• HrgBodyCode: string
  Title: Hearing Body Code

  Read Only: true

  Maximum Length: 60

  Code identifying the hearing body or authority.
• HrgDecisionCode: string
  Title: Decision Code

  Read Only: true

  Maximum Length: 15

  Code representing the outcome of the hearing decision.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The unique identifier for the planning and zoning application.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the planning and zoning application.
• LookupCode: string
  Read Only: true

  Maximum Length: 30

  Code representing a lookup reference value.
• LookupType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type or category of lookup value.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant???s first name.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant???s last name.
• Province: string
  Read Only: true

  Maximum Length: 60

  The province in the applicant???s address.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The application type for the planning and zoning application.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The unique identifier for the application type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the record type.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  Read Only: true

  The date and time the hearing is scheduled.
• ScheduleStatus: string
  Title: Schedule Status

  Read Only: true

  Maximum Length: 80

  The status of the hearing schedule.
• StateCodeIso: string
  Read Only: true

  Maximum Length: 60

  ISO-standard code representing the state or region.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  Indicates that the record type is used for the pre-application process.
• SubmitDatetime: string (date-time)
  Read Only: true

  Indicates the date and time when the record was submitted.
• ViewApplicationId: integer (int64)
  Read Only: true

  Unique identifier for the associated application view.
• WfProcessId: number
  Read Only: true

  The unique identifier for the workflow process ID.
• ZipCode: string
  Read Only: true

  Maximum Length: 60

  The ZIP code in the applicant???s address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AgencyPreferredTime":{
            "title":"Time Format",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the agency???s preferred time format for displaying hearing-related date and time values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealAllowedFlag":{
            "maxLength":9,
            "type":"string",
            "description":"Indicates whether an appeal is currently permitted for the hearing sequence based on business rules.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealPeriod":{
            "title":"Appeal Period in Days",
            "type":"integer",
            "description":"Specifies the time period within which an appeal can be submitted.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CityName":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification, such as permit, business license, professional license, or planning and zoning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"The country code in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "maxLength":60,
            "type":"string",
            "description":"The county code in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email Address 1",
            "maxLength":320,
            "type":"string",
            "description":"The applicant???s email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Applicant Email Address 2",
            "maxLength":320,
            "type":"string",
            "description":"The applicant???s alternate email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDecisionDatetime":{
            "type":"string",
            "description":"Indicates the date and time when the hearing decision was issued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingAppealKey":{
            "type":"integer",
            "description":"Unique identifier for the hearing appeal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingAppealStatus":{
            "maxLength":15,
            "type":"string",
            "description":"Indicates the current status of the hearing appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingBodyDescription":{
            "maxLength":800,
            "type":"string",
            "description":"The description of the hearing body for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingBodyName":{
            "title":"Decision Making Body",
            "maxLength":200,
            "type":"string",
            "description":"The name of the hearing body for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionDescription":{
            "title":"Hearing Decision Description",
            "maxLength":800,
            "type":"string",
            "description":"The description of the hearing decision for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionName":{
            "title":"Decision",
            "maxLength":60,
            "type":"string",
            "description":"The name of the hearing decision for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingEventKey":{
            "type":"integer",
            "description":"The unique identifier for the hearing event record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingKey":{
            "type":"integer",
            "description":"The unique identifier for the hearing record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HearingSeqKey":{
            "type":"integer",
            "description":"Unique sequence identifier for the hearing record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HrgBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":60,
            "type":"string",
            "description":"Code identifying the hearing body or authority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HrgDecisionCode":{
            "title":"Decision Code",
            "maxLength":15,
            "type":"string",
            "description":"Code representing the outcome of the hearing decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the planning and zoning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the planning and zoning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing a lookup reference value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type or category of lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The application type for the planning and zoning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time the hearing is scheduled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the hearing schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCodeIso":{
            "maxLength":60,
            "type":"string",
            "description":"ISO-standard code representing the state or region.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates that the record type is used for the pre-application process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDatetime":{
            "type":"string",
            "description":"Indicates the date and time when the record was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"Unique identifier for the associated application view.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WfProcessId":{
            "type":"number",
            "description":"The unique identifier for the workflow process ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ZipCode":{
            "maxLength":60,
            "type":"string",
            "description":"The ZIP code in the applicant???s address.",
            "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"
            }
        }
    }
}

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