Jump to

• Request
• Response

Get a result set

get

/fscmRestApi/resources/11.13.18.05/resultSetsLOV/{resultSetsLOVUniqID}

Request

Path Parameters

• resultSetsLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Result Sets List of Values resource and used to uniquely identify an instance of Result Sets List of Values. The client should not generate the hash key value. Instead, the client should query on the Result Sets List of Values collection resource in order to navigate to a specific instance of Result Sets List of Values to get the hash key.

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

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : resultSetsLOV-item-response

Type: object

Show Source

• Description: string
  Title: Result Set Description

  Read Only: true

  Maximum Length: 240

  The description of a result set.
• EnableGradePointValuesFlag: boolean
  Title: Enable grade point values

  Read Only: true

  Maximum Length: 1

  Indicates whether grade point grades are allowed.
• EnableNumericValuesFlag: boolean
  Title: Enable numeric values

  Read Only: true

  Maximum Length: 1

  Indicates whether numeric grades are allowed.
• EnableTextValuesFlag: boolean
  Title: Enable text values

  Read Only: true

  Maximum Length: 1

  Indicates whether text grades are allowed.
• GradePointsMaximumDecPlaces: integer (int32)
  Title: Maximum Decimals

  Read Only: true

  The maximum number of decimal digits allowed for the grade point portion of the result.
• GradePointsMaximumIntPlaces: integer (int32)
  Title: Maximum Integers

  Read Only: true

  The maximum size allowed for the grade point portion of the result.
• GradePointsMaximumValue: number
  Title: Maximum Grade Points

  Read Only: true

  The maximum grade point value that can be earned, entered or calculated for a result.
• GradePointsMinimumValue: number
  Title: Minimum Grade Points

  Read Only: true

  The minimum grade point value that can be earned, entered or calculated for a result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumericMaximumDecPlaces: integer (int32)
  Title: Maximum Decimals

  Read Only: true

  The maximum number of decimal digits allowed for scores in the result detail.
• NumericMaximumIntPlaces: integer (int32)
  Title: Numeric Maximum Integers

  Read Only: true

  The maximum size allowed for scores in the result detail.
• NumericMaximumValue: number
  Title: Maximum Numeric Value

  Read Only: true

  The maximum score value that can be earned, entered or calculated for a result.
• NumericMinimumValue: number
  Title: Minimum Numeric Value

  Read Only: true

  The minimum score that can be earned, entered or calculated for a result.
• ResultSetCode: string
  Title: Result Set Code

  Read Only: true

  Maximum Length: 30

  The code of a result set.
• ResultSetId: integer (int64)
  Title: Result Set ID

  Read Only: true

  The unique identifier for a result set.
• ResultSetName: string
  Title: Result Set Name

  Read Only: true

  Maximum Length: 50

  The name of a result set, such as Pass or Fail.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Result Set Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableGradePointValuesFlag":{
            "title":"Enable grade point values",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether grade point grades are allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableNumericValuesFlag":{
            "title":"Enable numeric values",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether numeric grades are allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableTextValuesFlag":{
            "title":"Enable text values",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether text grades are allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GradePointsMaximumDecPlaces":{
            "title":"Maximum Decimals",
            "type":"integer",
            "description":"The maximum number of decimal digits allowed for the grade point portion of the result.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "GradePointsMaximumIntPlaces":{
            "title":"Maximum Integers",
            "type":"integer",
            "description":"The maximum size allowed for the grade point portion of the result.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "GradePointsMaximumValue":{
            "title":"Maximum Grade Points",
            "type":"number",
            "description":"The maximum grade point value that can be earned, entered or calculated for a result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "GradePointsMinimumValue":{
            "title":"Minimum Grade Points",
            "type":"number",
            "description":"The minimum grade point value that can be earned, entered or calculated for a result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "NumericMaximumDecPlaces":{
            "title":"Maximum Decimals",
            "type":"integer",
            "description":"The maximum number of decimal digits allowed for scores in the result detail.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "NumericMaximumIntPlaces":{
            "title":"Numeric Maximum Integers",
            "type":"integer",
            "description":"The maximum size allowed for scores in the result detail.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "NumericMaximumValue":{
            "title":"Maximum Numeric Value",
            "type":"number",
            "description":"The maximum score value that can be earned, entered or calculated for a result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "NumericMinimumValue":{
            "title":"Minimum Numeric Value",
            "type":"number",
            "description":"The minimum score that can be earned, entered or calculated for a result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "ResultSetCode":{
            "title":"Result Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a result set, such as Pass or Fail.",
            "nullable":false,
            "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