Jump to

• Request
• Response

Get all contractor licenses

get

/fscmRestApi/resources/11.13.18.05/publicSectorContractorLists

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 contractor license that matches the specified primary key .
    Finder Variables:
    • LicenseKey; integer; The contractor license key.
• 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 on the contractor license.
  • Address2; string; The second address line on the contractor license.
  • Address3; string; The third address line on the contractor license.
  • Address4; string; The fourth address line on the contractor license.
  • AgencyId; integer; The agency ID for the transaction.
  • City; string; The city of the address on the contractor license.
  • ComplaintDiscloureInd; string; Indicates whether a complaint has been disclosed against license.
  • ContractorLicenseNumber; string; The number portion of the contractor license.
  • Country; string; The country on the address of the contractor license.
  • County; string; The county on the address of the contractor license.
  • Dba; string; The name the contractor is doing business as.
  • EmailAddress; string; The email address on a contractor license.
  • EnabledFlag; string; Indicates whether the license is enabled for use in the application. The default value is Y.
  • ExpireDate; string; The expiration date of a contractor license.
  • InactiveDate; string; The date when a contractor license became inactive.
  • IntLastUpdateBy; string; The user who updated the third-party integration data.
  • IntLastUpdateDt; string; The date when the third-party integration data was last updated.
  • IntStatusLastUpdateBy; string; The user who updated the internal license status.
  • IntStatusLastUpdateDt; string; The date when the internal license status was last updated.
  • IntegrationSource; string; The third party that integrates with Oracle to verify contractor licenses.
  • InternalLicenseStatus; string; The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.
  • InternalStatusDescr; string; Description of the internal license status.
  • IssueDate; string; The date when the contractor license was originally issued or went into effect.
  • LicenseCategory; string; The type of issued contractor license. Valid values are ORA_INTERNAL, ORA_EXTERNAL.
  • LicenseEntity; string; The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.
  • LicenseKey; integer; The automatically generated number that uniquely identifies the contractor license.
  • LicenseLmfPre; string; The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.
  • LicenseNumber; string; The contractor license number issued by the government or the agency.
  • LicenseSetupCode; string; The code identifies which data sections are used for the contractor license.
  • LicenseType; string; The type of the issued contractor license.
  • LicenseTypeDescr; string; Descriptive statement about the license type.
  • Name; string; The name on the contractor license.
  • Owner; string; The owner name or names on the contractor license.
  • PhoneAreaCode; string; The phone area code on the contractor license.
  • PhoneCountryCode; string; The phone country code on the contractor license.
  • PhoneExtension; string; The phone extension on the contractor license.
  • PhoneNumber; string; The phone number on the contractor license.
  • PostalPlus4Code; string; The postal code on the address of the contractor license.
  • Province; string; The province on the address of the contractor license.
  • ReactivateDate; string; The date when a contractor license was reactivated after a period of inactivity.
  • ReissueDate; string; The date when a contractor license was reissued, for example, if the entity type has changed.
  • Severity; string; Indicates the severity of the most severe condition applied to the license.
  • SourceLastUpdateDt; string; The date when the license information was last updated by the third-party licensing body that validated the license information.
  • SourceStatus; string; The license status as provided by the third-party licensing body that validated the license information.
  • State; string; The state on the address of the contractor license.
  • SuspendDate; string; The date when a contractor license was suspended.
  • UsedInApplication; string; Indicates whether the license is referenced in any applications.
• 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 : publicSectorContractorLists

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/publicSectorContractorLists-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":"TradeLicenseManagement",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorContractorLists-item-response

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

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first address line on the contractor license.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second address line on the contractor license.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third address line on the contractor license.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth address line on the contractor license.
• AgencyId: integer (int32)
  Read Only: true

  The agency ID for the transaction.
• City: string
  Read Only: true

  Maximum Length: 60

  The city of the address on the contractor license.
• ComplaintDiscloureInd: string
  Read Only: true

  Maximum Length: 1

  Indicates whether a complaint has been disclosed against license.
• ContractorLicenseNumber: string
  Read Only: true

  Maximum Length: 50

  The number portion of the contractor license.
• Country: string
  Read Only: true

  Maximum Length: 60

  The country on the address of the contractor license.
• County: string
  Read Only: true

  Maximum Length: 60

  The county on the address of the contractor license.
• Dba: string
  Read Only: true

  Maximum Length: 360

  The name the contractor is doing business as.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address on a contractor license.
• EnabledFlag: string
  Read Only: true

  Maximum Length: 80

  Indicates whether the license is enabled for use in the application. The default value is Y.
• ExpireDate: string (date)
  Read Only: true

  The expiration date of a contractor license.
• InactiveDate: string (date)
  Read Only: true

  The date when a contractor license became inactive.
• IntegrationSource: string
  Read Only: true

  Maximum Length: 30

  The third party that integrates with Oracle to verify contractor licenses.
• InternalLicenseStatus: string
  Read Only: true

  Maximum Length: 30

  The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.
• InternalStatusDescr: string
  Read Only: true

  Maximum Length: 80

  Description of the internal license status.
• IntLastUpdateBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the third-party integration data.
• IntLastUpdateDt: string (date)
  Read Only: true

  The date when the third-party integration data was last updated.
• IntStatusLastUpdateBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the internal license status.
• IntStatusLastUpdateDt: string (date)
  Read Only: true

  The date when the internal license status was last updated.
• IssueDate: string (date)
  Read Only: true

  The date when the contractor license was originally issued or went into effect.
• LicenseCategory: string
  Read Only: true

  Maximum Length: 30

  The type of issued contractor license. Valid values are ORA_INTERNAL, ORA_EXTERNAL.
• LicenseEntity: string
  Read Only: true

  Maximum Length: 30

  The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.
• LicenseKey: integer
  Read Only: true

  The automatically generated number that uniquely identifies the contractor license.
• LicenseLmfPre: string
  Read Only: true

  Maximum Length: 10

  The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.
• LicenseNumber: string
  Read Only: true

  Maximum Length: 50

  The contractor license number issued by the government or the agency.
• LicenseSetupCode: string
  Read Only: true

  Maximum Length: 30

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Read Only: true

  Maximum Length: 30

  The type of the issued contractor license.
• LicenseTypeDescr: string
  Read Only: true

  Maximum Length: 100

  Descriptive statement about the license type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  Maximum Length: 360

  The name on the contractor license.
• Owner: string
  Read Only: true

  Maximum Length: 360

  The owner name or names on the contractor license.
• PhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The phone area code on the contractor license.
• PhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The phone country code on the contractor license.
• PhoneExtension: string
  Read Only: true

  Maximum Length: 20

  The phone extension on the contractor license.
• PhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The phone number on the contractor license.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 60

  The postal code on the address of the contractor license.
• Province: string
  Read Only: true

  Maximum Length: 60

  The province on the address of the contractor license.
• ReactivateDate: string (date)
  Read Only: true

  The date when a contractor license was reactivated after a period of inactivity.
• ReissueDate: string (date)
  Read Only: true

  The date when a contractor license was reissued, for example, if the entity type has changed.
• Severity: string
  Read Only: true

  Maximum Length: 80

  Indicates the severity of the most severe condition applied to the license.
• SourceLastUpdateDt: string (date)
  Read Only: true

  The date when the license information was last updated by the third-party licensing body that validated the license information.
• SourceStatus: string
  Read Only: true

  Maximum Length: 100

  The license status as provided by the third-party licensing body that validated the license information.
• State: string
  Read Only: true

  Maximum Length: 60

  The state on the address of the contractor license.
• SuspendDate: string (date)
  Read Only: true

  The date when a contractor license was suspended.
• UsedInApplication: string
  Read Only: true

  Maximum Length: 80

  Indicates whether the license is referenced in any applications.

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency ID for the transaction.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplaintDiscloureInd":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a complaint has been disclosed against license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractorLicenseNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number portion of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country on the address of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county on the address of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dba":{
            "maxLength":360,
            "type":"string",
            "description":"The name the contractor is doing business as.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address on a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether  the license is enabled for use in the application. The default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpireDate":{
            "type":"string",
            "description":"The expiration date of a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveDate":{
            "type":"string",
            "description":"The date when a contractor license became inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the third-party integration data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntLastUpdateDt":{
            "type":"string",
            "description":"The date when the third-party integration data was last updated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the internal license status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateDt":{
            "type":"string",
            "description":"The date when the internal license status was last updated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"The third party that integrates with Oracle to verify contractor licenses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalLicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalStatusDescr":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the internal license status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"The date when the contractor license was originally issued or went into effect.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The type of issued contractor license. Valid values are ORA_INTERNAL, ORA_EXTERNAL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseEntity":{
            "maxLength":30,
            "type":"string",
            "description":"The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The automatically generated number that uniquely identifies the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseLmfPre":{
            "maxLength":10,
            "type":"string",
            "description":"The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseTypeDescr":{
            "maxLength":100,
            "type":"string",
            "description":"Descriptive statement about the license type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":360,
            "type":"string",
            "description":"The owner name or names on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code on the address of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province on the address of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReactivateDate":{
            "type":"string",
            "description":"The date when a contractor license was reactivated after a period of inactivity.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReissueDate":{
            "type":"string",
            "description":"The date when a contractor license was reissued, for example, if the entity type has changed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Severity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the severity of the most severe condition applied to the license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLastUpdateDt":{
            "type":"string",
            "description":"The date when the license information was last updated by the third-party licensing body that validated the license information.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The license status as provided by the third-party licensing body that validated the license information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state on the address of the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"The date when a contractor license was suspended.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsedInApplication":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the license is referenced in any applications.",
            "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