Jump to

• Request
• Response
• Examples

Get all specifications

get

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

Request

Path Parameters

• InspectionPlanId(required): integer(int64)
  Value that uniquely identifies the inspection plan.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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: Finds specifications according to the inspection plan.
    Finder Variables:
    • SpecificationId; integer; Value that uniquely identifies the inspection specification.
• 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:
  

  • AiSuggestion; string; Indicates that the characteristic has been created from a generative AI suggestion.
  • CharacteristicId; integer; Value that uniquely identifies the inspection characteristic against which the specification is being defined.
  • CharacteristicName; string; Name of the inspection characteristic.
  • CreatedBy; string; User who created the inspection specification.
  • CreationDate; string; Date when the user created the inspection specification.
  • DefaultValueFlag; boolean; Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value is not defaulted from the target value associated to the specification line during an inspection. This attribute does not have a default value.
  • GaugeAssetGroupId; integer; Value that uniquely identifies the gauge asset group used to collect the inspection result value.
  • GaugeResourceId; integer; Value that uniquely identifies the gauge resource used to collect the inspection result value.
  • InspectionPlanId; integer; Value that uniquely identifies the inspection plan.
  • ItemTargetValue; string; Optimal value for an item.
  • LastUpdateDate; string; Date and time when the user most recently updated the inspection specification.
  • LastUpdatedBy; string; User who most recently updated the inspection specification.
  • MaximumValueDate; string; Upper limit of the acceptable date range for an inspection characteristic.
  • MaximumValueNumber; number; Upper limit of the acceptable numeric range for an inspection characteristic.
  • MinimumValueDate; string; Lower limit of the acceptable date range for an inspection characteristic.
  • MinimumValueNumber; number; Lower limit of the acceptable numeric range for an inspection characteristic.
  • OptionalFlag; boolean; Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute does not have a default value.
  • SpecificationId; integer; Value that uniquely identifies the specification for the inspection plan.
  • TargetValue; string; Target value of the inspection characteristic.
  • TargetValueDate; string; Optimal date value for the inspection characteristic.
  • UOMCode; string; Abbreviation that identifies the unit of measurement for the quantity that this event inspects.
  • UserSequence; integer; Sequence to use when associating the inspection characteristic with 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

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

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/inspectionPlans-specifications-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inspectionPlans-specifications-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : inspectionPlans-specifications-item-response

Type: object

Show Source

• AiSuggestion: string
  Maximum Length: 1

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

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

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

  Maximum Length: 64

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

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

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

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

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

  Maximum Length: 80

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

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

  Maximum Length: 64

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

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

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

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

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

  Maximum Length: 80

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

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

  Maximum Length: 80

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

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

Nested Schema : Specification Attachments in Inspection Plans

Type: array

Title: Specification Attachments in Inspection Plans

The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.

Show Source

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

{
    "title":"Specification Attachments in Inspection Plans",
    "type":"array",
    "description":"The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.",
    "items":{
        "$ref":"#/components/schemas/inspectionPlans-specifications-attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : inspectionPlans-specifications-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded 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: Yes or No. If Yes, then the attachment is shared. If No, then the attachment is 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 for the specification.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the file 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

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

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

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

  Maximum Length: 2048

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

  URL (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 user most recently updated the specification attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Login that the user used when updating the attachment for the specification.
• 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

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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 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 for the specification.",
            "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 the attachment for the specification.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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 file 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 for the specification.",
            "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: Yes or No. If Yes, then the attachment is shared. If No, then the attachment is 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":"Date when the contents in the attachment expires.",
            "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 user most recently updated the specification 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."
        }
    }
}

Back to Top

Examples

These examples describe how to get all specifications.

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

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
  "items": [{
    "SpecificationId": 300100152744369,
    "ObjectVersionNumber": 1,
    "InspectionPlanId": 300100152744368,
    "UserSequence": 10,
    "CharacteristicId": 300100151903834,
    "UOMCode": null,
    "TargetValue": "Green",
    "CreatedBy": "QUALITY_ENGINEER",
    "CreationDate": "2018-07-02T07:40:18.324+00:00",
    "LastUpdatedBy": "QUALITY_ENGINEER",
    "LastUpdateDate": "2018-07-02T07:40:18.773+00:00",
    "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB",
    "MaximumValueDate": null,
    "MinimumValueDate": null,
    "TargetValueDate": null,
    "CharacteristicName": "QIM_P1_NonItemInspChar",
    "MaximumValueNumber": null,
    "MinimumValueNumber": null,
    "TargetValueNumber": null,
    "ItemTargetValue": null,
    "links": [{
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369",
      "name": "specifications",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel": "canonical",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369",
      "name": "specifications",
      "kind": "item"
    }, {
      "rel": "parent",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368",
      "name": "inspectionPlans",
      "kind": "item"
    }, {
      "rel": "lov",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/CharacteristicValueLOV",
      "name": "CharacteristicValueLOV",
      "kind": "collection"
    }, {
      "rel": "lov",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/CharacteristicNameLOV",
      "name": "CharacteristicNameLOV",
      "kind": "collection"
    }, {
      "rel": "lov",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/UnitOfMeasureLOV",
      "name": "UnitOfMeasureLOV",
      "kind": "collection"
    }, {
      "rel": "child",
      "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/child/specificationAttachments",
      "name": "specificationAttachments",
      "kind": "collection"
    }]
  }],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [{
    "rel": "self",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications",
    "name": "specifications",
    "kind": "collection"
  }]
}

Example 2 Response Body

This example includes gauge information.

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "SpecificationId": "300100624356698",
            "InspectionPlanId": "300100624356697",
            "UserSequence": 20,
            "CharacteristicId": "300100123941131",
            "UOMCode": null,
            "TargetValue": "OK",
            "CreatedBy": "SCMOPERATIONS",
            "CreationDate": "2024-12-05T10:09:42+00:00",
            "LastUpdatedBy": "SCMOPERATIONS",
            "LastUpdateDate": "2024-12-05T10:09:42.799+00:00",
            "MaximumValueDate": null,
            "MinimumValueDate": null,
            "TargetValueDate": null,
            "CharacteristicName": "LOG-CH",
            "MaximumValueNumber": null,
            "MinimumValueNumber": null,
            "TargetValueNumber": null,
            "ItemTargetValue": null,
            "OptionalFlag": false,
            "DefaultValueFlag": false,
            "AiSuggestion": "N",
            "UOMMeaning": null,
            "SpecificationCharacteristicName": null,
            "NonItemTargetValue": null,
            "GaugeAssetGroupId": null,
            "GaugeResourceId": null,
            "GaugeAssetGroup": null,
            "GaugeResource": null,
            "@context": {
                "key": "300100624356698",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624356698",
                        "name": "specifications",
                        "kind": "item"
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624356698",
                        "name": "specifications",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697",
                        "name": "inspectionPlans",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624356698/child/attachments",
                        "name": "attachments",
                        "kind": "collection"
                    }
                ]
            }
        },
        {
            "SpecificationId": "300100624355669",
            "InspectionPlanId": "300100624356697",
            "UserSequence": 10,
            "CharacteristicId": "300100151162609",
            "UOMCode": "BX5",
            "TargetValue": null,
            "CreatedBy": "SCMOPERATIONS",
            "CreationDate": "2024-12-05T10:08:59+00:00",
            "LastUpdatedBy": "SCMOPERATIONS",
            "LastUpdateDate": "2024-12-05T10:08:59.713+00:00",
            "MaximumValueDate": null,
            "MinimumValueDate": null,
            "TargetValueDate": null,
            "CharacteristicName": "QIM-NonItemNum-5",
            "MaximumValueNumber": "18.455",
            "MinimumValueNumber": "2.660",
            "TargetValueNumber": "9.134",
            "ItemTargetValue": null,
            "OptionalFlag": false,
            "DefaultValueFlag": false,
            "AiSuggestion": "N",
            "UOMMeaning": "Box of 5",
            "SpecificationCharacteristicName": null,
            "NonItemTargetValue": null,
            "GaugeAssetGroupId": null,
            "GaugeResourceId": null,
            "GaugeAssetGroup": null,
            "GaugeResource": null,
            "@context": {
                "key": "300100624355669",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355669",
                        "name": "specifications",
                        "kind": "item"
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355669",
                        "name": "specifications",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697",
                        "name": "inspectionPlans",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications/300100624355669/child/attachments",
                        "name": "attachments",
                        "kind": "collection"
                    }
                ]
            }
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100624356697/child/specifications",
            "name": "specifications",
            "kind": "collection"
        }
    ]
}

Back to Top