Get all inspection characteristics

get

/fscmRestApi/resources/11.13.18.05/inspectionCharacteristics

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : inspectionCharacteristics
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inspectionCharacteristics-item-response
Type: object
Show Source
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 : inspectionCharacteristics-inspectionCharacteristicAttachments-item-response
Type: object
Show Source
Nested Schema : inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response
Type: object
Show Source
Nested Schema : inspectionCharacteristics-inspectionCharacteristicValues-item-response
Type: object
Show Source
Back to Top

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"
        }
    ]
}
Back to Top