Jump to

• Request
• Response

Get a test instance

get

/fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}

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=
• TestInstanceId(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 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 : standardizedTestSetups-testInstances-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Test instance start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TestProviderName":{
            "title":"Test Provider Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the test instance.",
            "nullable":true,
            "x-queryable":true
        },
        "TestProviderCode":{
            "title":"Test Provider Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the test provider.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TestProviderName"
                ]
            },
            "x-queryable":true
        },
        "SeedDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TestInstanceId":{
            "title":"Test Instance ID",
            "type":"integer",
            "description":"The unique identifier for a test instance.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TestInstanceCode":{
            "title":"Test Instance Code",
            "maxLength":32,
            "type":"string",
            "description":"The unique code for a test instance.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Test instance end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "testComponents":{
            "title":"Test Components",
            "type":"array",
            "description":"Test components allows user to manage the components associated to a standardized test setup.",
            "items":{
                "$ref":"#/components/schemas/standardizedTestSetups-testInstances-testComponents-item-response"
            }
        },
        "TestInstanceStatus":{
            "title":"Test Instance Status",
            "type":"integer",
            "description":"Indicates whether the associated instance is in the past, current, or future, according to the values as -1, 0, and 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Test Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the test instance.",
            "nullable":false,
            "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 : Test Components

Type: array

Title: Test Components

Test components allows user to manage the components associated to a standardized test setup.

Show Source

• Array of: object standardizedTestSetups-testInstances-testComponents-item-response

{
    "title":"Test Components",
    "type":"array",
    "description":"Test components allows user to manage the components associated to a standardized test setup.",
    "items":{
        "$ref":"#/components/schemas/standardizedTestSetups-testInstances-testComponents-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 : standardizedTestSetups-testInstances-testComponents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"number",
            "description":"The minimum score possible for the test component.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the test component.",
            "nullable":false,
            "x-queryable":true
        },
        "ScoreTypeCode":{
            "title":"Score Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The score type code for the test component.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScoreTypeMeaning"
                ]
            },
            "x-queryable":true
        },
        "SeedDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TestComponentId":{
            "title":"Test Component ID",
            "type":"integer",
            "description":"The unique identifier for a test component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScoreTypeMeaning":{
            "title":"Score Type",
            "maxLength":80,
            "type":"string",
            "description":"The score type meaning for the test component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"number",
            "description":"The maximum score possible for the test component.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            },
            "x-queryable":true
        },
        "TestComponentCode":{
            "title":"Test Component Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a test component.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the test component.",
            "nullable":false,
            "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

TestProviderCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizationsLOV

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

testComponents

Operation: /fscmRestApi/resources/11.13.18.05/standardizedTestSetups/{StandardizedTestSetupId}/child/testInstances/{TestInstanceId}/child/testComponents

Parameters:

• StandardizedTestSetupId: $request.path.StandardizedTestSetupId
• TestInstanceId: $request.path.TestInstanceId

Test components allows user to manage the components associated to a standardized test setup.

Back to Top