Jump to

• Request
• Response

Create a person test

post

/fscmRestApi/resources/11.13.18.05/personTests

Request

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.
• Upsert-Mode: string
  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

• PartyId(required): integer (int64)
  Title: Party ID

  The party identifier for a person.
• personScores: array Person Scores
  Title: Person Scores

  Person scores allows user to manage standardized test scores for a person.
• TestDate(required): string (date)
  Title: Test Date

  The date a test was taken.
• TestInstanceId(required): integer (int64)
  Title: Test Instance ID

  The unique instance identifier for a test.
• TestSourceTypeCode(required): string
  Title: Test Source Type Code

  Maximum Length: 30

  The test source type code for a test.

{
    "required":[
        "PartyId",
        "TestDate",
        "TestInstanceId",
        "TestSourceTypeCode"
    ],
    "type":"object",
    "properties":{
        "TestDate":{
            "title":"Test Date",
            "type":"string",
            "description":"The date a test was taken.",
            "format":"date",
            "nullable":false
        },
        "personScores":{
            "title":"Person Scores",
            "type":"array",
            "description":"Person scores allows user to manage standardized test scores for a person.",
            "items":{
                "$ref":"#/components/schemas/personTests-personScores-item-post-request"
            }
        },
        "TestInstanceId":{
            "title":"Test Instance ID",
            "type":"integer",
            "description":"The unique instance identifier for a test.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TestSourceTypeCode":{
            "title":"Test Source Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The test source type code for a test.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party identifier for a person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Person Scores

Type: array

Title: Person Scores

Person scores allows user to manage standardized test scores for a person.

Show Source

• Array of: object personTests-personScores-item-post-request

{
    "title":"Person Scores",
    "type":"array",
    "description":"Person scores allows user to manage standardized test scores for a person.",
    "items":{
        "$ref":"#/components/schemas/personTests-personScores-item-post-request"
    }
}

Nested Schema : personTests-personScores-item-post-request

Type: object

Show Source

• TestComponentId: integer (int64)
  Title: Test Component ID

  The unique identifier for a person test component.
• TestPercentile: number
  Title: Test Percentile

  The test percentile value.
• TestScore: number
  Title: Test Score

  The test score value.

{
    "type":"object",
    "properties":{
        "TestComponentId":{
            "title":"Test Component ID",
            "type":"integer",
            "description":"The unique identifier for a person test component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TestScore":{
            "title":"Test Score",
            "type":"number",
            "description":"The test score value.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            }
        },
        "TestPercentile":{
            "title":"Test Percentile",
            "type":"number",
            "description":"The test percentile value.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            }
        }
    }
}

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 : personTests-item-response

Type: object

Show Source

• LastModifiedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the person test.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the person test was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The party identifier for a person.
• PersonName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 360

  The name for a person.
• personScores: array Person Scores
  Title: Person Scores

  Person scores allows user to manage standardized test scores for a person.
• PersonTestId: integer (int64)
  Title: Person Test ID

  Read Only: true

  The unique identifier for a person test.
• TestDate: string (date)
  Title: Test Date

  The date a test was taken.
• TestInstanceCode: string
  Title: Test Instance Code

  Read Only: true

  Maximum Length: 32

  The code for a test instance.
• TestInstanceId: integer (int64)
  Title: Test Instance ID

  The unique instance identifier for a test.
• TestName: string
  Title: Test Name

  Read Only: true

  Maximum Length: 50

  The name of a test.
• TestProviderCode: string
  Title: Test Provider Code

  Read Only: true

  Maximum Length: 30

  The code for a test provider.
• TestProviderName: string
  Title: Test Provider Name

  Read Only: true

  Maximum Length: 100

  The name of the organization.
• TestSourceTypeCode: string
  Title: Test Source Type Code

  Maximum Length: 30

  The test source type code for a test.
• TestSourceTypeMeaning: string
  Title: Test Source Type Meaning

  Read Only: true

  Maximum Length: 80

  The test source type meaning for a test, such as Official or Self Reported.

{
    "type":"object",
    "properties":{
        "TestName":{
            "title":"Test Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a test.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastModifiedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the person test.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":360,
            "type":"string",
            "description":"The name for a person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestProviderCode":{
            "title":"Test Provider Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for a test provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personScores":{
            "title":"Person Scores",
            "type":"array",
            "description":"Person scores allows user to manage standardized test scores for a person.",
            "items":{
                "$ref":"#/components/schemas/personTests-personScores-item-response"
            }
        },
        "TestSourceTypeCode":{
            "title":"Test Source Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The test source type code for a test.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TestInstanceCode":{
            "title":"Test Instance Code",
            "maxLength":32,
            "type":"string",
            "description":"The code for a test instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestSourceTypeMeaning":{
            "title":"Test Source Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The test source type meaning for a test, such as Official or Self Reported.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party identifier for a person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TestDate":{
            "title":"Test Date",
            "type":"string",
            "description":"The date a test was taken.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TestInstanceId":{
            "title":"Test Instance ID",
            "type":"integer",
            "description":"The unique instance identifier for a test.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonTestId":{
            "title":"Person Test ID",
            "type":"integer",
            "description":"The unique identifier for a person test.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the person test was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Person Scores

Type: array

Title: Person Scores

Person scores allows user to manage standardized test scores for a person.

Show Source

• Array of: object personTests-personScores-item-response

{
    "title":"Person Scores",
    "type":"array",
    "description":"Person scores allows user to manage standardized test scores for a person.",
    "items":{
        "$ref":"#/components/schemas/personTests-personScores-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 : personTests-personScores-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonScoreId: integer (int64)
  Title: Person Score ID

  Read Only: true

  The unique identifier for a person test score.
• TestComponentDescription: string
  Title: Test Component Description

  Read Only: true

  Maximum Length: 240

  The description of a test component.
• TestComponentId: integer (int64)
  Title: Test Component ID

  The unique identifier for a person test component.
• TestComponentName: string
  Title: Test Component Name

  Read Only: true

  Maximum Length: 50

  The name of a test component.
• TestComponentScoreTypeCode: string
  Title: Test Component Score Type Code

  Read Only: true

  Maximum Length: 30

  The score type code for a test component.
• TestComponentScoreTypeMeaning: string
  Title: Test Component Score Type Meaning

  Read Only: true

  Maximum Length: 80

  The score type meaning for a test component, such as numeric or percentage.
• TestPercentile: number
  Title: Test Percentile

  The test percentile value.
• TestScore: number
  Title: Test Score

  The test score value.

{
    "type":"object",
    "properties":{
        "TestComponentDescription":{
            "title":"Test Component Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a test component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestComponentScoreTypeMeaning":{
            "title":"Test Component Score Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The score type meaning for a test component, such as numeric or percentage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonScoreId":{
            "title":"Person Score ID",
            "type":"integer",
            "description":"The unique identifier for a person test score.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TestComponentId":{
            "title":"Test Component ID",
            "type":"integer",
            "description":"The unique identifier for a person test component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TestScore":{
            "title":"Test Score",
            "type":"number",
            "description":"The test score value.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            },
            "x-queryable":true
        },
        "TestPercentile":{
            "title":"Test Percentile",
            "type":"number",
            "description":"The test percentile value.",
            "nullable":false,
            "x-hints":{
                "precision":9,
                "scale":2
            },
            "x-queryable":true
        },
        "TestComponentName":{
            "title":"Test Component Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a test component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestComponentScoreTypeCode":{
            "title":"Test Component Score Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The score type code for a test component.",
            "nullable":false,
            "readOnly":true,
            "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

TestInstanceIdLOV

Operation: /fscmRestApi/resources/11.13.18.05/testInstancesLOV

Parameters:

• finder: FindByTestDate%3BTestDate%3D{TestDate}%2CActive%3DY

The following properties are defined on the LOV link relation:

• Source Attribute: TestInstanceId; Target Attribute: TestInstanceId
• Display Attribute: Name

TestSourceTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TEST_RPT_SOURCE_TYPE%2CLookupCode%3D{TestSourceTypeCode}

The following properties are defined on the LOV link relation:

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

personScores

Operation: /fscmRestApi/resources/11.13.18.05/personTests/{PersonTestId}/child/personScores

Parameters:

• PersonTestId: $request.path.PersonTestId

Person scores allows user to manage standardized test scores for a person.

Back to Top