Jump to

• Request
• Response

Get all generic rows.

get

/hcmRestApi/resources/11.13.18.05/payrollGenericLOV

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 generic rows based on the specified primary key criteria.
    Finder Variables
    • PayRestId; string; Unique identifier for retrieving generic rows on the specified primary key.
  • findByWord Finds all generic rows that match the search criteria.
    Finder Variables
    • AdditionalViewCriteria; string; Additional view criteria to view generic rows.
    • BindVarMap; string; Bind variable map used as additional parameter to view all generic rows.
    • DisplayAttributes; string; Specific attributes to view all generic rows.
    • FilterAttributes; string; Attributes for the generic search terms.
    • ParameterKeys; string; Specific parameter keys to view all generic rows, such as legislative ID.
    • ParameterValues; string; Specific values to view all generic rows, such as a balance name.
    • PayRestId; string; Unique identifier for retrieving generic rows.
    • PayRestName; string; Unique name for retrieving generic rows.
    • SearchTerms; string; Search term criteria to retrieve generic data.
    • SortBy; string; Option to sort all generic rows based on the SortBy; string; column.
    • StartsWithFlag; string; Indicates whether the generic search should start with the first character of filter attribute or not.
• 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:
  

  • Code; string; Unique identifying code for the value.
  • Meaning; string; Description for the value.
  • PayRestName; string; Name of the pay rest.
  • ResultKey1; string; Result Key 1.
  • ResultKey10; string; Result Key 10.
  • ResultKey11; string; Result Key 11.
  • ResultKey12; string; Result Key 12.
  • ResultKey13; string; Result Key 13.
  • ResultKey14; string; Result Key 14.
  • ResultKey15; string; Result Key 15.
  • ResultKey16; string; Result Key 16.
  • ResultKey17; string; Result Key 17.
  • ResultKey18; string; Result Key 18.
  • ResultKey19; string; Result Key 19.
  • ResultKey2; string; Result Key 2.
  • ResultKey20; string; Result Key 20.
  • ResultKey21; string; Result Key 21.
  • ResultKey22; string; Result Key 22.
  • ResultKey23; string; Result Key 23.
  • ResultKey24; string; Result Key 24.
  • ResultKey25; string; Result Key 25.
  • ResultKey26; string; Result Key 26.
  • ResultKey27; string; Result Key 27.
  • ResultKey28; string; Result Key 28.
  • ResultKey29; string; Result Key 29.
  • ResultKey3; string; Result Key 3.
  • ResultKey30; string; Result Key 30.
  • ResultKey31; string; Result Key 31.
  • ResultKey32; string; Result Key 32.
  • ResultKey33; string; Result Key 33.
  • ResultKey34; string; Result Key 34.
  • ResultKey35; string; Result Key 35.
  • ResultKey36; string; Result Key 36.
  • ResultKey37; string; Result Key 37.
  • ResultKey38; string; Result Key 38.
  • ResultKey39; string; Result Key 39.
  • ResultKey4; string; Result Key 4.
  • ResultKey40; string; Result Key 40.
  • ResultKey5; string; Result Key 5.
  • ResultKey6; string; Result Key 6.
  • ResultKey7; string; Result Key 7.
  • ResultKey8; string; Result Key 8.
  • ResultKey9; string; Result Key 9.
  • ResultValue1; string; Result Value 1.
  • ResultValue10; string; Result Value 10.
  • ResultValue11; string; Result Value 11.
  • ResultValue12; string; Result Value 12.
  • ResultValue13; string; Result Value 13.
  • ResultValue14; string; Result Value 14.
  • ResultValue15; string; Result Value 15.
  • ResultValue16; string; Result Value 16.
  • ResultValue17; string; Result Value 17.
  • ResultValue18; string; Result Value 18.
  • ResultValue19; string; Result Value 19.
  • ResultValue2; string; Result Value 2.
  • ResultValue20; string; Result Value 20.
  • ResultValue21; string; Result Value 21.
  • ResultValue22; string; Result Value 22.
  • ResultValue23; string; Result Value 23.
  • ResultValue24; string; Result Value 24.
  • ResultValue25; string; Result Value 25.
  • ResultValue26; string; Result Value 26.
  • ResultValue27; string; Result Value 27.
  • ResultValue28; string; Result Value 28.
  • ResultValue29; string; Result Value 29.
  • ResultValue3; string; Result Value 3.
  • ResultValue30; string; Result Value 30.
  • ResultValue31; string; Result Value 31.
  • ResultValue32; string; Result Value 32.
  • ResultValue33; string; Result Value 33.
  • ResultValue34; string; Result Value 34.
  • ResultValue35; string; Result Value 35.
  • ResultValue36; string; Result Value 36.
  • ResultValue37; string; Result Value 37.
  • ResultValue38; string; Result Value 38.
  • ResultValue39; string; Result Value 39.
  • ResultValue4; string; Result Value 4.
  • ResultValue40; string; Result Value 40.
  • ResultValue5; string; Result Value 5.
  • ResultValue6; string; Result Value 6.
  • ResultValue7; string; Result Value 7.
  • ResultValue8; string; Result Value 8.
  • ResultValue9; string; Result Value 9.
• 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 : payrollGenericLOV

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/payrollGenericLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payrollGenericLOV-item-response

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

Type: object

Show Source

• Code: string
  Read Only: true

  Unique identifying code for the value.
• links: array Links
  Title: Links

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

  Description for the value.
• PayRestId: string
  Read Only: true

  Unique identifier for the pay rest.
• PayRestName: string
  Read Only: true

  Name of the pay rest.
• ResultKey1: string
  Read Only: true

  Result Key 1.
• ResultKey10: string
  Read Only: true

  Result Key 10.
• ResultKey11: string
  Read Only: true

  Result Key 11.
• ResultKey12: string
  Read Only: true

  Result Key 12.
• ResultKey13: string
  Read Only: true

  Result Key 13.
• ResultKey14: string
  Read Only: true

  Result Key 14.
• ResultKey15: string
  Read Only: true

  Result Key 15.
• ResultKey16: string
  Read Only: true

  Result Key 16.
• ResultKey17: string
  Read Only: true

  Result Key 17.
• ResultKey18: string
  Read Only: true

  Result Key 18.
• ResultKey19: string
  Read Only: true

  Result Key 19.
• ResultKey2: string
  Read Only: true

  Result Key 2.
• ResultKey20: string
  Read Only: true

  Result Key 20.
• ResultKey21: string
  Read Only: true

  Result Key 21.
• ResultKey22: string
  Read Only: true

  Result Key 22.
• ResultKey23: string
  Read Only: true

  Result Key 23.
• ResultKey24: string
  Read Only: true

  Result Key 24.
• ResultKey25: string
  Read Only: true

  Result Key 25.
• ResultKey26: string
  Read Only: true

  Result Key 26.
• ResultKey27: string
  Read Only: true

  Result Key 27.
• ResultKey28: string
  Read Only: true

  Result Key 28.
• ResultKey29: string
  Read Only: true

  Result Key 29.
• ResultKey3: string
  Read Only: true

  Result Key 3.
• ResultKey30: string
  Read Only: true

  Result Key 30.
• ResultKey31: string
  Read Only: true

  Result Key 31.
• ResultKey32: string
  Read Only: true

  Result Key 32.
• ResultKey33: string
  Read Only: true

  Result Key 33.
• ResultKey34: string
  Read Only: true

  Result Key 34.
• ResultKey35: string
  Read Only: true

  Result Key 35.
• ResultKey36: string
  Read Only: true

  Result Key 36.
• ResultKey37: string
  Read Only: true

  Result Key 37.
• ResultKey38: string
  Read Only: true

  Result Key 38.
• ResultKey39: string
  Read Only: true

  Result Key 39.
• ResultKey4: string
  Read Only: true

  Result Key 4.
• ResultKey40: string
  Read Only: true

  Result Key 40.
• ResultKey5: string
  Read Only: true

  Result Key 5.
• ResultKey6: string
  Read Only: true

  Result Key 6.
• ResultKey7: string
  Read Only: true

  Result Key 7.
• ResultKey8: string
  Read Only: true

  Result Key 8.
• ResultKey9: string
  Read Only: true

  Result Key 9.
• ResultValue1: string
  Read Only: true

  Result Value 1.
• ResultValue10: string
  Read Only: true

  Result Value 10.
• ResultValue11: string
  Read Only: true

  Result Value 11.
• ResultValue12: string
  Read Only: true

  Result Value 12.
• ResultValue13: string
  Read Only: true

  Result Value 13.
• ResultValue14: string
  Read Only: true

  Result Value 14.
• ResultValue15: string
  Read Only: true

  Result Value 15.
• ResultValue16: string
  Read Only: true

  Result Value 16.
• ResultValue17: string
  Read Only: true

  Result Value 17.
• ResultValue18: string
  Read Only: true

  Result Value 18.
• ResultValue19: string
  Read Only: true

  Result Value 19.
• ResultValue2: string
  Read Only: true

  Result Value 2.
• ResultValue20: string
  Read Only: true

  Result Value 20.
• ResultValue21: string
  Read Only: true

  Result Value 21.
• ResultValue22: string
  Read Only: true

  Result Value 22.
• ResultValue23: string
  Read Only: true

  Result Value 23.
• ResultValue24: string
  Read Only: true

  Result Value 24.
• ResultValue25: string
  Read Only: true

  Result Value 25.
• ResultValue26: string
  Read Only: true

  Result Value 26.
• ResultValue27: string
  Read Only: true

  Result Value 27.
• ResultValue28: string
  Read Only: true

  Result Value 28.
• ResultValue29: string
  Read Only: true

  Result Value 29.
• ResultValue3: string
  Read Only: true

  Result Value 3.
• ResultValue30: string
  Read Only: true

  Result Value 30.
• ResultValue31: string
  Read Only: true

  Result Value 31.
• ResultValue32: string
  Read Only: true

  Result Value 32.
• ResultValue33: string
  Read Only: true

  Result Value 33.
• ResultValue34: string
  Read Only: true

  Result Value 34.
• ResultValue35: string
  Read Only: true

  Result Value 35.
• ResultValue36: string
  Read Only: true

  Result Value 36.
• ResultValue37: string
  Read Only: true

  Result Value 37.
• ResultValue38: string
  Read Only: true

  Result Value 38.
• ResultValue39: string
  Read Only: true

  Result Value 39.
• ResultValue4: string
  Read Only: true

  Result Value 4.
• ResultValue40: string
  Read Only: true

  Result Value 40.
• ResultValue5: string
  Read Only: true

  Result Value 5.
• ResultValue6: string
  Read Only: true

  Result Value 6.
• ResultValue7: string
  Read Only: true

  Result Value 7.
• ResultValue8: string
  Read Only: true

  Result Value 8.
• ResultValue9: string
  Read Only: true

  Result Value 9.

{
    "type":"object",
    "properties":{
        "ResultValue6":{
            "type":"string",
            "description":"Result Value 6.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey37":{
            "type":"string",
            "description":"Result Key 37.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue7":{
            "type":"string",
            "description":"Result Value 7.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey38":{
            "type":"string",
            "description":"Result Key 38.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue4":{
            "type":"string",
            "description":"Result Value 4.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey35":{
            "type":"string",
            "description":"Result Key 35.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue5":{
            "type":"string",
            "description":"Result Value 5.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey36":{
            "type":"string",
            "description":"Result Key 36.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey33":{
            "type":"string",
            "description":"Result Key 33.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey34":{
            "type":"string",
            "description":"Result Key 34.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue8":{
            "type":"string",
            "description":"Result Value 8.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey31":{
            "type":"string",
            "description":"Result Key 31.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue9":{
            "type":"string",
            "description":"Result Value 9.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey32":{
            "type":"string",
            "description":"Result Key 32.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayRestId":{
            "type":"string",
            "description":"Unique identifier for the pay rest.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResultKey39":{
            "type":"string",
            "description":"Result Key 39.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue16":{
            "type":"string",
            "description":"Result Value 16.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue15":{
            "type":"string",
            "description":"Result Value 15.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue18":{
            "type":"string",
            "description":"Result Value 18.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue17":{
            "type":"string",
            "description":"Result Value 17.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue19":{
            "type":"string",
            "description":"Result Value 19.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey40":{
            "type":"string",
            "description":"Result Key 40.",
            "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"
            }
        },
        "ResultValue10":{
            "type":"string",
            "description":"Result Value 10.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue12":{
            "type":"string",
            "description":"Result Value 12.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue11":{
            "type":"string",
            "description":"Result Value 11.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue14":{
            "type":"string",
            "description":"Result Value 14.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue13":{
            "type":"string",
            "description":"Result Value 13.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey9":{
            "type":"string",
            "description":"Result Key 9.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey8":{
            "type":"string",
            "description":"Result Key 8.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey7":{
            "type":"string",
            "description":"Result Key 7.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey6":{
            "type":"string",
            "description":"Result Key 6.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey5":{
            "type":"string",
            "description":"Result Key 5.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey4":{
            "type":"string",
            "description":"Result Key 4.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey3":{
            "type":"string",
            "description":"Result Key 3.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey2":{
            "type":"string",
            "description":"Result Key 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Code":{
            "type":"string",
            "description":"Unique identifying code for the value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue27":{
            "type":"string",
            "description":"Result Value 27.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue26":{
            "type":"string",
            "description":"Result Value 26.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue29":{
            "type":"string",
            "description":"Result Value 29.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue28":{
            "type":"string",
            "description":"Result Value 28.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey1":{
            "type":"string",
            "description":"Result Key 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue21":{
            "type":"string",
            "description":"Result Value 21.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue20":{
            "type":"string",
            "description":"Result Value 20.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue23":{
            "type":"string",
            "description":"Result Value 23.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue22":{
            "type":"string",
            "description":"Result Value 22.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue25":{
            "type":"string",
            "description":"Result Value 25.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue24":{
            "type":"string",
            "description":"Result Value 24.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey15":{
            "type":"string",
            "description":"Result Key 15.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey16":{
            "type":"string",
            "description":"Result Key 16.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey13":{
            "type":"string",
            "description":"Result Key 13.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey14":{
            "type":"string",
            "description":"Result Key 14.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey11":{
            "type":"string",
            "description":"Result Key 11.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey12":{
            "type":"string",
            "description":"Result Key 12.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey10":{
            "type":"string",
            "description":"Result Key 10.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey19":{
            "type":"string",
            "description":"Result Key 19.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey17":{
            "type":"string",
            "description":"Result Key 17.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey18":{
            "type":"string",
            "description":"Result Key 18.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue38":{
            "type":"string",
            "description":"Result Value 38.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue37":{
            "type":"string",
            "description":"Result Value 37.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue39":{
            "type":"string",
            "description":"Result Value 39.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue30":{
            "type":"string",
            "description":"Result Value 30.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue32":{
            "type":"string",
            "description":"Result Value 32.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue31":{
            "type":"string",
            "description":"Result Value 31.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue34":{
            "type":"string",
            "description":"Result Value 34.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue33":{
            "type":"string",
            "description":"Result Value 33.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue36":{
            "type":"string",
            "description":"Result Value 36.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue35":{
            "type":"string",
            "description":"Result Value 35.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey26":{
            "type":"string",
            "description":"Result Key 26.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey27":{
            "type":"string",
            "description":"Result Key 27.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey24":{
            "type":"string",
            "description":"Result Key 24.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey25":{
            "type":"string",
            "description":"Result Key 25.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey22":{
            "type":"string",
            "description":"Result Key 22.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey23":{
            "type":"string",
            "description":"Result Key 23.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey20":{
            "type":"string",
            "description":"Result Key 20.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey21":{
            "type":"string",
            "description":"Result Key 21.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey28":{
            "type":"string",
            "description":"Result Key 28.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey29":{
            "type":"string",
            "description":"Result Key 29.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayRestName":{
            "type":"string",
            "description":"Name of the pay rest.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultKey30":{
            "type":"string",
            "description":"Result Key 30.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue40":{
            "type":"string",
            "description":"Result Value 40.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue2":{
            "type":"string",
            "description":"Result Value 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue3":{
            "type":"string",
            "description":"Result Value 3.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "type":"string",
            "description":"Description for the value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue1":{
            "type":"string",
            "description":"Result Value 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top