Jump to

• Request
• Response

Get a result type set

get

/fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets/{resultTypeSetsUniqID}

Request

Path Parameters

• ResultTypeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• resultTypeSetsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Result Type Sets resource and used to uniquely identify an instance of Result Type Sets. The client should not generate the hash key value. Instead, the client should query on the Result Type Sets collection resource in order to navigate to a specific instance of Result Type Sets 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:
  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:
  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 : resultTypes-resultTypeSets-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row for the result type set.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row for the result type set was created.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier for an institution that's associated with the result type set.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of an institution that's associated with the result type set.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row for the result type set was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row for the result type set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultSetId: integer (int64)
  Read Only: true

  The unique identifier for result set that's associated with the result type set.
• ResultSetName: string
  Title: Result Set Name

  Read Only: true

  Maximum Length: 50

  The name of a result set that's associated with the result type set.
• resultSetValues: array Result Set Details
  Title: Result Set Details

  The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.
• ResultTypeSetId: integer (int64)
  Read Only: true

  The unique identifier for the result type set.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the result type set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row for the result type set was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row for the result type set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of an institution that's associated with the result type set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution that's associated with the result type set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultSetId":{
            "type":"integer",
            "description":"The unique identifier for result set that's associated with the result type set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a result set that's associated with the result type set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeSetId":{
            "type":"integer",
            "description":"The unique identifier for the result type set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "resultSetValues":{
            "title":"Result Set Details",
            "type":"array",
            "description":"The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.",
            "items":{
                "$ref":"#/components/schemas/resultTypes-resultTypeSets-resultSetValues-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row for the result type set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 : Result Set Details

Type: array

Title: Result Set Details

The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.

Show Source

• Array of: object resultTypes-resultTypeSets-resultSetValues-item-response

{
    "title":"Result Set Details",
    "type":"array",
    "description":"The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.",
    "items":{
        "$ref":"#/components/schemas/resultTypes-resultTypeSets-resultSetValues-item-response"
    }
}

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."
        }
    }
}

Nested Schema : resultTypes-resultTypeSets-resultSetValues-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row for the result set value.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row for the result set value was created.
• DefaultFlag: boolean
  Title: Default

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the default value is true or false for the result set value.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the result set value.
• FromNumericValue: number
  Title: From

  Read Only: true

  The start range of the numeric value associated with the result.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row for the result set value set was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row for the result set value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutcomeCode: string
  Title: Outcome Code

  Read Only: true

  Maximum Length: 30

  The outcome code associated with the result.
• OutcomeMeaning: string
  Title: Outcome

  Read Only: true

  Maximum Length: 80

  The outcome meaning associated with the result.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  Read Only: true

  The sequence number associated with the result.
• TextValue: string
  Title: Text Value

  Read Only: true

  Maximum Length: 30

  The text value associated with the result.
• ToNumericValue: number
  Title: To

  Read Only: true

  Default Value: 0

  The end range of the numeric value associated with the result.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the result set value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row for the result set value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OutcomeCode":{
            "title":"Outcome Code",
            "maxLength":30,
            "type":"string",
            "description":"The outcome code associated with the result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the result set value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row for the result set value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FromNumericValue":{
            "title":"From",
            "type":"number",
            "description":"The start range of the numeric value associated with the result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ToNumericValue":{
            "title":"To",
            "type":"number",
            "description":"The end range of the numeric value associated with the result.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18,
                "scale":9,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OutcomeMeaning":{
            "title":"Outcome",
            "maxLength":80,
            "type":"string",
            "description":"The outcome meaning associated with the result.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TextValue":{
            "title":"Text Value",
            "maxLength":30,
            "type":"string",
            "description":"The text value associated with the result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number associated with the result.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the default value is true or false for the result set value.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row for the result set value set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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"
    }
}

Links

resultSetValues

Operation: /fscmRestApi/resources/11.13.18.05/resultTypes/{ResultTypeId}/child/resultTypeSets/{resultTypeSetsUniqID}/child/resultSetValues

Parameters:

• ResultTypeId: $request.path.ResultTypeId
• resultTypeSetsUniqID: $request.path.resultTypeSetsUniqID

The result set values resource is a child of the result type sets resource and provides a complete list of result set values associated with a result type set for a specific institution.

Back to Top