Jump to

• Request
• Response

Get a validation group detail value

get

/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues/{ValidationGroupDetailValuesUniqID}

Request

Path Parameters

• ValidationGroupDetailValuesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ValidationGroupId, ValidationOption, ValidationValue and AgencyId ---for the Validation Group Detail Values resource and used to uniquely identify an instance of Validation Group Detail Values. The client should not generate the hash key value. Instead, the client should query on the Validation Group Detail Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Group Detail Values.
  
  For example: ValidationGroupDetailValues?q=ValidationGroupId=<value1>;ValidationOption=<value2>;ValidationValue=<value3>;AgencyId=<value4>
• ValidationGroupDetailsUniqID(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: ValidationGroupDetails?q=ValidationGroupId=<value1>;ValidationOption=<value2>;AgencyId=<value3>
• publicSectorValidationGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ValidationGroupId and AgencyId ---for the Validation Groups resource and used to uniquely identify an instance of Validation Groups. The client should not generate the hash key value. Instead, the client should query on the Validation Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Groups.
  
  For example: publicSectorValidationGroups?q=ValidationGroupId=<value1>;AgencyId=<value2>

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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(required):
  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(required):
  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 : publicSectorValidationGroups-ValidationGroupDetails-ValidationGroupDetailValues-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency using the validation group.
• ApplyValidation: string
  Title: Apply Validation

  Maximum Length: 30

  Indicates whether the validation should be applied to all licenses or any license.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the validation criteria are enabled or not. The default value is Y for yes.
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the expiration rule.
• GracePeriod: integer (int64)
  Title: Grace Period

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

  Maximum Length: 30

  The unit of time of the grace period duration.
• 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 expiration must be validated. The default value is N for no.
• ValidationGroupId: string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for a validation group.
• ValidationOption: string
  Title: Option

  Maximum Length: 30

  Indicates the type of validation, such as contractor license type or insurance.
• ValidationValue: string
  Title: Validation Criteria

  Maximum Length: 30

  The contractor license criteria that must be validated.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a validation group.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyValidation":{
            "title":"Apply Validation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the validation should be applied to all licenses or any license.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationValue":{
            "title":"Validation Criteria",
            "maxLength":30,
            "type":"string",
            "description":"The contractor license criteria that must be validated.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency using the validation group.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The date that is the basis for the expiration rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration must be validated. The default value is N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time of the grace period duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationOption":{
            "title":"Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of validation, such as contractor license type or insurance.",
            "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 grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the validation criteria are enabled or not. The default value is Y for yes.",
            "nullable":false,
            "default":"Y",
            "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