Create a test instance
post
/fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
Name(required): string
Title:
Test Name
Maximum Length:50
Name of the test instance. -
StartDate(required): 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(required): string
Title:
Test Instance Code
Maximum Length:32
The unique code for a test instance. -
TestProviderCode: string
Title:
Test Provider Code
Maximum Length:30
The code for the test provider.
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-post-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description of the test component. -
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. -
TestComponentCode: string
Title:
Test Component Code
Maximum Length:30
The unique code for a test component.
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.
Root 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 : 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-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
- TestProviderCodeLOV
-
Parameters:
- finder:
ByActiveOrganizationsFinder%3BOrganizationCode%3D{TestProviderCode}%2COrganizationTypeCode%3DORA_HEY_TEST_PROVIDER
The following properties are defined on the LOV link relation:- Source Attribute: TestProviderCode; Target Attribute: OrganizationCode
- Display Attribute: OrganizationName
- finder:
- testComponents
-
Parameters:
- StandardizedTestSetupId:
$request.path.StandardizedTestSetupId
- TestInstanceId:
$request.path.TestInstanceId
Test components allows user to manage the components associated to a standardized test setup. - StandardizedTestSetupId: