Jump to

• Request
• Response
• Examples

Create all inspection actions

post

/fscmRestApi/resources/11.13.18.05/inspectionActions

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionStatus: string
  Maximum Length: 255

  Value that indicates the action creation status. A Success status means that the operation performed successfully.
• inspectionEventActions: array Inspection Event Actions
  Title: Inspection Event Actions

  The Inspection Actions resource is used to view inspection actions for the inspection event.
• InspectionPlanId: integer
  Value that indicates the inspection plan ID that's used for the action creation process.
• InspectionPlanName: string
  Maximum Length: 255

  Value that identifies the inspection plan name that's used for the action creation process.
• IpEventId: integer
  Value that uniquely identifies the inspection event.
• MessageText: string
  Maximum Length: 255

  Error message that's returned if the action creation fails.

{
    "type":"object",
    "properties":{
        "ActionStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the action creation status. A Success status means that the operation performed successfully.",
            "nullable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that indicates the inspection plan ID that's used for the action creation process.",
            "nullable":true
        },
        "InspectionPlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the inspection plan name that's used for the action creation process.",
            "nullable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event.",
            "nullable":true
        },
        "MessageText":{
            "maxLength":255,
            "type":"string",
            "description":"Error message that's returned if the action creation fails.",
            "nullable":true
        },
        "inspectionEventActions":{
            "title":"Inspection Event Actions",
            "type":"array",
            "description":"The Inspection Actions resource is used to view inspection actions for the inspection event.",
            "items":{
                "$ref":"#/components/schemas/inspectionActions-inspectionEventActions-item-post-request"
            }
        }
    }
}

Nested Schema : Inspection Event Actions

Type: array

Title: Inspection Event Actions

The Inspection Actions resource is used to view inspection actions for the inspection event.

Show Source

• Array of: object inspectionActions-inspectionEventActions-item-post-request

{
    "title":"Inspection Event Actions",
    "type":"array",
    "description":"The Inspection Actions resource is used to view inspection actions for the inspection event.",
    "items":{
        "$ref":"#/components/schemas/inspectionActions-inspectionEventActions-item-post-request"
    }
}

Nested Schema : inspectionActions-inspectionEventActions-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• ActionStatus: string
  Maximum Length: 255

  Value that indicates the action creation status. A Success status means that the operation performed successfully.
• inspectionEventActions: array Inspection Event Actions
  Title: Inspection Event Actions

  The Inspection Actions resource is used to view inspection actions for the inspection event.
• InspectionPlanId: integer
  Value that indicates the inspection plan ID that's used for the action creation process.
• InspectionPlanName: string
  Maximum Length: 255

  Value that identifies the inspection plan name that's used for the action creation process.
• IpEventId: integer
  Value that uniquely identifies the inspection event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageText: string
  Maximum Length: 255

  Error message that's returned if the action creation fails.

{
    "type":"object",
    "properties":{
        "ActionStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the action creation status. A Success status means that the operation performed successfully.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that indicates the inspection plan ID that's used for the action creation process.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the inspection plan name that's used for the action creation process.",
            "nullable":true,
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":255,
            "type":"string",
            "description":"Error message that's returned if the action creation fails.",
            "nullable":true,
            "x-queryable":true
        },
        "inspectionEventActions":{
            "title":"Inspection Event Actions",
            "type":"array",
            "description":"The Inspection Actions resource is used to view inspection actions for the inspection event.",
            "items":{
                "$ref":"#/components/schemas/inspectionActions-inspectionEventActions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Inspection Event Actions

Type: array

Title: Inspection Event Actions

The Inspection Actions resource is used to view inspection actions for the inspection event.

Show Source

• Array of: object inspectionActions-inspectionEventActions-item-response

{
    "title":"Inspection Event Actions",
    "type":"array",
    "description":"The Inspection Actions resource is used to view inspection actions for the inspection event.",
    "items":{
        "$ref":"#/components/schemas/inspectionActions-inspectionEventActions-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 : inspectionActions-inspectionEventActions-item-response

Type: object

Show Source

• ActionTaken: string
  Read Only: true

  Maximum Length: 32

  Value that indicates the action taken.
• AsActionTakenDate: string (date-time)
  Read Only: true

  Date and time that action was executed.
• IpEventId: integer
  Read Only: true

  Value that uniquely identifies the inspection event.
• IssueDescription: string
  Read Only: true

  Maximum Length: 3999

  Description of quality issue created by the action.
• IssueId: number
  Read Only: true

  Value that uniquely identifies the quality issue created by the action.
• IssueName: string
  Read Only: true

  Maximum Length: 400

  Name of the quality issue created by the action.
• IssueNumber: string
  Read Only: true

  Maximum Length: 100

  Quality issue number generated by the action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialStatusLevel: string
  Read Only: true

  Maximum Length: 32

  Value that indicates the level of the material status change.
• MessageName: string
  Read Only: true

  Maximum Length: 100

  Message code returned by the system based on the action.
• MessageText: string
  Read Only: true

  Maximum Length: 2400

  Message details for the action.
• Notifiers: string
  Read Only: true

  Maximum Length: 4000

  List of notification recipients.
• SampleId: number
  Read Only: true

  Value that uniquely identifies the sample to inspect.
• SampleNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the sample being inspected for a nonserial item.
• SampleResultId: number
  Read Only: true

  Value that uniquely identifies the result of the sample inspection.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the serial being inspected.
• StatusCode: string
  Read Only: true

  Maximum Length: 80

  New material status based on this action.
• StatusId: integer (int64)
  Read Only: true

  Value that uniquely identifies the new material status based on the action.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order created by the action.
• WorkOrderNumber: string
  Read Only: true

  Maximum Length: 120

  Work order number created by the action.

{
    "type":"object",
    "properties":{
        "ActionTaken":{
            "maxLength":32,
            "type":"string",
            "description":"Value that indicates the action taken.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AsActionTakenDate":{
            "type":"string",
            "description":"Date and time that action was executed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "maxLength":3999,
            "type":"string",
            "description":"Description of quality issue created by the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueId":{
            "type":"number",
            "description":"Value that uniquely identifies the quality issue created by the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueName":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the quality issue created by the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Quality issue number generated by the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialStatusLevel":{
            "maxLength":32,
            "type":"string",
            "description":"Value that indicates the level of the material status change.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":100,
            "type":"string",
            "description":"Message code returned by the system based on the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":2400,
            "type":"string",
            "description":"Message details for the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notifiers":{
            "maxLength":4000,
            "type":"string",
            "description":"List of notification recipients.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SampleId":{
            "type":"number",
            "description":"Value that uniquely identifies the sample to inspect.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SampleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the sample being inspected for a nonserial item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SampleResultId":{
            "type":"number",
            "description":"Value that uniquely identifies the result of the sample inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial being inspected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":80,
            "type":"string",
            "description":"New material status based on this action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new material status based on the action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order created by the action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Work order number created by the action.",
            "nullable":true,
            "readOnly":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"
    }
}

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

inspectionEventActions

Operation: /fscmRestApi/resources/11.13.18.05/inspectionActions/{IpEventId}/child/inspectionEventActions

Parameters:

• IpEventId: $request.path.IpEventId

The Inspection Actions resource is used to view inspection actions for the inspection event.

Back to Top

Examples

This example describes how to create actions for an inspection by executing action rules defined in a plan.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/inspectionActions"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"IpEventId": 300100591212388
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "IpEventId": 300100591212388,
    "InspectionPlanId": 300100591205147,
    "InspectionPlanName": "QA-2023-18 Demo Plan",
    "ActionStatus": "SUCCESS",
    "MessageText": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inspectionActions/300100591212388",
            "name": "inspectionActions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/inspectionActions/300100591212388",
            "name": "inspectionActions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/inspectionActions/300100591212388/child/inspectionEventActions",
            "name": "inspectionEventActions",
            "kind": "collection"
        }
    ]
}

Back to Top