Jump to

• Request
• Response

Get all validation group detail value sets

get

/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets

Request

Path Parameters

• publicSectorValidationGroupDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ValidationGroupId, ValidationOption and AgencyId ---for the Validation Group Details resource and used to uniquely identify an instance of Validation Group Details. The client should not generate the hash key value. Instead, the client should query on the Validation Group Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Group Details.
  
  For example: publicSectorValidationGroupDetails?q=ValidationGroupId=<value1>;ValidationOption=<value2>;AgencyId=<value3>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource 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 validation group detail value sets that match the specified primary keys .
    Finder Variables:
    • AgencyId; integer; The unique identifier for the agency.
    • ValidationDetType; string; The type of validation.
    • ValidationDetValue; string; The job cost type value or insurance type value.
    • ValidationGroupId; string; The unique identifier for a validation group.
    • ValidationOption; string; Indicates the type of validation, such as contractor license type or insurance.
    • ValidationValue; string; Indicates the contractor license criteria that must be validated.
• 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 agency identifier.
  • CurrencyCode; string; The currency used for the job cost.
  • EnabledFlag; string; Indicates whether the configuration row is enabled. Valid values are "Y" and "N".
  • ExpirationBasis; string; The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date, ORA_EXPIRATION_DATE for expiration date.
  • GracePeriod; integer; The number indicating the grace period duration.
  • GracePeriodUom; string; The grace period duration unit of measure. Valid values are ORA_DAYS for day, ORA_WEEKS for weeks , ORA_MONTHS for month, ORA_YEARS for years.
  • JobCostOne; number; The job cost or minimum value for a job cost range.
  • JobCostTwo; number; The maximum value for a job cost range.
  • ValidateExpFlag; string; Indicates whether the insurance expiration needs to be validated. Valid values are "Y" and "N".
  • ValidationDetType; string; The type of validation. It can be job cost or insurance.
  • ValidationDetValue; string; The job cost type value or insurance type value. Valid values are ORA_BETWEEN, ORA_NOT_BETWEEN, ORA_LESS_THAN, ORA_LESS_THAN_EQUAL_TO, ORA_MORE_THAN, ORA_MORE_THAN_EQUAL_TO, ORA_NOT_APPLICABLE, ORA_NO_LIMIT.
  • ValidationGroupId; string; A unique name that identifies a validation group.
  • ValidationOption; string; Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.
  • ValidationValue; string; Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.
• 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 : publicSectorValidationGroupDetails-ValidationGroupDetailValueSets

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/publicSectorValidationGroupDetails-ValidationGroupDetailValueSets-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorValidationGroupDetails-ValidationGroupDetailValueSets-item-response

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

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier.
• CurrencyCode: string
  Maximum Length: 3

  The currency used for the job cost.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the configuration row is enabled. Valid values are "Y" and "N".
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date, ORA_EXPIRATION_DATE for expiration date.
• GracePeriod: integer (int64)
  Title: Grace Period

  The number indicating the grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The grace period duration unit of measure. Valid values are ORA_DAYS for day, ORA_WEEKS for weeks , ORA_MONTHS for month, ORA_YEARS for years.
• JobCostOne: number
  Title: Job Cost One

  The job cost or minimum value for a job cost range.
• JobCostTwo: number
  Title: Job Cost Two

  The maximum value for a job cost range.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the insurance expiration needs to be validated. Valid values are "Y" and "N".
• ValidationDetType: string
  Maximum Length: 30

  The type of validation. It can be job cost or insurance.
• ValidationDetValue: string
  Maximum Length: 30

  The job cost type value or insurance type value. Valid values are ORA_BETWEEN, ORA_NOT_BETWEEN, ORA_LESS_THAN, ORA_LESS_THAN_EQUAL_TO, ORA_MORE_THAN, ORA_MORE_THAN_EQUAL_TO, ORA_NOT_APPLICABLE, ORA_NO_LIMIT.
• ValidationGroupId: string
  Maximum Length: 50

  A unique name that identifies a validation group.
• ValidationOption: string
  Maximum Length: 30

  Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.
• ValidationValue: string
  Maximum Length: 30

  Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "maxLength":"50",
            "type":"string",
            "description":"A unique name that identifies a validation group.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationDetType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of validation. It can be job cost or insurance.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ValidationValue":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date,\nORA_EXPIRATION_DATE for expiration date.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationDetValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The job cost type value or insurance type value. Valid values are ORA_BETWEEN,\nORA_NOT_BETWEEN,\nORA_LESS_THAN,\nORA_LESS_THAN_EQUAL_TO,\nORA_MORE_THAN,\nORA_MORE_THAN_EQUAL_TO,\nORA_NOT_APPLICABLE,\nORA_NO_LIMIT.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency used for the job cost.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCostTwo":{
            "title":"Job Cost Two",
            "type":"number",
            "description":"The maximum value for a job cost range.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCostOne":{
            "title":"Job Cost One",
            "type":"number",
            "description":"The job cost or minimum value for a job cost range.",
            "nullable":true,
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The grace period duration unit of measure. Valid values are ORA_DAYS  for day, ORA_WEEKS for weeks  , ORA_MONTHS for month, ORA_YEARS for years.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the insurance expiration needs to be validated. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ValidationOption":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The number indicating the grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the configuration row is enabled. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N",
            "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