Jump to

• Request
• Response

Add characteristics or characteristic groups to samples

post

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

Adds a list of characteristics or a group of characteristics to a list of samples or all samples of an inspection. Returns an error if empty list of characteristics or groups 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

• characteristics: array characteristics
  List of characteristics added to inspection samples.
• groups: array groups
  Characteristic groups added to inspection samples.
• samples: array samples
  Samples to which characteristics are added.

{
    "type":"object",
    "properties":{
        "characteristics":{
            "type":"array",
            "description":"List of characteristics added to inspection samples.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "groups":{
            "type":"array",
            "description":"Characteristic groups added to inspection samples.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "samples":{
            "type":"array",
            "description":"Samples to which characteristics are added.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : characteristics

Type: array

List of characteristics added to inspection samples.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of characteristics added to inspection samples.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : groups

Type: array

Characteristic groups added to inspection samples.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Characteristic groups added to inspection samples.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

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 characteristics were successfully added to samples.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The action returns a status and error message indicating whether characteristics were successfully added to samples."
        }
    },
    "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 characteristics were successfully added to samples."
}

The action returns a status and error message indicating whether characteristics were successfully added to samples.

Back to Top