Jump to

• Request
• Response
• Examples

Get all details

get

/fscmRestApi/resources/11.13.18.05/inspectionDetails

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Find inspection details.
    Finder Variables:
    • InspectionPlanId; integer; Value that uniquely identifies the inspection plan.
    • IpSpecificationId; integer; Value that uniquely identifies the inspection specification.
    • UOMCode; string; Abbreviation that identifies the unit of measure.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApproverUserId; integer; Value that uniquely identifies the user who approved the inspection plan. This user might be different from the user who created the inspection plan or the inspection plan owner.
  • AttachmentEntityName; string; Name to use when accessing the attachments for the plan.
  • AttachmentEntityNameSpecification; string; Name to use when accessing the attachments for the plan specification.
  • CategoryId; integer; Value that uniquely identifies the category of the item to inspect.
  • CategorySetId; integer; Value that uniquely identifies the catalog of the item to inspect.
  • CharacteristicDescription; string; Description of characteristic.
  • CharacteristicId; integer; Value that uniquely identifies the characteristic.
  • CharacteristicName; string; Name of characteristic.
  • Description; string; Description of the inspection plan.
  • EffectiveEndDate; string; End date of the date range that specifies when the inspection plan is in effect.
  • EffectiveStartDate; string; Start date of the date range that specifies when the inspection plan is in effect.
  • EnabledFlag; boolean; Contains one of the following values: true or false. If true, then inspection details are enabled. If false, then details are not enabled. The default value is Yes.
  • InspectionLevelId; integer; Value that uniquely identifies the inspection level of the inspection plan.
  • InspectionPlanCode; string; Abbreviation that identifies the inspection plan.
  • InspectionPlanId; integer; Value that uniquely identifies the plan to use when performing an inspection.
  • InspectionPlanStatus; string; Status of the inspection plan. Values include New, On Hold, Approved, or Obsolete.
  • InspectionPlanType; string; Inspection plan type. Values include Receiving, Inventory, Work In Process, or Resource.
  • InventoryItemId; integer; Value that uniquely identifies the item that the inspection plan references.
  • IpSpecificationId; integer; Value that uniquely identifies the inspection plan specification.
  • MaximumValue; string; Maximum threshold value of the characteristic.
  • MinimumValue; string; Minimum threshold value of the characteristic.
  • Name; string; Name of the inspection plan.
  • ObjectVersionNumber; integer; Version number. You can use this number to lock the object. The resource increments this number every time it updates the row. The resource compares the number at the start and at the end of the transaction to determine whether another session updated the row since the most recent query.
  • OrganizationId; integer; Value that uniquely identifies the organization that the inspection plan references.
  • TargetValue; string; Target value of the characteristic.
  • UOMCode; string; Abbreviation that identifies the unit of measurement for the quantity that this event inspects.
  • UnitOfMeasure; string; Name of the unit of measure.
  • UserSequence; integer; Sequence to use when inspecting the characteristic.
  • VersionNumber; string; Version number of the inspection plan.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : inspectionDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/inspectionDetails-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Manufacturing",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inspectionDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inspectionDetails-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 : inspectionDetails-item-response

Type: object

Show Source

• ApproverUserId: integer (int64)
  Read Only: true

  Value that uniquely identifies the user who approved the inspection plan. This user might be different from the user who created the inspection plan or the inspection plan owner.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: QA_INSPECTION_PLANS_B

  Name to use when accessing the attachments for the plan.
• AttachmentEntityNameSpecification: string
  Maximum Length: 255

  Default Value: QA_IP_SPECIFICATIONS

  Name to use when accessing the attachments for the plan specification.
• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages attachment details for the inspection plan.
• CategoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the category of the item to inspect.
• CategorySetId: integer (int64)
  Read Only: true

  Value that uniquely identifies the catalog of the item to inspect.
• CharacteristicDescription: string
  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 80

  Name of characteristic.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the inspection plan.
• EffectiveEndDate: string (date)
  Read Only: true

  End date of the date range that specifies when the inspection plan is in effect.
• EffectiveStartDate: string (date)
  Read Only: true

  Start date of the date range that specifies when the inspection plan is in effect.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then inspection details are enabled. If false, then details are not enabled. The default value is Yes.
• InspectionLevelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inspection level of the inspection plan.
• InspectionPlanCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the inspection plan.
• InspectionPlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan to use when performing an inspection.
• InspectionPlanStatus: string
  Read Only: true

  Maximum Length: 30

  Status of the inspection plan. Values include New, On Hold, Approved, or Obsolete.
• InspectionPlanType: string
  Read Only: true

  Maximum Length: 30

  Inspection plan type. Values include Receiving, Inventory, Work In Process, or Resource.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item that the inspection plan references.
• IpSpecificationId: integer (int64)
  Value that uniquely identifies the inspection plan specification.
• links: array Links
  Title: Links

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

  Maximum threshold value of the characteristic.
• MinimumValue: string
  Maximum Length: 80

  Minimum threshold value of the characteristic.
• Name: string
  Read Only: true

  Maximum Length: 80

  Name of the inspection plan.
• ObjectVersionNumber: integer (int32)
  Version number. You can use this number to lock the object. The resource increments this number every time it updates the row. The resource compares the number at the start and at the end of the transaction to determine whether another session updated the row since the most recent query.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization that the inspection plan references.
• SpecificationAttachments: array Specification Attachments
  Title: Specification Attachments

  The Specification Attachments resource manages attachment details for the specification.
• TargetValue: string
  Maximum Length: 80

  Target value of the characteristic.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measurement for the quantity that this event inspects.
• UserSequence: integer (int32)
  Sequence to use when inspecting the characteristic.
• VersionNumber: string
  Read Only: true

  Maximum Length: 30

  Version number of the inspection plan.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category of the item to inspect.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the inspection plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CharacteristicDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of characteristic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IpSpecificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan specification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionPlanStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the inspection plan. Values include New, On Hold, Approved, or Obsolete.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproverUserId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who approved the inspection plan. This user might be different from the user who created the inspection plan or the inspection plan owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Maximum threshold value of the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that the inspection plan references.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachment details for the inspection plan.",
            "items":{
                "$ref":"#/components/schemas/inspectionDetails-Attachments-item-response"
            }
        },
        "Name":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the inspection plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number. You can use this number to lock the object. The resource increments this number every time it updates the row. The resource compares the number at the start and at the end of the transaction to determine whether another session updated the row since the most recent query.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "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: true or false. If true, then inspection details are enabled. If false, then details are not enabled. The default value is Yes.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measurement for the quantity that this event inspects.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SpecificationAttachments":{
            "title":"Specification Attachments",
            "type":"array",
            "description":"The Specification Attachments resource manages attachment details for the specification.",
            "items":{
                "$ref":"#/components/schemas/inspectionDetails-SpecificationAttachments-item-response"
            }
        },
        "InspectionLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection level of the inspection plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Target value of the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"End date of the date range that specifies when the inspection plan is in effect.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the inspection plan references.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionPlanCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the inspection plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Version number of the inspection plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityNameSpecification":{
            "maxLength":"255",
            "type":"string",
            "description":"Name to use when accessing the attachments for the plan specification.",
            "nullable":true,
            "default":"QA_IP_SPECIFICATIONS",
            "x-queryable":true
        },
        "InspectionPlanType":{
            "maxLength":"30",
            "type":"string",
            "description":"Inspection plan type. Values include Receiving, Inventory, Work In Process, or Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserSequence":{
            "type":"integer",
            "description":"Sequence to use when inspecting the characteristic.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CharacteristicName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of characteristic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Minimum threshold value of the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog of the item to inspect.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Start date of the date range that specifies when the inspection plan is in effect.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name to use when accessing the attachments for the plan.",
            "nullable":true,
            "default":"QA_INSPECTION_PLANS_B",
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan to use when performing an inspection.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages attachment details for the inspection plan.

Show Source

• Array of: object inspectionDetails-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachment details for the inspection plan.",
    "items":{
        "$ref":"#/components/schemas/inspectionDetails-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 : Specification Attachments

Type: array

Title: Specification Attachments

The Specification Attachments resource manages attachment details for the specification.

Show Source

• Array of: object inspectionDetails-SpecificationAttachments-item-response

{
    "title":"Specification Attachments",
    "type":"array",
    "description":"The Specification Attachments resource manages attachment details for the specification.",
    "items":{
        "$ref":"#/components/schemas/inspectionDetails-SpecificationAttachments-item-response"
    }
}

Nested Schema : inspectionDetails-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

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

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not 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.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• 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

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

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

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

  Maximum Length: 2048

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

  URL (Uniform Resource Locator) 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 attachment was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated 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

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

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User who added or modified the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment.",
            "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":"Name of the attachment file.",
            "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 (Uniform Resource Identifier) 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 (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "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":"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
        },
        "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":"Number that identifies the version of the attached document.",
            "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 most recently updated 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":"User who added or modified 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":"Abbreviation that identifies the data type.",
            "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":"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
        },
        "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"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is Yes.",
            "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 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":"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"
            }
        },
        "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 when the attachment was most recently updated.",
            "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":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading 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 : inspectionDetails-SpecificationAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

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

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not 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.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• 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

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

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

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

  Maximum Length: 2048

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

  URL (Uniform Resource Locator) 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 attachment was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated 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

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

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User who added or modified the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment.",
            "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":"Name of the attachment file.",
            "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 (Uniform Resource Identifier) 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 (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "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":"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
        },
        "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":"Number that identifies the version of the attached document.",
            "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 most recently updated 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":"User who added or modified 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":"Abbreviation that identifies the data type.",
            "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":"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
        },
        "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"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is Yes.",
            "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 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":"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"
            }
        },
        "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 when the attachment was most recently updated.",
            "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":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading 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"
    }
}

Back to Top

Examples

This example describes how to get all inspection details.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionDetails"

Example Response Body

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

{
  "items" : [ {
    "InspectionPlanId" : 300100090874966,
    "Name" : "Power Supply",
    "Description" : null,
    "InspectionLevelId" : 300100089612767,
    "InspectionPlanCode" : "300100090874966",
    "InspectionPlanType" : "RECEIVING",
    "InspectionPlanStatus" : "NEW",
    "OrganizationId" : 300100039754034,
    "InventoryItemId" : null,
    "ApproverUserId" : 0,
    "CategoryId" : 3862,
    "CategorySetId" : 300100012686450,
    "VersionNumber" : "1",
    "EffectiveEndDate" : null,
    "EffectiveStartDate" : "2016-08-03",
    "IpSpecificationId" : 300100090874967,
    "ObjectVersionNumber" : 1,
    "UserSequence" : 10,
    "CharacteristicId" : 300100090874944,
    "TargetValue" : "1.00",
    "MaximumValue" : "4.00",
    "MinimumValue" : "0.00",
    "EnabledFlag" : true,
    "UOMCode" : "AEA",
    "UnitOfMeasure" : "ARU-EA",
    "CharacteristicName" : "sss",
    "CharacteristicDescription" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C560000000EACED00057708000110F07F504C5700000003414541",
      "name" : "inspectionDetails",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C560000000EACED00057708000110F07F504C5700000003414541",
      "name" : "inspectionDetails",
      "kind" : "item"
    } ]
  }, {
    "InspectionPlanId" : 300100090874963,
    "Name" : "skj",
    "Description" : null,
    "InspectionLevelId" : 300100089612767,
    "InspectionPlanCode" : "300100090874963",
    "InspectionPlanType" : "WORK_IN_PROCESS",
    "InspectionPlanStatus" : "NEW",
    "OrganizationId" : 300100014494183,
    "InventoryItemId" : 300100015667399,
    "ApproverUserId" : 0,
    "CategoryId" : null,
    "CategorySetId" : null,
    "VersionNumber" : "1",
    "EffectiveEndDate" : null,
    "EffectiveStartDate" : "2016-08-03",
    "IpSpecificationId" : 300100090874964,
    "ObjectVersionNumber" : 1,
    "UserSequence" : 10,
    "CharacteristicId" : 300100090874944,
    "TargetValue" : "1.00",
    "MaximumValue" : "4.00",
    "MinimumValue" : "0.00",
    "EnabledFlag" : true,
    "UOMCode" : "AEA",
    "UnitOfMeasure" : "ARU-EA",
    "CharacteristicName" : "sss",
    "CharacteristicDescription" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C530000000EACED00057708000110F07F504C5400000003414541",
      "name" : "inspectionDetails",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C530000000EACED00057708000110F07F504C5400000003414541",
      "name" : "inspectionDetails",
      "kind" : "item"
    } ]
  }, {
    "InspectionPlanId" : 300100090874978,
    "Name" : "ss",
    "Description" : "100% Inspection",
    "InspectionLevelId" : 300100089612767,
    "InspectionPlanCode" : "300100090874978",
    "InspectionPlanType" : "INVENTORY",
    "InspectionPlanStatus" : "NEW",
    "OrganizationId" : 207,
    "InventoryItemId" : null,
    "ApproverUserId" : 0,
    "CategoryId" : 3866,
    "CategorySetId" : 300100012686449,
    "VersionNumber" : "1",
    "EffectiveEndDate" : null,
    "EffectiveStartDate" : "2016-08-03",
    "IpSpecificationId" : 300100090874979,
    "ObjectVersionNumber" : 1,
    "UserSequence" : 10,
    "CharacteristicId" : 300100090874944,
    "TargetValue" : "1.00",
    "MaximumValue" : "4.00",
    "MinimumValue" : "0.00",
    "EnabledFlag" : true,
    "UOMCode" : "AEA",
    "UnitOfMeasure" : "ARU-EA",
    "CharacteristicName" : "sss",
    "CharacteristicDescription" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C620000000EACED00057708000110F07F504C6300000003414541",
      "name" : "inspectionDetails",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C620000000EACED00057708000110F07F504C6300000003414541",
      "name" : "inspectionDetails",
      "kind" : "item"
    } ]
  } ],
  "count" : 3,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inspectionDetails",
    "name" : "inspectionDetails",
    "kind" : "collection"
  } ]
}

Back to Top