Jump to

• Request
• Response
• Examples

Update an inspection characteristic

patch

/fscmRestApi/resources/11.13.18.05/inspectionCharacteristics/{CharacteristicId}

Request

Path Parameters

• CharacteristicId(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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CharacteristicTypeCode: string
  Maximum Length: 30

  Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM.
• CharacteristicTypeMeaning: string
  Maximum Length: 80

  Type of the characteristic. Options are Item and Nonitem.
• DataTypeCode: string
  Maximum Length: 30

  Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE.
• DataTypeMeaning: string
  Maximum Length: 80

  Display value for the characteristic data type code. The accepted values are Character, Number, and Date.
• DecimalPrecision: integer (int32)
  Default Value: 0

  Decimal precision of the numeric value of the characteristic.
• Description: string
  Maximum Length: 240

  Translatable description of characteristic.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: true

  Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes.
• inspectionCharacteristicAttachments: array Characteristic Attachments
  Title: Characteristic Attachments

  The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.
• inspectionCharacteristicGroupAssociations: array Characteristic Group Associations
  Title: Characteristic Group Associations

  The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.
• inspectionCharacteristicValues: array Characteristic Values
  Title: Characteristic Values

  The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.
• ItemClassId: integer (int64)
  Value that uniquely identifies the surrogate reference of the item class.
• ItemClassName: string
  Maximum Length: 250

  Identifies the item class name associated with an item characteristic.
• MaximumAttributeReference: string
  Reference attribute that will be used to derive the maximum value
• MaximumValueDate: string (date-time)
  Title: Maximum Value

  Upper limit of the acceptable date range for an inspection characteristic.
• MaximumValueNumber: number
  Maximum value defined for the nonitem characteristic with data type as number.
• MinimumAttributeReference: string
  Reference attribute that will be used to derive the minimum value.
• MinimumValueDate: string (date-time)
  Title: Minimum Value

  Lower limit of the acceptable date range for an inspection characteristic.
• MinimumValueNumber: number
  Minimum value defined for the nonitem characteristic with data type as number.
• Name: string
  Title: Name

  Maximum Length: 80

  Translatable name of characteristic.
• TargetAttributeReference: string
  Reference attribute that will be used to derive the target value.
• TargetValueCharacter: string
  Maximum Length: 30

  Target value defined for the nonitem characteristic with data type as character.
• TargetValueDate: string (date-time)
  Title: Target

  Optimal date value for the inspection characteristic.
• TargetValueNumber: number
  Target value defined for the nonitem characteristic with data type as number.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure name associated with the characteristic.
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure for the value of the characteristic.
• ValueSetCode: string
  Maximum Length: 60

  Code that identifies the value set associated with the characteristic.
• ValueSetId: integer (int64)
  Value that uniquely identifies the value set which controls the list of values for the characteristic.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Translatable description of characteristic.",
            "nullable":true
        },
        "ItemClassName":{
            "maxLength":"250",
            "type":"string",
            "description":"Identifies the item class name associated with an item characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "inspectionCharacteristicGroupAssociations":{
            "title":"Characteristic Group Associations",
            "type":"array",
            "description":"The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-patch-request"
            }
        },
        "DecimalPrecision":{
            "type":"integer",
            "description":"Decimal precision of the numeric value of the characteristic.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            }
        },
        "MaximumAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the maximum value",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TargetValueNumber":{
            "type":"number",
            "description":"Target value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of characteristic.",
            "nullable":false
        },
        "DataTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Display value for the characteristic data type code. The accepted values are Character, Number, and Date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes.",
            "nullable":false,
            "default":true
        },
        "CharacteristicTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM.",
            "nullable":false
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure for the value of the characteristic.",
            "nullable":true
        },
        "TargetAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the target value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the minimum value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ValueSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the value set which controls the list of values for the characteristic.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure name associated with the characteristic.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "inspectionCharacteristicValues":{
            "title":"Characteristic Values",
            "type":"array",
            "description":"The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicValues-item-patch-request"
            }
        },
        "inspectionCharacteristicAttachments":{
            "title":"Characteristic Attachments",
            "type":"array",
            "description":"The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicAttachments-item-patch-request"
            }
        },
        "MinimumValueDate":{
            "title":"Minimum Value",
            "type":"string",
            "description":"Lower limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "TargetValueDate":{
            "title":"Target",
            "type":"string",
            "description":"Optimal date value for the inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "MaximumValueNumber":{
            "type":"number",
            "description":"Maximum value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "ValueSetCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Code that identifies the value set associated with the characteristic.",
            "nullable":true
        },
        "MaximumValueDate":{
            "title":"Maximum Value",
            "type":"string",
            "description":"Upper limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true
        },
        "ItemClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the surrogate reference of the item class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CharacteristicTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of the characteristic. Options are Item and Nonitem.",
            "nullable":true,
            "x-hints":{
                "controlType":"radio"
            }
        },
        "MinimumValueNumber":{
            "type":"number",
            "description":"Minimum value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "DataTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE.",
            "nullable":true
        },
        "TargetValueCharacter":{
            "maxLength":"30",
            "type":"string",
            "description":"Target value defined for the nonitem characteristic with data type as character.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Characteristic Attachments

Type: array

Title: Characteristic Attachments

The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.

Show Source

• Array of: object inspectionCharacteristics-inspectionCharacteristicAttachments-item-patch-request

{
    "title":"Characteristic Attachments",
    "type":"array",
    "description":"The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicAttachments-item-patch-request"
    }
}

Nested Schema : Characteristic Group Associations

Type: array

Title: Characteristic Group Associations

The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.

Show Source

• Array of: object schema

{
    "title":"Characteristic Group Associations",
    "type":"array",
    "description":"The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-patch-request"
    }
}

Nested Schema : Characteristic Values

Type: array

Title: Characteristic Values

The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.

Show Source

• Array of: object inspectionCharacteristics-inspectionCharacteristicValues-item-patch-request

{
    "title":"Characteristic Values",
    "type":"array",
    "description":"The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicValues-item-patch-request"
    }
}

Nested Schema : inspectionCharacteristics-inspectionCharacteristicAttachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. If True then the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates the data type code of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique ID of the uploaded file attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

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

  Version number of the uploaded file attachment.
• 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

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

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

  Expiration date and time of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment 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

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

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

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the data type code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique ID of the uploaded file attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. If True then the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the uploaded file attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CharacteristicId: integer (int64)
  Value that uniquely identifies the associated characteristic.
• Description: string
  Title: Description

  Maximum Length: 240

  Translatable description of characteristic group.
• GroupAssociationId: integer (int64)
  Value that uniquely identifies the characteristic group association.
• GroupId: integer (int64)
  Value that uniquely identifies the characteristic group.
• Name: string
  Title: Name

  Maximum Length: 80

  Translatable name of characteristic group.

{
    "type":"object",
    "properties":{
        "GroupAssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic group association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the associated characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Translatable description of characteristic group.",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of characteristic group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : inspectionCharacteristics-inspectionCharacteristicValues-item-patch-request

Type: object

Show Source

• CharacteristicId: integer (int64)
  Value that uniquely identifies the characteristic.
• Name: string
  Maximum Length: 80

  Translatable name of the characteristic value.
• ValueId: integer (int64)
  Value that uniquely identifies the characteristic value.

{
    "type":"object",
    "properties":{
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Name":{
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of the characteristic value.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AiSuggestion: string
  Maximum Length: 1

  Indicates that the characteristic has been created from a generative AI suggestion.
• CharacteristicId: integer (int64)
  Value that uniquely identifies the characteristic.
• CharacteristicTypeCode: string
  Maximum Length: 30

  Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM.
• CharacteristicTypeMeaning: string
  Maximum Length: 80

  Type of the characteristic. Options are Item and Nonitem.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the characteristic was created.
• DataTypeCode: string
  Maximum Length: 30

  Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE.
• DataTypeMeaning: string
  Maximum Length: 80

  Display value for the characteristic data type code. The accepted values are Character, Number, and Date.
• DecimalPrecision: integer (int32)
  Default Value: 0

  Decimal precision of the numeric value of the characteristic.
• Description: string
  Maximum Length: 240

  Translatable description of characteristic.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: true

  Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes.
• inspectionCharacteristicAttachments: array Characteristic Attachments
  Title: Characteristic Attachments

  The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.
• inspectionCharacteristicGroupAssociations: array Characteristic Group Associations
  Title: Characteristic Group Associations

  The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.
• inspectionCharacteristicValues: array Characteristic Values
  Title: Characteristic Values

  The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.
• ItemClassId: integer (int64)
  Value that uniquely identifies the surrogate reference of the item class.
• ItemClassName: string
  Maximum Length: 250

  Identifies the item class name associated with an item characteristic.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the characteristic.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the characteristic.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAttributeReference: string
  Reference attribute that will be used to derive the maximum value
• MaximumValueDate: string (date-time)
  Title: Maximum Value

  Upper limit of the acceptable date range for an inspection characteristic.
• MaximumValueNumber: number
  Maximum value defined for the nonitem characteristic with data type as number.
• MinimumAttributeReference: string
  Reference attribute that will be used to derive the minimum value.
• MinimumValueDate: string (date-time)
  Title: Minimum Value

  Lower limit of the acceptable date range for an inspection characteristic.
• MinimumValueNumber: number
  Minimum value defined for the nonitem characteristic with data type as number.
• Name: string
  Title: Name

  Maximum Length: 80

  Translatable name of characteristic.
• TargetAttributeReference: string
  Reference attribute that will be used to derive the target value.
• TargetValueCharacter: string
  Maximum Length: 30

  Target value defined for the nonitem characteristic with data type as character.
• TargetValueDate: string (date-time)
  Title: Target

  Optimal date value for the inspection characteristic.
• TargetValueNumber: number
  Target value defined for the nonitem characteristic with data type as number.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure name associated with the characteristic.
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure for the value of the characteristic.
• ValueSetCode: string
  Maximum Length: 60

  Code that identifies the value set associated with the characteristic.
• ValueSetId: integer (int64)
  Value that uniquely identifies the value set which controls the list of values for the characteristic.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the characteristic was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Translatable description of characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemClassName":{
            "maxLength":"250",
            "type":"string",
            "description":"Identifies the item class name associated with an item characteristic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "inspectionCharacteristicGroupAssociations":{
            "title":"Characteristic Group Associations",
            "type":"array",
            "description":"The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response"
            }
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DecimalPrecision":{
            "type":"integer",
            "description":"Decimal precision of the numeric value of the characteristic.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MaximumAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the maximum value",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetValueNumber":{
            "type":"number",
            "description":"Target value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of characteristic.",
            "nullable":false,
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Display value for the characteristic data type code. The accepted values are Character, Number, and Date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CharacteristicTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure for the value of the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the target value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumAttributeReference":{
            "type":"string",
            "description":"Reference attribute that will be used to derive the minimum value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the characteristic.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the value set which controls the list of values for the characteristic.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the characteristic.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure name associated with the characteristic.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "inspectionCharacteristicValues":{
            "title":"Characteristic Values",
            "type":"array",
            "description":"The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicValues-item-response"
            }
        },
        "inspectionCharacteristicAttachments":{
            "title":"Characteristic Attachments",
            "type":"array",
            "description":"The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.",
            "items":{
                "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicAttachments-item-response"
            }
        },
        "MinimumValueDate":{
            "title":"Minimum Value",
            "type":"string",
            "description":"Lower limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValueDate":{
            "title":"Target",
            "type":"string",
            "description":"Optimal date value for the inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumValueNumber":{
            "type":"number",
            "description":"Maximum value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "AiSuggestion":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the characteristic has been created from a generative AI suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueSetCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Code that identifies the value set associated with the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumValueDate":{
            "title":"Maximum Value",
            "type":"string",
            "description":"Upper limit of the acceptable date range for an inspection characteristic.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the surrogate reference of the item class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CharacteristicTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of the characteristic. Options are Item and Nonitem.",
            "nullable":true,
            "x-hints":{
                "controlType":"radio"
            },
            "x-queryable":true
        },
        "MinimumValueNumber":{
            "type":"number",
            "description":"Minimum value defined for the nonitem characteristic with data type as number.",
            "nullable":true,
            "x-queryable":false
        },
        "DataTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValueCharacter":{
            "maxLength":"30",
            "type":"string",
            "description":"Target value defined for the nonitem characteristic with data type as character.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the characteristic.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Characteristic Attachments

Type: array

Title: Characteristic Attachments

The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.

Show Source

• Array of: object inspectionCharacteristics-inspectionCharacteristicAttachments-item-response

{
    "title":"Characteristic Attachments",
    "type":"array",
    "description":"The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicAttachments-item-response"
    }
}

Nested Schema : Characteristic Group Associations

Type: array

Title: Characteristic Group Associations

The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.

Show Source

• Array of: object inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response

{
    "title":"Characteristic Group Associations",
    "type":"array",
    "description":"The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response"
    }
}

Nested Schema : Characteristic Values

Type: array

Title: Characteristic Values

The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.

Show Source

• Array of: object inspectionCharacteristics-inspectionCharacteristicValues-item-response

{
    "title":"Characteristic Values",
    "type":"array",
    "description":"The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.",
    "items":{
        "$ref":"#/components/schemas/inspectionCharacteristics-inspectionCharacteristicValues-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 : inspectionCharacteristics-inspectionCharacteristicAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attachment. System-generated primary key.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. If True then the attachment is shared.
• 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

  Name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates the data type code of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique ID of the uploaded file attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

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

  Version number of the uploaded file attachment.
• 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

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

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

  Expiration date and time of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment 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 of the last update of the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Name of the user who last updated 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

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

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

  Maximum Length: 4000

  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 associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"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
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique ID of the uploaded file attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. System-generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the attachment.",
            "nullable":true,
            "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"
            }
        },
        "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"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the uploaded file attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the data type code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. If True then the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time of the last update of the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response

Type: object

Show Source

• CharacteristicId: integer (int64)
  Value that uniquely identifies the associated characteristic.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the characteristic group association.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the characteristic group association was created.
• Description: string
  Title: Description

  Maximum Length: 240

  Translatable description of characteristic group.
• GroupAssociationId: integer (int64)
  Value that uniquely identifies the characteristic group association.
• GroupId: integer (int64)
  Value that uniquely identifies the characteristic group.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the characteristic group association was last updated by the user.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who most recently updated the characteristic group association.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Translatable name of characteristic group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who most recently updated the characteristic group association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the characteristic group association was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupAssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic group association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the characteristic group association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Translatable description of characteristic group.",
            "nullable":true,
            "x-queryable":true
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the associated characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the characteristic group association was last updated by the user.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of characteristic group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : inspectionCharacteristics-inspectionCharacteristicValues-item-response

Type: object

Show Source

• CharacteristicId: integer (int64)
  Value that uniquely identifies the characteristic.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the characteristic value was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the characteristic value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the characteristic value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 80

  Translatable name of the characteristic value.
• ValueId: integer (int64)
  Value that uniquely identifies the characteristic value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the characteristic value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the characteristic value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the characteristic value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the characteristic value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name of the characteristic value.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

DataTypeRestLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_QA_DATA_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: DataTypeMeaning; Target Attribute: Meaning
• Display Attribute: Meaning

ItemClassRestVA

Operation: /fscmRestApi/resources/11.13.18.05/itemClasses

The following properties are defined on the LOV link relation:

• Source Attribute: ItemClassName; Target Attribute: ItemClass
• Display Attribute: ItemClass

MaximumReferenceRestVVA

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristicItemAttributesLOV

Parameters:

• finder: itemClassAttributeFinder%3BItemClassId%3D{ItemClassId}%2CItemClassName%3D{ItemClassName}

The following properties are defined on the LOV link relation:

• Source Attribute: MaximumAttributeReference; Target Attribute: MaximumValueReferenceName
• Display Attribute: MaximumValueReferenceName

MinimumReferenceRestVVA

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristicItemAttributesLOV

Parameters:

• finder: itemClassAttributeFinder%3BItemClassId%3D{ItemClassId}%2CItemClassName%3D{ItemClassName}

The following properties are defined on the LOV link relation:

• Source Attribute: MinimumAttributeReference; Target Attribute: MinimumValueReferenceName
• Display Attribute: MinimumValueReferenceName

SourceObjectRestLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_QA_CHARACTERISTIC_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: CharacteristicTypeMeaning; Target Attribute: Meaning
• Display Attribute: Meaning

TargetReferenceRestVVA

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristicItemAttributesLOV

Parameters:

• finder: itemClassAttributeFinder%3BItemClassId%3D{ItemClassId}%2CItemClassName%3D{ItemClassName}

The following properties are defined on the LOV link relation:

• Source Attribute: TargetAttributeReference; Target Attribute: TargetValueReferenceName
• Display Attribute: TargetValueReferenceName

UnitOfMeasureRestVA

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure

The following properties are defined on the LOV link relation:

• Source Attribute: UnitOfMeasure; Target Attribute: UOM
• Display Attribute: UOM

inspectionCharacteristicAttachments

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristics/{CharacteristicId}/child/inspectionCharacteristicAttachments

Parameters:

• CharacteristicId: $request.path.CharacteristicId

The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.

inspectionCharacteristicGroupAssociations

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristics/{CharacteristicId}/child/inspectionCharacteristicGroupAssociations

Parameters:

• CharacteristicId: $request.path.CharacteristicId

The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.

inspectionCharacteristicValues

Operation: /fscmRestApi/resources/11.13.18.05/inspectionCharacteristics/{CharacteristicId}/child/inspectionCharacteristicValues

Parameters:

• CharacteristicId: $request.path.CharacteristicId

The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.

Back to Top

Examples

This example describes how to update an inspection characteristic.

Example cURL Command

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

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

For example:

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

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.

{
    "Description": "Inspection Characteristic Example Update"
}

Example Response Body

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

{
    "CharacteristicId": 300100570071843,
    "Name": "Inspection Characteristic Example",
    "Description": "Inspection Characteristic Example Update",
    "CharacteristicTypeCode": "NON_ITEM",
    "CharacteristicTypeMeaning": "Non-item",
    "DataTypeCode": "NUMBER",
    "DataTypeMeaning": "Number",
    "TargetValueCharacter": null,
    "UOMCode": "EA",
    "UnitOfMeasure": "EA",
    "DecimalPrecision": 6,
    "TargetValueNumber": 0.358001,
    "MinimumValueNumber": 0.320003,
    "MaximumValueNumber": 0.456786,
    "MinimumValueDate": null,
    "TargetValueDate": null,
    "MaximumValueDate": null,
    "ItemClassId": null,
    "ItemClassName": null,
    "TargetAttributeReference": null,
    "MaximumAttributeReference": null,
    "MinimumAttributeReference": null,
    "EnabledFlag": true,
    "ValueSetId": null,
    "ValueSetCode": null,
    "CreatedBy": "QUALITY_ENGINEER",
    "CreationDate": "2022-06-16T09:59:06+00:00",
    "LastUpdateDate": "2022-06-16T10:00:19+00:00",
    "LastUpdatedBy": "QUALITY_ENGINEER",
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100570071843",
            "name": "inspectionCharacteristics",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100570071843",
            "name": "inspectionCharacteristics",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100570071843/child/inspectionCharacteristicAttachments",
            "name": "inspectionCharacteristicAttachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100570071843/child/inspectionCharacteristicGroupAssociations",
            "name": "inspectionCharacteristicGroupAssociations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100570071843/child/inspectionCharacteristicValues",
            "name": "inspectionCharacteristicValues",
            "kind": "collection"
        }
    ]
}

Back to Top