Get all inspection characteristics
get
/fscmRestApi/resources/11.13.18.05/inspectionCharacteristics
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 Finds the characteristic that matches the primary key criteria specified.
Finder Variables- CharacteristicId; integer; Value that uniquely identifies an inspection characteristic.
- inspectionCharacteristicFinder Finds the characteristics that match the criteria specified.
Finder Variables- CharacteristicTypeCode; string; Characteristic type code of an inspection characteristic.
- CharacteristicTypeMeaning; string; Characteristic type meaning of inspection characteristic.
- DataTypeCode; string; Data type code of the inspection characteristic.
- DataTypeMeaning; string; Data type meaning of the inspection characteristic.
- EnabledFlag; string; Indicates whether inspection characteristic is enabled or disabled.
- Name; string; Name; string; of the inspection characteristic.
- PrimaryKey Finds the characteristic that matches the primary key criteria specified.
-
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 characteristic.
- CharacteristicTypeCode; string; Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM.
- CharacteristicTypeMeaning; string; Type of the characteristic. Options are Item and Nonitem.
- CreatedBy; string; User who created the characteristic.
- CreationDate; string; Date and time when the characteristic was created.
- DataTypeCode; string; Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE.
- DataTypeMeaning; string; Display value for the characteristic data type code. The accepted values are Character, Number, and Date.
- DecimalPrecision; integer; Decimal precision of the numeric value of the characteristic.
- Description; string; Translatable description of characteristic.
- EnabledFlag; boolean; Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes.
- ItemClassId; integer; Value that uniquely identifies the surrogate reference of the item class.
- LastUpdateDate; string; Date and time when the user last updated the characteristic.
- LastUpdatedBy; string; User who last updated the characteristic.
- MaximumAttributeReference; string; Reference attribute that will be used to derive the maximum value
- MaximumValueDate; string; Upper limit of the acceptable date range for an inspection characteristic.
- MinimumAttributeReference; string; Reference attribute that will be used to derive the minimum value.
- MinimumValueDate; string; Lower limit of the acceptable date range for an inspection characteristic.
- Name; string; Translatable name of characteristic.
- TargetAttributeReference; string; Reference attribute that will be used to derive the target value.
- TargetValueCharacter; string; Target value defined for the nonitem characteristic with data type as character.
- TargetValueDate; string; Optimal date value for the inspection characteristic.
- UOMCode; string; Code that identifies the unit of measure for the value of the characteristic.
- UnitOfMeasure; string; Unit of measure name associated with the characteristic.
- ValueSetCode; string; Code that identifies the value set associated with the characteristic.
- ValueSetId; integer; Value that uniquely identifies the value set which controls the list of values for the characteristic.
-
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 TopResponse
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.
Root Schema : inspectionCharacteristics
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionCharacteristics-item-response
Type:
Show Source
object
-
AiSuggestion: string
Maximum Length:
1
Indicates that the characteristic has been created from a generative AI suggestion. -
CharacteristicId: integer
(int64)
Value that uniquely identifies the characteristic.
-
CharacteristicTypeCode: string
Maximum Length:
30
Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM. -
CharacteristicTypeMeaning: string
Maximum Length:
80
Type of the characteristic. Options are Item and Nonitem. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the characteristic. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the characteristic was created. -
DataTypeCode: string
Maximum Length:
30
Code that identifies the characteristic data type. The accepted values are CHARACTER, NUMBER, and DATE. -
DataTypeMeaning: string
Maximum Length:
80
Display value for the characteristic data type code. The accepted values are Character, Number, and Date. -
DecimalPrecision: integer
(int32)
Default Value:
0
Decimal precision of the numeric value of the characteristic. -
Description: string
Maximum Length:
240
Translatable description of characteristic. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:true
Contains one of the following values: Yes or No. If Yes, then characteristic is enabled. If No, then characteristic isn't enabled. The default value is Yes. -
inspectionCharacteristicAttachments: array
Characteristic Attachments
Title:
Characteristic Attachments
The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments. -
inspectionCharacteristicGroupAssociations: array
Characteristic Group Associations
Title:
Characteristic Group Associations
The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations. -
inspectionCharacteristicValues: array
Characteristic Values
Title:
Characteristic Values
The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values. -
ItemClassId: integer
(int64)
Value that uniquely identifies the surrogate reference of the item class.
-
ItemClassName: string
Maximum Length:
250
Identifies the item class name associated with an item characteristic. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user last updated the characteristic. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the characteristic. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAttributeReference: string
Reference attribute that will be used to derive the maximum value
-
MaximumValueDate: string
(date-time)
Title:
Maximum Value
Upper limit of the acceptable date range for an inspection characteristic. -
MaximumValueNumber: number
Maximum value defined for the nonitem characteristic with data type as number.
-
MinimumAttributeReference: string
Reference attribute that will be used to derive the minimum value.
-
MinimumValueDate: string
(date-time)
Title:
Minimum Value
Lower limit of the acceptable date range for an inspection characteristic. -
MinimumValueNumber: number
Minimum value defined for the nonitem characteristic with data type as number.
-
Name: string
Title:
Name
Maximum Length:80
Translatable name of characteristic. -
TargetAttributeReference: string
Reference attribute that will be used to derive the target value.
-
TargetValueCharacter: string
Maximum Length:
30
Target value defined for the nonitem characteristic with data type as character. -
TargetValueDate: string
(date-time)
Title:
Target
Optimal date value for the inspection characteristic. -
TargetValueNumber: number
Target value defined for the nonitem characteristic with data type as number.
-
UnitOfMeasure: string
Maximum Length:
25
Unit of measure name associated with the characteristic. -
UOMCode: string
Maximum Length:
3
Code that identifies the unit of measure for the value of the characteristic. -
ValueSetCode: string
Maximum Length:
60
Code that identifies the value set associated with the characteristic. -
ValueSetId: integer
(int64)
Value that uniquely identifies the value set which controls the list of values for the characteristic.
Nested Schema : Characteristic Attachments
Type:
array
Title:
Characteristic Attachments
The Characteristic Attachments resource is used to view, create, delete or modify inspection characteristic attachments.
Show Source
Nested Schema : Characteristic Group Associations
Type:
array
Title:
Characteristic Group Associations
The Characteristic Group Associations resource is used to view, create, delete or modify inspection characteristic group associations.
Show Source
Nested Schema : Characteristic Values
Type:
array
Title:
Characteristic Values
The Characteristic Values resource is used to view, create, delete or modify inspection characteristic values.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionCharacteristics-inspectionCharacteristicAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. System-generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique ID of the uploaded file attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the uploaded file attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The Base64-encoded image of the file displayed in PNG format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response
Type:
Show Source
object
-
CharacteristicId: integer
(int64)
Value that uniquely identifies the associated characteristic.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the characteristic group association. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the characteristic group association was created. -
Description: string
Title:
Description
Maximum Length:240
Translatable description of characteristic group. -
GroupAssociationId: integer
(int64)
Value that uniquely identifies the characteristic group association.
-
GroupId: integer
(int64)
Value that uniquely identifies the characteristic group.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the characteristic group association was last updated by the user. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who most recently updated the characteristic group association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:80
Translatable name of characteristic group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionCharacteristics-inspectionCharacteristicValues-item-response
Type:
Show Source
object
-
CharacteristicId: integer
(int64)
Value that uniquely identifies the characteristic.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the characteristic value. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the characteristic value was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user last updated the characteristic value. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the characteristic value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
80
Translatable name of the characteristic value. -
ValueId: integer
(int64)
Value that uniquely identifies the characteristic value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all inspection characteristics.
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/inspectionCharacteristics"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "CharacteristicId": 300100111990747, "Name": "QIM_BAT_NonItemInspChar", "Description": "QIM_BAT_NonItemInspChar", "CharacteristicTypeCode": "NON_ITEM", "CharacteristicTypeMeaning": "Non-item", "DataTypeCode": "NUMBER", "DataTypeMeaning": "Number", "TargetValueCharacter": null, "UOMCode": "EA", "UnitOfMeasure": "EA", "DecimalPrecision": 6, "TargetValueNumber": 0.358001, "MinimumValueNumber": 0.320003, "MaximumValueNumber": 0.456786, "MinimumValueDate": null, "TargetValueDate": null, "MaximumValueDate": null, "ItemClassId": null, "ItemClassName": null, "TargetAttributeReference": null, "MaximumAttributeReference": null, "MinimumAttributeReference": null, "EnabledFlag": true, "ValueSetId": null, "ValueSetCode": null, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2017-07-21T11:21:52+00:00", "LastUpdateDate": "2022-06-09T09:16:52.904+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100111990747", "name": "inspectionCharacteristics", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100111990747", "name": "inspectionCharacteristics", "kind": "item" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100111990747/child/inspectionCharacteristicAttachments", "name": "inspectionCharacteristicAttachments", "kind": "collection" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100111990747/child/inspectionCharacteristicGroupAssociations", "name": "inspectionCharacteristicGroupAssociations", "kind": "collection" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100111990747/child/inspectionCharacteristicValues", "name": "inspectionCharacteristicValues", "kind": "collection" } ] }, { "CharacteristicId": 300100122347610, "Name": "QIM_BAT_NonValItemInspChar", "Description": "Character Type Non-Validated Non-Item Inspection Characteristic without a value set or target", "CharacteristicTypeCode": "NON_ITEM", "CharacteristicTypeMeaning": "Non-item", "DataTypeCode": "CHARACTER", "DataTypeMeaning": "Character", "TargetValueCharacter": null, "UOMCode": null, "UnitOfMeasure": null, "DecimalPrecision": 0, "TargetValueNumber": null, "MinimumValueNumber": null, "MaximumValueNumber": null, "MinimumValueDate": null, "TargetValueDate": null, "MaximumValueDate": null, "ItemClassId": null, "ItemClassName": null, "TargetAttributeReference": null, "MaximumAttributeReference": null, "MinimumAttributeReference": null, "EnabledFlag": true, "ValueSetId": null, "ValueSetCode": null, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2017-07-27T19:20:41.412+00:00", "LastUpdateDate": "2022-06-09T09:16:53.009+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100122347610", "name": "inspectionCharacteristics", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100122347610", "name": "inspectionCharacteristics", "kind": "item" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100122347610/child/inspectionCharacteristicAttachments", "name": "inspectionCharacteristicAttachments", "kind": "collection" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100122347610/child/inspectionCharacteristicGroupAssociations", "name": "inspectionCharacteristicGroupAssociations", "kind": "collection" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100122347610/child/inspectionCharacteristicValues", "name": "inspectionCharacteristicValues", "kind": "collection" } ] }], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics", "name": "inspectionCharacteristics", "kind": "collection" } ] }