Jump to

• Request
• Response

Get all expiration rules from an expiration group

get

/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules

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: Finds the expiration rule that matches the specified primary key criteria.
    Finder Variables:
    • AgencyId; integer; The unique identifier of the public sector agency.
    • EffectiveEndDate; string; The end date for the expiration rule.
    • EffectiveStartDate; string; The start date for the expiration rule.
    • ExpirationBasis; string; The unique criteria derived from the record status to apply the expiration rule.
    • ExpirationGroupId; string; The unique identifier of the expiration rule group.
• 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:
  

  • AgencyId; integer; The unique identifier of the public sector agency.
  • AteDurUom; string; The unit of measure for the About to Expire duration.
  • AteDuration; integer; The value that indicates the About to Expire duration.
  • CommAteFlag; string; Indicates that the communication is enabled for About to Expire status.
  • CommAteFreqDuration; integer; Indicates the communication recurrences duration for the About to Expire status.
  • CommAteFrequency; string; Indicates the number of communication recurrences for the About to Expire status.
  • CommAteMaxFreq; integer; Indicates the number of maximum communication recurrences for About to Expire status.
  • CommDelinqFlag; string; Indicates that the communication is enabled for Delinquent status.
  • CommDelinqFreqDuration; integer; Indicates the communication recurrences duration for the Delinquent status.
  • CommDelinqFrequency; string; Indicates the number of communication recurrences for the Delinquent status.
  • CommDelinqMaxFreq; integer; Indicates the number of maximum communication recurrences for Delinquent status.
  • CommExpireFlag; string; Indicates that the communication is enabled for Expired status.
  • CommExpireFreqDuration; integer; Indicates the communication recurrences duration for Expired status.
  • CommExpireFrequency; string; Indicates the number of communication recurrences for Expired status.
  • CommExpireMaxFreq; integer; Indicates the maximum number of communication recurrences for Expired status.
  • EffectiveEndDate; string; The end date for the expiration rule.
  • EffectiveStartDate; string; The start date for the expiration rule.
  • EnabledFlag; boolean; Indicates that the expiration rule is available for use. The default value is true.
  • ExpIntervalDuration; integer; Indicates the expiration interval duration for the business license expiration rule.
  • ExpIntervalDurationUom; string; The unit of measure for expiration interval duration.
  • ExpRecalcReissueFlag; string; Indicates whether a permit should recalculate the expiration date based on the permit reissue date.
  • ExpirationBasis; string; The unique criteria derived from the record status to apply the expiration rule.
  • ExpirationDurUom; string; The unit of measure for the expiration duration.
  • ExpirationDuration; integer; The value of the expiration duration.
  • ExpirationGroupId; string; The unique identifier of the expiration rule group.
  • GracePeriod; integer; The value of the grace period.
  • GracePeriodUom; string; The unit of measure for the grace period.
  • InsAutoExtendFlag; string; Indicates that the auto extend is enabled.
  • InsCommAutoExpireFlag; string; Indicates that the auto expire option based on the inspection commencement is enabled.
  • InsCommencementDateOption; string; Indicate the date options for the inspection commencement.
  • InsCommencementDuration; integer; Indicates the inspection commencement duration for the Permit Expire basis.
  • InsCommencementDurationUom; string; The unit of measure for the inspection commencement duration.
  • InsDurationExtend; integer; The auto extend duration value.
  • InsDurationExtendUom; string; The unit of measure for auto extend duration.
  • InsResultOption; string; The inspection result for which expiration rule is mapped.
  • NumExtensions; integer; The number of extensions allowed for the expiration rule.
  • RuleSequence; integer; The sequence of the expiration rule.
• 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:
  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.

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

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorExpirationRules-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorExpirationRules-item-response

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the public sector agency.
• AteDuration: integer (int64)
  Title: About to Expire

  The value that indicates the About to Expire duration.
• AteDurUom: string
  Title: About to Expire Duration UOM

  Maximum Length: 5

  The unit of measure for the About to Expire duration.
• CommAteFlag: string
  Title: About to Expire

  Maximum Length: 1

  Default Value: N

  Indicates that the communication is enabled for About to Expire status.
• CommAteFreqDuration: integer (int64)
  Title: Every

  Indicates the communication recurrences duration for the About to Expire status.
• CommAteFrequency: string
  Title: Recurrence

  Maximum Length: 7

  Default Value: ORA_O

  Indicates the number of communication recurrences for the About to Expire status.
• CommAteMaxFreq: integer (int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for About to Expire status.
• CommDelinqFlag: string
  Title: Delinquent

  Maximum Length: 1

  Default Value: N

  Indicates that the communication is enabled for Delinquent status.
• CommDelinqFreqDuration: integer (int64)
  Title: Every

  Indicates the communication recurrences duration for the Delinquent status.
• CommDelinqFrequency: string
  Title: Recurrence

  Maximum Length: 5

  Default Value: ORA_O

  Indicates the number of communication recurrences for the Delinquent status.
• CommDelinqMaxFreq: integer (int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for Delinquent status.
• CommExpireFlag: string
  Title: Expired

  Maximum Length: 1

  Default Value: N

  Indicates that the communication is enabled for Expired status.
• CommExpireFreqDuration: integer (int64)
  Title: Every

  Indicates the communication recurrences duration for Expired status.
• CommExpireFrequency: string
  Title: Recurrence

  Maximum Length: 7

  Default Value: ORA_O

  Indicates the number of communication recurrences for Expired status.
• CommExpireMaxFreq: integer (int32)
  Title: Maximum Recurrences

  Indicates the maximum number of communication recurrences for Expired status.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The end date for the expiration rule.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The start date for the expiration rule.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the expiration rule is available for use. The default value is true.
• ExpIntervalDuration: integer (int32)
  Title: Expiration Interval

  Indicates the expiration interval duration for the business license expiration rule.
• ExpIntervalDurationUom: string
  Title: Expiration Interval Unit of Measure

  Maximum Length: 10

  The unit of measure for expiration interval duration.
• ExpirationBasis: string
  Maximum Length: 10

  The unique criteria derived from the record status to apply the expiration rule.
• ExpirationDuration: integer (int64)
  Title: Expiration Duration

  The value of the expiration duration.
• ExpirationDurUom: string
  Title: Expiration Duration UOM

  Maximum Length: 5

  The unit of measure for the expiration duration.
• ExpirationGroupId: string
  Title: Expiration Group ID

  Maximum Length: 50

  The unique identifier of the expiration rule group.
• ExpRecalcReissueFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether a permit should recalculate the expiration date based on the permit reissue date.
• GracePeriod: integer (int64)
  Title: Grace Period

  The value of the grace period.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 5

  The unit of measure for the grace period.
• InsAutoExtendFlag: string
  Title: Auto-Extend Permit Expiration

  Maximum Length: 1

  Default Value: N

  Indicates that the auto extend is enabled.
• InsCommAutoExpireFlag: string
  Title: Automatic Expiration

  Maximum Length: 1

  Default Value: N

  Indicates that the auto expire option based on the inspection commencement is enabled.
• InsCommencementDateOption: string
  Title: Date Option

  Maximum Length: 30

  Default Value: ORA_INS_SCHEDULE

  Indicate the date options for the inspection commencement.
• InsCommencementDuration: integer (int64)
  Title: Duration

  Indicates the inspection commencement duration for the Permit Expire basis.
• InsCommencementDurationUom: string
  Title: Unit of Measure

  Maximum Length: 5

  The unit of measure for the inspection commencement duration.
• InsDurationExtend: integer (int64)
  Title: Extension Duration

  The auto extend duration value.
• InsDurationExtendUom: string
  Title: Extend Inspection Duration UOM

  Maximum Length: 5

  Default Value: ORA_D

  The unit of measure for auto extend duration.
• InsResultOption: string
  Title: Result

  Maximum Length: 10

  Default Value: ORA_PASS

  The inspection result for which expiration rule is mapped.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumExtensions: integer (int32)
  Title: Number of Extensions

  The number of extensions allowed for the expiration rule.
• RuleSequence: integer (int64)
  Title: Expiration Basis

  The sequence of the expiration rule.

{
    "type":"object",
    "properties":{
        "ExpirationGroupId":{
            "title":"Expiration Group ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the expiration rule group.",
            "nullable":false,
            "x-queryable":true
        },
        "InsResultOption":{
            "title":"Result",
            "maxLength":"10",
            "type":"string",
            "description":"The inspection result for which expiration rule is mapped.",
            "nullable":true,
            "default":"ORA_PASS",
            "x-queryable":true
        },
        "CommExpireFreqDuration":{
            "title":"Every",
            "type":"integer",
            "description":"Indicates the communication recurrences duration for Expired status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "InsCommencementDuration":{
            "title":"Duration",
            "type":"integer",
            "description":"Indicates the inspection commencement duration for the Permit Expire basis.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ExpirationBasis":{
            "maxLength":"10",
            "type":"string",
            "description":"The unique criteria derived from the record status to apply the expiration rule.",
            "nullable":false,
            "x-queryable":true
        },
        "CommDelinqFlag":{
            "title":"Delinquent",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the communication is enabled for Delinquent status.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "AteDurUom":{
            "title":"About to Expire Duration UOM",
            "maxLength":"5",
            "type":"string",
            "description":"The unit of measure for the About to Expire duration.",
            "nullable":true,
            "x-queryable":true
        },
        "InsDurationExtend":{
            "title":"Extension Duration",
            "type":"integer",
            "description":"The auto extend duration value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "InsCommencementDurationUom":{
            "title":"Unit of Measure",
            "maxLength":"5",
            "type":"string",
            "description":"The unit of measure for the inspection commencement duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDurUom":{
            "title":"Expiration Duration UOM",
            "maxLength":"5",
            "type":"string",
            "description":"The unit of measure for the expiration duration.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleSequence":{
            "title":"Expiration Basis",
            "type":"integer",
            "description":"The sequence of the expiration rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "AteDuration":{
            "title":"About to Expire",
            "type":"integer",
            "description":"The value that indicates the About to Expire duration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "ExpIntervalDuration":{
            "title":"Expiration Interval",
            "type":"integer",
            "description":"Indicates the expiration interval duration for the business license expiration rule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ExpIntervalDurationUom":{
            "title":"Expiration Interval Unit of Measure",
            "maxLength":"10",
            "type":"string",
            "description":"The unit of measure for expiration interval duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDuration":{
            "title":"Expiration Duration",
            "type":"integer",
            "description":"The value of the expiration duration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":"5",
            "type":"string",
            "description":"The unit of measure for the grace period.",
            "nullable":true,
            "x-queryable":true
        },
        "CommExpireFrequency":{
            "title":"Recurrence",
            "maxLength":"7",
            "type":"string",
            "description":"Indicates the number of communication recurrences for Expired status.",
            "nullable":true,
            "default":"ORA_O",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the expiration rule is available for use. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "CommAteFlag":{
            "title":"About to Expire",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the communication is enabled for About to Expire status.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "CommExpireFlag":{
            "title":"Expired",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the communication is enabled for Expired status.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "InsCommencementDateOption":{
            "title":"Date Option",
            "maxLength":"30",
            "type":"string",
            "description":"Indicate the date options for the inspection commencement.",
            "nullable":true,
            "default":"ORA_INS_SCHEDULE",
            "x-queryable":true
        },
        "InsCommAutoExpireFlag":{
            "title":"Automatic Expiration",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the auto expire option based on the inspection commencement is enabled.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The end date for the expiration rule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CommDelinqFrequency":{
            "title":"Recurrence",
            "maxLength":"5",
            "type":"string",
            "description":"Indicates the number of communication recurrences for the Delinquent status.",
            "nullable":true,
            "default":"ORA_O",
            "x-queryable":true
        },
        "NumExtensions":{
            "title":"Number of Extensions",
            "type":"integer",
            "description":"The number of extensions allowed for the expiration rule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "CommAteFrequency":{
            "title":"Recurrence",
            "maxLength":"7",
            "type":"string",
            "description":"Indicates the number of communication recurrences for the About to Expire status.",
            "nullable":true,
            "default":"ORA_O",
            "x-queryable":true
        },
        "CommDelinqMaxFreq":{
            "title":"Maximum Recurrences",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for Delinquent status.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "CommAteFreqDuration":{
            "title":"Every",
            "type":"integer",
            "description":"Indicates the communication recurrences duration for the About to Expire status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CommExpireMaxFreq":{
            "title":"Maximum Recurrences",
            "type":"integer",
            "description":"Indicates the maximum number of communication recurrences for Expired status.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "CommDelinqFreqDuration":{
            "title":"Every",
            "type":"integer",
            "description":"Indicates the communication recurrences duration for the Delinquent status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CommAteMaxFreq":{
            "title":"Maximum Recurrences",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for About to Expire status.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ExpRecalcReissueFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a permit should recalculate the expiration date based on the permit reissue date.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The value of the grace period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The start date for the expiration rule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InsAutoExtendFlag":{
            "title":"Auto-Extend Permit Expiration",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the auto extend is enabled.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "InsDurationExtendUom":{
            "title":"Extend Inspection Duration UOM",
            "maxLength":"5",
            "type":"string",
            "description":"The unit of measure for auto extend duration.",
            "nullable":true,
            "default":"ORA_D",
            "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