Jump to

• Request
• Response

Apply result value to multiple sample results

post

/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/action/applyResultValue

Updates the result value to a list of samples of an inspection. Sample lists and characteristics in the sample will be updated with the result value and will be passed as input to the action. Returns an error if empty samples list is passed.

Request

Path Parameters

• IpEventId(required): integer
  Value that uniquely identifies the inspection event.

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• characteristicId: number
  Value that identifies the characteristic in sample that's updated with the result value.
• resultValue: string
  Result value to be updated. The data type of result value changes depending on characteristic type.
• samples: array samples
  Samples to which characteristics are added.

{
    "type":"object",
    "properties":{
        "resultValue":{
            "type":"string",
            "description":"Result value to be updated. The data type of result value changes depending on characteristic type.",
            "nullable":true
        },
        "characteristicId":{
            "type":"number",
            "description":"Value that identifies the characteristic in sample that's updated with the result value.",
            "nullable":true
        },
        "samples":{
            "type":"array",
            "description":"Samples to which characteristics are added.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : samples

Type: array

Samples to which characteristics are added.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Samples to which characteristics are added.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The action returns a status and error message indicating whether the result value is updated to characteristics of samples successfully. If the characteristic isn't available in samples, then the result value isn't updated.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The action returns a status and error message indicating whether the result value is updated to characteristics of samples successfully. If the characteristic isn't available in samples, then the result value isn't updated."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The action returns a status and error message indicating whether the result value is updated to characteristics of samples successfully. If the characteristic isn't available in samples, then the result value isn't updated."
}

The action returns a status and error message indicating whether the result value is updated to characteristics of samples successfully. If the characteristic isn't available in samples, then the result value isn't updated.

Back to Top