Jump to

• Request
• Response
• Examples

Create one specification

post

/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/specifications

Request

Path Parameters

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

• AiSuggestion: string
  Maximum Length: 1

  Indicates that the characteristic has been created from a generative AI suggestion.
• attachments: array Attachments in Inspection Plan Specifications
  Title: Attachments in Inspection Plan Specifications

  The Attachments in Inspection Plans resource displays attachment details of an inspection plan.
• CharacteristicId(required): integer (int64)
  Title: Characteristic ID

  Value that uniquely identifies the inspection characteristic against which the specification is being defined.
• CharacteristicName: string
  Name of the inspection characteristic.
• DefaultValueFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value isn't defaulted from the target value associated to the specification line during an inspection. This attribute doesn't have a default value.
• GaugeAssetGroup: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetGroupId: integer (int64)
  Value that uniquely identifies the gauge asset group used to collect the inspection result value.
• GaugeResource: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource used to collect the inspection result value.
• GaugeResourceId: integer (int64)
  Value that uniquely identifies the gauge resource used to collect the inspection result value.
• InspectionPlanId(required): integer (int64)
  Value that uniquely identifies the inspection plan.
• ItemTargetValue: string
  Title: Item Based Target Value

  Maximum Length: 80

  Optimal value for an item.
• MaximumValueDate: string (date-time)
  Upper limit of the acceptable date range for an inspection characteristic.
• MaximumValueNumber: number
  Upper limit of the acceptable numeric range for an inspection characteristic.
• MinimumValueDate: string (date-time)
  Lower limit of the acceptable date range for an inspection characteristic.
• MinimumValueNumber: number
  Lower limit of the acceptable numeric range for an inspection characteristic.
• NonItemTargetValue: string
  Maximum Length: 255

  Target value of the inspection characteristic.
• OptionalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute doesn't have a default value.
• SpecificationCharacteristicName: string
  Maximum Length: 255

  Name of the inspection characteristic.
• SpecificationId: integer (int64)
  Value that uniquely identifies the specification for the inspection plan.
• TargetValue: string
  Title: Target Value Character

  Maximum Length: 80

  Target value of the inspection characteristic.
• TargetValueDate: string (date-time)
  Optimal date value for the inspection characteristic.
• TargetValueNumber: number
  Optimal numeric value for the inspection characteristic.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measurement for the quantity that this event inspects.
• UserSequence(required): integer (int32)
  Sequence to use when associating the inspection characteristic with the inspection plan.

{
    "required":[
        "CharacteristicId",
        "InspectionPlanId",
        "UserSequence"
    ],
    "type":"object",
    "properties":{
        "AiSuggestion":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the characteristic has been created from a generative AI suggestion.",
            "nullable":true
        },
        "CharacteristicId":{
            "title":"Characteristic ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inspection characteristic against which the specification is being defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CharacteristicName":{
            "type":"string",
            "description":"Name of the inspection characteristic.",
            "nullable":true
        },
        "DefaultValueFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value isn't defaulted from the target value associated to the specification line during an inspection. This attribute doesn't have a default value.",
            "nullable":true
        },
        "GaugeAssetGroup":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset group used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "GaugeResource":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemTargetValue":{
            "title":"Item Based Target Value",
            "maxLength":80,
            "type":"string",
            "description":"Optimal value for an item.",
            "nullable":true
        },
        "MaximumValueDate":{
            "type":"string",
            "description":"Upper limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "MaximumValueNumber":{
            "type":"number",
            "description":"Upper limit of the acceptable numeric range for an inspection characteristic.",
            "nullable":true
        },
        "MinimumValueDate":{
            "type":"string",
            "description":"Lower limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "MinimumValueNumber":{
            "type":"number",
            "description":"Lower limit of the acceptable numeric range for an inspection characteristic.",
            "nullable":true
        },
        "NonItemTargetValue":{
            "maxLength":255,
            "type":"string",
            "description":"Target value of the inspection characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute doesn't have a default value.",
            "nullable":true
        },
        "SpecificationCharacteristicName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SpecificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specification for the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TargetValue":{
            "title":"Target Value Character",
            "maxLength":80,
            "type":"string",
            "description":"Target value of the inspection characteristic.",
            "nullable":true
        },
        "TargetValueDate":{
            "type":"string",
            "description":"Optimal date value for the inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "TargetValueNumber":{
            "type":"number",
            "description":"Optimal numeric value for the inspection characteristic.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measurement for the quantity that this event inspects.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserSequence":{
            "type":"integer",
            "description":"Sequence to use when associating the inspection characteristic with the inspection plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "attachments":{
            "title":"Attachments in Inspection Plan Specifications",
            "type":"array",
            "description":"The Attachments in Inspection Plans resource displays attachment details of an inspection plan.",
            "items":{
                "$ref":"#/components/schemas/inspectionPlans-specifications-attachments-item-post-request"
            }
        }
    }
}

Nested Schema : Attachments in Inspection Plan Specifications

Type: array

Title: Attachments in Inspection Plan Specifications

The Attachments in Inspection Plans resource displays attachment details of an inspection plan.

Show Source

• Array of: object schema

{
    "title":"Attachments in Inspection Plan Specifications",
    "type":"array",
    "description":"The Attachments in Inspection Plans resource displays attachment details of an inspection plan.",
    "items":{
        "$ref":"#/components/schemas/inspectionPlans-specifications-attachments-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Value that uniquely identifies the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category for the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: Yes or No. If Yes, then the attachment is shared. If No, then the attachment isn't shared. The default value is Yes.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the file.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file.
• FileUrl: string
  Title: File Url

  URL of the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform Resource Identifier (URI) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Value that uniquely identifies the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the category for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the attachment is shared. If No, then the attachment isn't shared. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the file.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Identifier (URI) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

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 : inspectionPlans-specifications-item-response

Type: object

Show Source

• AiSuggestion: string
  Maximum Length: 1

  Indicates that the characteristic has been created from a generative AI suggestion.
• attachments: array Attachments in Inspection Plan Specifications
  Title: Attachments in Inspection Plan Specifications

  The Attachments in Inspection Plans resource displays attachment details of an inspection plan.
• CharacteristicId: integer (int64)
  Title: Characteristic ID

  Value that uniquely identifies the inspection characteristic against which the specification is being defined.
• CharacteristicName: string
  Name of the inspection characteristic.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the inspection specification.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the inspection specification.
• DefaultValueFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value isn't defaulted from the target value associated to the specification line during an inspection. This attribute doesn't have a default value.
• GaugeAssetGroup: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetGroupId: integer (int64)
  Value that uniquely identifies the gauge asset group used to collect the inspection result value.
• GaugeResource: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource used to collect the inspection result value.
• GaugeResourceId: integer (int64)
  Value that uniquely identifies the gauge resource used to collect the inspection result value.
• InspectionPlanId: integer (int64)
  Value that uniquely identifies the inspection plan.
• ItemTargetValue: string
  Title: Item Based Target Value

  Maximum Length: 80

  Optimal value for an item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the inspection specification.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the inspection specification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumValueDate: string (date-time)
  Upper limit of the acceptable date range for an inspection characteristic.
• MaximumValueNumber: number
  Upper limit of the acceptable numeric range for an inspection characteristic.
• MinimumValueDate: string (date-time)
  Lower limit of the acceptable date range for an inspection characteristic.
• MinimumValueNumber: number
  Lower limit of the acceptable numeric range for an inspection characteristic.
• NonItemTargetValue: string
  Maximum Length: 255

  Target value of the inspection characteristic.
• OptionalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute doesn't have a default value.
• SpecificationCharacteristicName: string
  Maximum Length: 255

  Name of the inspection characteristic.
• SpecificationId: integer (int64)
  Value that uniquely identifies the specification for the inspection plan.
• TargetValue: string
  Title: Target Value Character

  Maximum Length: 80

  Target value of the inspection characteristic.
• TargetValueDate: string (date-time)
  Optimal date value for the inspection characteristic.
• TargetValueNumber: number
  Optimal numeric value for the inspection characteristic.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measurement for the quantity that this event inspects.
• UOMMeaning: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the unit of measurement for the quantity that this event inspects.
• UserSequence: integer (int32)
  Sequence to use when associating the inspection characteristic with the inspection plan.

{
    "type":"object",
    "properties":{
        "AiSuggestion":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the characteristic has been created from a generative AI suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "CharacteristicId":{
            "title":"Characteristic ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inspection characteristic against which the specification is being defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CharacteristicName":{
            "type":"string",
            "description":"Name of the inspection characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the inspection specification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the inspection specification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value isn't defaulted from the target value associated to the specification line during an inspection. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "GaugeAssetGroup":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset group used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "GaugeResource":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemTargetValue":{
            "title":"Item Based Target Value",
            "maxLength":80,
            "type":"string",
            "description":"Optimal value for an item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the inspection specification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the inspection specification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumValueDate":{
            "type":"string",
            "description":"Upper limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumValueNumber":{
            "type":"number",
            "description":"Upper limit of the acceptable numeric range for an inspection characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumValueDate":{
            "type":"string",
            "description":"Lower limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumValueNumber":{
            "type":"number",
            "description":"Lower limit of the acceptable numeric range for an inspection characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "NonItemTargetValue":{
            "maxLength":255,
            "type":"string",
            "description":"Target value of the inspection characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SpecificationCharacteristicName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SpecificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specification for the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target Value Character",
            "maxLength":80,
            "type":"string",
            "description":"Target value of the inspection characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValueDate":{
            "type":"string",
            "description":"Optimal date value for the inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValueNumber":{
            "type":"number",
            "description":"Optimal numeric value for the inspection characteristic.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measurement for the quantity that this event inspects.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the unit of measurement for the quantity that this event inspects.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserSequence":{
            "type":"integer",
            "description":"Sequence to use when associating the inspection characteristic with the inspection plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments in Inspection Plan Specifications",
            "type":"array",
            "description":"The Attachments in Inspection Plans resource displays attachment details of an inspection plan.",
            "items":{
                "$ref":"#/components/schemas/inspectionPlans-specifications-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments in Inspection Plan Specifications

Type: array

Title: Attachments in Inspection Plan Specifications

The Attachments in Inspection Plans resource displays attachment details of an inspection plan.

Show Source

• Array of: object inspectionPlans-specifications-attachments-item-response

{
    "title":"Attachments in Inspection Plan Specifications",
    "type":"array",
    "description":"The Attachments in Inspection Plans resource displays attachment details of an inspection plan.",
    "items":{
        "$ref":"#/components/schemas/inspectionPlans-specifications-attachments-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 : inspectionPlans-specifications-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Value that uniquely identifies the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category for the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: Yes or No. If Yes, then the attachment is shared. If No, then the attachment isn't shared. The default value is Yes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the file.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file.
• FileUrl: string
  Title: File Url

  URL of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The Base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform Resource Identifier (URI) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Value that uniquely identifies the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the category for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the attachment is shared. If No, then the attachment isn't shared. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the file.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The Base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Identifier (URI) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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

GaugeAssetGroupVA

Operation: /fscmRestApi/resources/11.13.18.05/assetGroups

The following properties are defined on the LOV link relation:

• Source Attribute: GaugeAssetGroup; Target Attribute: GroupName
• Display Attribute: GroupName

GaugeResourceVA

Operation: /fscmRestApi/resources/11.13.18.05/productionResources

The following properties are defined on the LOV link relation:

• Source Attribute: GaugeResource; Target Attribute: ResourceName
• Display Attribute: ResourceName

attachments

Operation: /fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/specifications/{SpecificationId}/child/attachments

Parameters:

• InspectionPlanId: $request.path.InspectionPlanId
• SpecificationId: $request.path.SpecificationId

The attachments in specifications child resource displays attachment details of an inspection plan specification.

Back to Top

Examples

This example describes how to create one specification.

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/inspectionPlans/InspectionPlanId/child/specifications"

Example 1 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 creates.

{
         "UserSequence" : 20,
         "CharacteristicName": "QIM_BAT_NonValItemInspChar"
}

Example 1 Response Body

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

{
  "SpecificationId": 300100152744380,
  "ObjectVersionNumber": 1,
  "InspectionPlanId": 300100152744368,
  "UserSequence": 20,
  "CharacteristicId": 300100122347610,
  "UOMCode": null,
  "TargetValue": null,
  "CreatedBy": "QUALITY_ENGINEER",
  "CreationDate": "2018-07-02T07:56:44+00:00",
  "LastUpdatedBy": "QUALITY_ENGINEER",
  "LastUpdateDate": "2018-07-02T07:56:44.027+00:00",
  "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB",
  "MaximumValueDate": null,
  "MinimumValueDate": null,
  "TargetValueDate": null,
  "CharacteristicName": "QIM_BAT_NonValItemInspChar",
  "MaximumValueNumber": null,
  "MinimumValueNumber": null,
  "TargetValueNumber": null,
  "ItemTargetValue": null,
  "links": [{
    "rel": "self",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380",
    "name": "specifications",
    "kind": "item",
    "properties": {
      "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel": "canonical",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380",
    "name": "specifications",
    "kind": "item"
  }, {
    "rel": "parent",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368",
    "name": "inspectionPlans",
    "kind": "item"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380/lov/CharacteristicValueLOV",
    "name": "CharacteristicValueLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380/lov/CharacteristicNameLOV",
    "name": "CharacteristicNameLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380/lov/UnitOfMeasureLOV",
    "name": "UnitOfMeasureLOV",
    "kind": "collection"
  }, {
    "rel": "child",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744380/child/specificationAttachments",
    "name": "specificationAttachments",
    "kind": "collection"
  }]
}

Example 2 Request Body

In this example, the gauge profile option is disabled.

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

{
"UserSequence" : 10,
"CharacteristicName" : "QIM-NonItemNum-5",
"OptionalFlag" : "N",
"DefaultValueFlag" : "N"
}

Example 2 Response Body

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

{
    "SpecificationId": 300100634403065,
    "InspectionPlanId": 300100634391675,
    "UserSequence": 10,
    "CharacteristicId": 300100151162609,
    "UOMCode": "BX5",
    "TargetValue": null,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2025-04-29T05:52:53+00:00",
    "LastUpdatedBy": "SCMOPERATIONS",
    "LastUpdateDate": "2025-04-29T05:52:53.152+00:00",
    "MaximumValueDate": null,
    "MinimumValueDate": null,
    "TargetValueDate": null,
    "CharacteristicName": "QIM-NonItemNum-5",
    "MaximumValueNumber": 18.455,
    "MinimumValueNumber": 2.660,
    "TargetValueNumber": 9.134,
    "ItemTargetValue": null,
    "OptionalFlag": false,
    "DefaultValueFlag": false,
    "AiSuggestion": "N",
    "UOMMeaning": null,
    "SpecificationCharacteristicName": null,
    "NonItemTargetValue": null,
    "GaugeAssetGroupId": null,
    "GaugeResourceId": null,
    "GaugeAssetGroup": null,
    "GaugeResource": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065",
            "name": "specifications",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065",
            "name": "specifications",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675",
            "name": "inspectionPlans",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/lov/UnitOfMeasureLOV",
            "name": "UnitOfMeasureLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/lov/CharacteristicValueLOV",
            "name": "CharacteristicValueLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/lov/GaugeResourceVA",
            "name": "GaugeResourceVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/lov/CharacteristicNameLOV",
            "name": "CharacteristicNameLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/lov/GaugeAssetGroupVA",
            "name": "GaugeAssetGroupVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100634391675/child/specifications/300100634403065/child/attachments",
            "name": "attachments",
            "kind": "collection"
        }
    ]
}

Example 3 Request Body

In this example, the gauge profile option is set to gauge asset type.

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

{
"UserSequence" : 30,
"CharacteristicName" : "QIM-Correct Part",
"GaugeAssetGroup" : "Digital Pressure Gauges",
"OptionalFlag" : "N",
"DefaultValueFlag" : "N"
}

Example 3 Response Body

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

{
    "SpecificationId": "300100624355670",
    "InspectionPlanId": "300100624356697",
    "UserSequence": 30,
    "CharacteristicId": "300100151162620",
    "UOMCode": null,
    "TargetValue": "Yes",
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-12-05T10:10:48+00:00",
    "LastUpdatedBy": "SCMOPERATIONS",
    "LastUpdateDate": "2024-12-05T10:10:48.496+00:00",
    "MaximumValueDate": null,
    "MinimumValueDate": null,
    "TargetValueDate": null,
    "CharacteristicName": "QIM-Correct Part",
    "MaximumValueNumber": null,
    "MinimumValueNumber": null,
    "TargetValueNumber": null,
    "ItemTargetValue": null,
    "OptionalFlag": false,
    "DefaultValueFlag": false,
    "AiSuggestion": "N",
    "UOMMeaning": null,
    "SpecificationCharacteristicName": null,
    "NonItemTargetValue": null,
    "GaugeAssetGroupId": "300100621126623",
    "GaugeResourceId": null,
    "GaugeAssetGroup": "Digital Pressure Gauges",
    "GaugeResource": null,
    "@context": {
        "key": "300100624355670",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355670",
                "name": "specifications",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355670",
                "name": "specifications",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697",
                "name": "inspectionPlans",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355670/child/attachments",
                "name": "attachments",
                "kind": "collection"
            }
        ]
    }
}

Example 4 Request Body

In this example, the gauge profile option is set to gauge resource type.

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

{
"UserSequence" : 10,
"CharacteristicName" : "QIM-NonItemNum-5",
"GaugeResource" : "Welding Torch",
"OptionalFlag" : "N",
"DefaultValueFlag" : "N"
}

Example 4 Response Body

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

{
    "SpecificationId": "300100624434667",
    "InspectionPlanId": "300100624430813",
    "UserSequence": 10,
    "CharacteristicId": "300100151162609",
    "UOMCode": "BX5",
    "TargetValue": null,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-12-05T13:36:41+00:00",
    "LastUpdatedBy": "SCMOPERATIONS",
    "LastUpdateDate": "2024-12-05T13:36:42.637+00:00",
    "MaximumValueDate": null,
    "MinimumValueDate": null,
    "TargetValueDate": null,
    "CharacteristicName": "QIM-NonItemNum-5",
    "MaximumValueNumber": "18.455",
    "MinimumValueNumber": "2.660",
    "TargetValueNumber": "9.134",
    "ItemTargetValue": null,
    "OptionalFlag": false,
    "DefaultValueFlag": false,
    "AiSuggestion": "N",
    "UOMMeaning": null,
    "SpecificationCharacteristicName": null,
    "NonItemTargetValue": null,
    "GaugeAssetGroupId": null,
    "GaugeResourceId": "300100081228472",
    "GaugeAssetGroup": null,
    "GaugeResource": "Welding Torch",
    "@context": {
        "key": "300100624434667",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624430813/child/specifications/300100624434667",
                "name": "specifications",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624430813/child/specifications/300100624434667",
                "name": "specifications",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624430813",
                "name": "inspectionPlans",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624430813/child/specifications/300100624434667/child/attachments",
                "name": "attachments",
                "kind": "collection"
            }
        ]
    }
}

Back to Top