Jump to

• Request
• Response

Get all working result set versions

get

/fscmRestApi/resources/11.13.18.05/workingResultSetVersions

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
  
  

  • ByKeywordFinder Finds the working result sets that match the specified keyword.
    Finder Variables
    • Keyword; string; The keyword for the working result set.
  • PrimaryKey Finds working result set versions that match the primary key criteria specified.
    Finder Variables
    • ResultSetVersionId; integer; The unique identifier of the working result set version.
  • PublishedVersionFinder Finds the published working result set versions.
    Finder Variables
    • InUseResultSetId; integer; The unique identifier of the working result set. If a value is provided, that working result set is returned even if it's no longer published.
• 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:
  

  • ResultSetCode; string; The code of a working result set.
  • ResultSetDescription; string; The description of the working result set version.
  • ResultSetId; integer; The unique identifier for a working result set.
  • ResultSetName; string; The name of the working result set version.
  • ResultSetStatusCode; string; The status of the working result set version. Examples of valid values are published, unpublished, or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
  • ResultSetStatusMeaning; string; The meaning of the working result set version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
  • ResultSetVersionId; integer; The unique identifier for a working result set version.
  • VersionNumber; integer; The version number of the working result set.
• 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: 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 : workingResultSetVersions

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/workingResultSetVersions-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workingResultSetVersions-item-response

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultSetCode: string
  Title: Result Set Code

  Read Only: true

  Maximum Length: 30

  The code of a working result set.
• ResultSetDescription: string
  Title: Version Description

  Read Only: true

  Maximum Length: 240

  The description of the working result set version.
• ResultSetId: integer
  Title: Result Set ID

  Read Only: true

  The unique identifier for a working result set.
• ResultSetName: string
  Title: Version Name

  Read Only: true

  Maximum Length: 50

  The name of the working result set version.
• ResultSetStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The status of the working result set version. Examples of valid values are published, unpublished, or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
• ResultSetStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The meaning of the working result set version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
• resultSetValues: array Result Set Values
  Title: Result Set Values

  The result set values resource provides a list of result values assigned to the result set version.
• ResultSetVersionId: integer (int64)
  Title: Result Set Version ID

  Read Only: true

  The unique identifier for a working result set version.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  The tag assignments resource provides a list of tags assigned to the result set version.
• VersionNumber: integer (int32)
  Title: Version Number

  Read Only: true

  The version number of the working result set.

{
    "type":"object",
    "properties":{
        "ResultSetCode":{
            "title":"Result Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a working result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the working result set version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a working result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the working result set version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the working result set version. Examples of valid values are published, unpublished, or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetStatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the working result set version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetVersionId":{
            "title":"Result Set Version ID",
            "type":"integer",
            "description":"The unique identifier for a working result set version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"The version number of the working result set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "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 Values",
            "type":"array",
            "description":"The result set values resource provides a list of result values assigned to the result set version.",
            "items":{
                "$ref":"#/components/schemas/workingResultSetVersions-resultSetValues-item-response"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"The tag assignments resource provides a list of tags assigned to the result set version.",
            "items":{
                "$ref":"#/components/schemas/workingResultSetVersions-tagAssignments-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 Set Values

Type: array

Title: Result Set Values

The result set values resource provides a list of result values assigned to the result set version.

Show Source

• Array of: object workingResultSetVersions-resultSetValues-item-response

{
    "title":"Result Set Values",
    "type":"array",
    "description":"The result set values resource provides a list of result values assigned to the result set version.",
    "items":{
        "$ref":"#/components/schemas/workingResultSetVersions-resultSetValues-item-response"
    }
}

Nested Schema : Tag Assignments

Type: array

Title: Tag Assignments

The tag assignments resource provides a list of tags assigned to the result set version.

Show Source

• Array of: object workingResultSetVersions-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"The tag assignments resource provides a list of tags assigned to the result set version.",
    "items":{
        "$ref":"#/components/schemas/workingResultSetVersions-tagAssignments-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 : workingResultSetVersions-resultSetValues-item-response

Type: object

Show Source

• Description: string
  Title: Result Value Description

  Read Only: true

  Maximum Length: 240

  The description of a result value.
• DisplayOrder: integer (int32)
  Title: Display Order

  Read Only: true

  The display sequence of the result value within the result set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumericFromValue: number
  Title: Numeric Range from Value

  Read Only: true

  The minimum score that can be earned, entered or calculated for a result.
• NumericPrecision: integer (int32)
  Title: Numeric Range Precision

  Read Only: true

  The precision allowed for scores in the result.
• NumericToValue: number
  Title: Numeric Range to Value

  Read Only: true

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

  Read Only: true

  The numeric value of a result.
• ResultSetValueId: integer (int64)
  Title: Result Set Value ID

  Read Only: true

  The unique identifier for a result set value.
• ResultValueCode: string
  Title: Result Value Code

  Read Only: true

  Maximum Length: 30

  The code of a result value.
• ResultValueId: integer (int64)
  Title: Result Value ID

  Read Only: true

  The unique identifier for a result value.
• ResultValueName: string
  Title: Result Value Name

  Read Only: true

  Maximum Length: 50

  The name of a result value, such as Pass or Fail.
• ResultValueType: string
  Title: Result Value Type Code

  Read Only: true

  Maximum Length: 30

  The type of a result value.
• ResultValueTypeMeaning: string
  Title: Result Value Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of a result value type.
• TextValue: string
  Title: Text Value

  Read Only: true

  Maximum Length: 50

  The text value of a result.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Result Value Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a result value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"The display sequence of the result value within the result set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumericFromValue":{
            "title":"Numeric Range from 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
        },
        "NumericPrecision":{
            "title":"Numeric Range Precision",
            "type":"integer",
            "description":"The precision allowed for scores in the result.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "NumericToValue":{
            "title":"Numeric Range to 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
        },
        "NumericValue":{
            "title":"Numeric Value",
            "type":"number",
            "description":"The numeric value of a result.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "ResultSetValueId":{
            "title":"Result Set Value ID",
            "type":"integer",
            "description":"The unique identifier for a result set value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultValueCode":{
            "title":"Result Value Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a result value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValueId":{
            "title":"Result Value ID",
            "type":"integer",
            "description":"The unique identifier for a result value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultValueName":{
            "title":"Result Value Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a result value, such as Pass or Fail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValueType":{
            "title":"Result Value Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of a result value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValueTypeMeaning":{
            "title":"Result Value Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of a result value type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TextValue":{
            "title":"Text Value",
            "maxLength":50,
            "type":"string",
            "description":"The text value of a result.",
            "nullable":true,
            "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 : workingResultSetVersions-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  The tag assignment identifier of the result set tag.
• TagCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The code of the result set tag.
• TagDescription: string
  Title: Tag Description

  Read Only: true

  Maximum Length: 240

  The description of the result set tag.
• TagId: integer (int64)
  Title: Tag ID

  Read Only: true

  The identifier of the result set tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the result set tag.

{
    "type":"object",
    "properties":{
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The tag assignment identifier of the result set tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the result set tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagDescription":{
            "title":"Tag Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the result set tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the result set tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the result set tag.",
            "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"
    }
}

Back to Top