Jump to

• Request
• Response

Create a test component

post

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

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=

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "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"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the test component.",
            "nullable":false
        },
        "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"
                ]
            }
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"number",
            "description":"The maximum score possible for the test component.",
            "nullable":false,
            "x-hints":{
                "precision":"9",
                "scale":"2"
            }
        },
        "TestComponentCode":{
            "title":"Test Component Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a test component.",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the test component.",
            "nullable":false
        }
    }
}

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-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"
    }
}

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."
        }
    }
}

Links

ScoreTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{ScoreTypeCode}%2CLookupType%3DORA_HEY_TEST_SCORE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ScoreTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top