Jump to

• Request
• Response

Update a standardized test setup

patch

/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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled Flag

  Maximum Length: 1

  Indicates whether a standardized test is active or inactive.
• testInstances: array Test Instances
  Title: Test Instances

  Test instances allows user to manage the effective dated instances for a standardized test setup.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a standardized test is active or inactive.",
            "nullable":false
        },
        "testInstances":{
            "title":"Test Instances",
            "type":"array",
            "description":"Test instances allows user to manage the effective dated instances for a standardized test setup.",
            "items":{
                "$ref":"#/components/schemas/standardizedTestSetups-testInstances-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Test Instances",
    "type":"array",
    "description":"Test instances allows user to manage the effective dated instances for a standardized test setup.",
    "items":{
        "$ref":"#/components/schemas/standardizedTestSetups-testInstances-item-patch-request"
    }
}

Nested Schema : schema

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.
• Name: string
  Title: Test Name

  Maximum Length: 50

  Name of the test instance.
• 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.
• TestProviderCode: string
  Title: Test Provider Code

  Maximum Length: 30

  The code for the test provider.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the test instance.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Test instance end date.",
            "format":"date",
            "nullable":true
        },
        "Name":{
            "title":"Test Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the test instance.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Test instance start date.",
            "format":"date",
            "nullable":false
        },
        "TestProviderCode":{
            "title":"Test Provider Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the test provider.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TestProviderName"
                ]
            }
        },
        "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-patch-request"
            }
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  Indicates the action to perform when this attribute is provided by the client in an update request. If set to DELETE, the record is deleted. The only supported value is DELETE.
• 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":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the test component.",
            "nullable":false
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"number",
            "description":"The maximum score possible for the test component.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            }
        },
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"number",
            "description":"The minimum score possible for the test component.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the test component.",
            "nullable":false
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the action to perform when this attribute is provided by the client in an update request. If set to DELETE, the record is deleted. The only supported value is DELETE.",
            "nullable":true,
            "x-queryable":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"
                ]
            }
        },
        "TestComponentCode":{
            "title":"Test Component Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a 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-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a standardized test is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the standardized test setup was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
                ]
            }
        },
        "StandardizedTestSetupCode":{
            "title":"Standardized Test Setup Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a standardized test setup.",
            "nullable":false,
            "x-queryable":true
        },
        "StandardizedTestSetupId":{
            "title":"Standardized Test Setup ID",
            "type":"integer",
            "description":"The unique identifier for a standardized test setup.",
            "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"
            }
        },
        "testInstances":{
            "title":"Test Instances",
            "type":"array",
            "description":"Test instances allows user to manage the effective dated instances for a standardized test setup.",
            "items":{
                "$ref":"#/components/schemas/standardizedTestSetups-testInstances-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 : Test Instances

Type: array

Title: Test Instances

Test instances allows user to manage the effective dated instances for a standardized test setup.

Show Source

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

{
    "title":"Test Instances",
    "type":"array",
    "description":"Test instances allows user to manage the effective dated instances for a standardized test setup.",
    "items":{
        "$ref":"#/components/schemas/standardizedTestSetups-testInstances-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-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":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the test instance.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Test instance end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Test Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the test instance.",
            "nullable":false,
            "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"
                ]
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Test instance start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TestInstanceCode":{
            "title":"Test Instance Code",
            "maxLength":32,
            "type":"string",
            "description":"The unique code for a test instance.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "TestProviderName":{
            "title":"Test Provider Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the organization.",
            "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"
            }
        },
        "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"
            }
        }
    }
}

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 : 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  Indicates the action to perform when this attribute is provided by the client in an update request. If set to DELETE, the record is deleted. The only supported value is DELETE.
• 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":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the test component.",
            "nullable":false,
            "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
        },
        "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
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the test component.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the action to perform when this attribute is provided by the client in an update request. If set to DELETE, the record is deleted. The only supported value is DELETE.",
            "nullable":true,
            "x-queryable":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"
                ]
            },
            "x-queryable":true
        },
        "ScoreTypeMeaning":{
            "title":"Score Type",
            "maxLength":80,
            "type":"string",
            "description":"The score type meaning for the test component.",
            "nullable":false,
            "readOnly":true,
            "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"
                ]
            }
        },
        "TestComponentCode":{
            "title":"Test Component Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a test component.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
            }
        }
    }
}

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

testInstances

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

Parameters:

• StandardizedTestSetupId: $request.path.StandardizedTestSetupId

Test instances allows user to manage the effective dated instances for a standardized test setup.

Back to Top