Get a standardized test setup
get
/fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}
Request
Path Parameters
-
StandardizedTestSetupId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : standardizedTestSetups-item-response
Type:
Show Source
object
-
EnabledFlag: boolean
Title:
Enabled Flag
Maximum Length:1
Indicates whether a standardized test is active or inactive. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the standardized test setup was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
StandardizedTestSetupCode: string
Title:
Standardized Test Setup Code
Maximum Length:30
The unique code for a standardized test setup. -
StandardizedTestSetupId: integer
(int64)
Title:
Standardized Test Setup ID
Read Only:true
The unique identifier for a standardized test setup. -
testInstances: array
Test Instances
Title:
Test Instances
Test instances allows user to manage the effective dated instances for a standardized test setup.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Test Instances
Type:
array
Title:
Test Instances
Test instances allows user to manage the effective dated instances for a standardized test setup.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : standardizedTestSetups-testInstances-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
Description of the test instance. -
EndDate: string
(date)
Title:
End Date
Test instance end date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Test Name
Maximum Length:50
Name of the test instance. -
SeedDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
StartDate: string
(date)
Title:
Start Date
Test instance start date. -
testComponents: array
Test Components
Title:
Test Components
Test components allows user to manage the components associated to a standardized test setup. -
TestInstanceCode: string
Title:
Test Instance Code
Maximum Length:32
The unique code for a test instance. -
TestInstanceId: integer
(int64)
Title:
Test Instance ID
Read Only:true
The unique identifier for a test instance. -
TestInstanceStatus: integer
Title:
Test Instance Status
Read Only:true
Indicates whether the associated instance is in the past, current, or future, according to the values as -1, 0, and 1. -
TestProviderCode: string
Title:
Test Provider Code
Maximum Length:30
The code for the test provider. -
TestProviderName: string
Title:
Test Provider Name
Read Only:true
Maximum Length:100
The name of the organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Test Components
Type:
array
Title:
Test Components
Test components allows user to manage the components associated to a standardized test setup.
Show Source
Nested Schema : standardizedTestSetups-testInstances-testComponents-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description of the test component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumScore: number
Title:
Maximum Score
The maximum score possible for the test component. -
MinimumScore: number
Title:
Minimum Score
The minimum score possible for the test component. -
Name: string
Title:
Name
Maximum Length:50
The name of the test component. -
ScoreTypeCode: string
Title:
Score Type Code
Maximum Length:30
The score type code for the test component. -
ScoreTypeMeaning: string
Title:
Score Type
Read Only:true
Maximum Length:80
The score type meaning for the test component. -
SeedDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
TestComponentCode: string
Title:
Test Component Code
Maximum Length:30
The unique code for a test component. -
TestComponentId: integer
(int64)
Title:
Test Component ID
Read Only:true
The unique identifier for a test component.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- testInstances
-
Parameters:
- StandardizedTestSetupId:
$request.path.StandardizedTestSetupId
Test instances allows user to manage the effective dated instances for a standardized test setup. - StandardizedTestSetupId: