Jump to

• Request
• Response

Get all result types

get

/fscmRestApi/resources/11.13.18.05/resultTypes

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
  
  

  • ByResultTypeFinder Finds the active result types with the specified criteria.
    Finder Variables
    • InUseResultTypeId; integer; The unique identifier of a result type. If a value is passed, this row is fetched even if it's inactive.
    • ResultTypeCodes; string; The comma separated list of result types of the institution.
  • PrimaryKey Finds all result types that match the primary key criteria specified.
    Finder Variables
    • ResultTypeId; integer; Unique identifier for the result type.
• 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:
  

  • ActiveFlag; boolean; Indicates whether the result type is active or inactive.
  • CreatedBy; string; The user who created the row for the result type.
  • CreationDate; string; The date and time when the row for the result type was created.
  • LastUpdateDate; string; The date and time when the row for the result type was last updated.
  • LastUpdatedBy; string; The user who last updated the row for the result type.
  • ResultTypeCode; string; The unique code to identify the result type.
  • ResultTypeDescription; string; The description of the result type.
  • ResultTypeId; integer; The unique identifier for the result type.
  • ResultTypeName; string; The name of the result type.
  • StudentStatisticsFlag; boolean; Indicates whether the result type captures a student related statistical result.
• 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(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

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/resultTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object resultTypes-item-response

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether the result type is active or inactive.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row for the result type was created.
• curriculumTypes: array Result Type Curriculums
  Title: Result Type Curriculums

  The curriculum types resource is a child of the result types resource and provides a complete list of curriculum types associated with a result type for a specific institution.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row for the result type 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultTypeCode: string
  Title: Result Type Code

  Read Only: true

  Maximum Length: 30

  The unique code to identify the result type.
• ResultTypeDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the result type.
• ResultTypeId: integer (int64)
  Title: Result Type ID

  Read Only: true

  The unique identifier for the result type.
• ResultTypeName: string
  Title: Result Type Name

  Read Only: true

  Maximum Length: 50

  The name of the result type.
• resultTypeSets: array Result Type Sets
  Title: Result Type Sets

  The result type sets resource is a child of the result types resource and provides a complete list of result sets associated with a result type for a specific institution.
• StudentStatisticsFlag: boolean
  Title: Result Type Student Statistics

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the result type captures a student related statistical result.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the result type.",
            "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 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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the result type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "curriculumTypes":{
            "title":"Result Type Curriculums",
            "type":"array",
            "description":"The curriculum types resource is a child of the result types resource and provides a complete list of curriculum types associated with a result type for a specific institution.",
            "items":{
                "$ref":"#/components/schemas/resultTypes-curriculumTypes-item-response"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the result type is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code to identify the result type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the result type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "resultTypeSets":{
            "title":"Result Type Sets",
            "type":"array",
            "description":"The result type sets resource is a child of the result types resource and provides a complete list of result sets associated with a result type for a specific institution.",
            "items":{
                "$ref":"#/components/schemas/resultTypes-resultTypeSets-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentStatisticsFlag":{
            "title":"Result Type Student Statistics",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the result type captures a student related statistical result.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for the result type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row for the result type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Result Type Curriculums

Type: array

Title: Result Type Curriculums

The curriculum types resource is a child of the result types resource and provides a complete list of curriculum types associated with a result type for a specific institution.

Show Source

• Array of: object resultTypes-curriculumTypes-item-response

{
    "title":"Result Type Curriculums",
    "type":"array",
    "description":"The curriculum types resource is a child of the result types resource and provides a complete list of curriculum types associated with a result type for a specific institution.",
    "items":{
        "$ref":"#/components/schemas/resultTypes-curriculumTypes-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 : Result Type Sets

Type: array

Title: Result Type Sets

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

Show Source

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

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

Nested Schema : resultTypes-curriculumTypes-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 curriculum.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row for the result type curriculum was created.
• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 30

  The code for a curriculum type that's associated with the result type curriculum.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  Read Only: true

  The unique identifier for a curriculum type that's associated with the result type curriculum.
• CurriculumTypeName: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The name for a curriculum type that's associated with the result type curriculum.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row for the result type curriculum 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 curriculum.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultTypeCurriculumId: integer (int64)
  Title: Result Type Curriculum ID

  Read Only: true

  The unique identifier for the result type curriculum.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the result type curriculum.",
            "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 curriculum 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 curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum type that's associated with the result type curriculum.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The code for a curriculum type that's associated with the result type curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTypeName":{
            "title":"Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The name for a curriculum type that's associated with the result type curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResultTypeCurriculumId":{
            "title":"Result Type Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the result type curriculum.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row for the result type curriculum 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 : 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-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 : 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"
    }
}

Back to Top