1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Maintenance
  4. Asset Diagnostic Symptoms

Get all asset diagnostic symptoms

get

/fscmRestApi/resources/11.13.18.05/assetDiagnosticSymptoms

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 asset diagnostic symptoms according to the symptom identifier.
      Finder Variables:
      • SymptomId; integer; Value that uniquely defined the symptom code.
  • 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:
    • ActiveEndDate; string; Date when the symptom becomes inactive.
    • CaptureObjectId; integer; Value that uniquely identifies the capture object (e.g. ORA_WORK_ORDER). The value is system generated and read-only.
    • CaptureObjectTypeCode; string; Code of the object to which the symptom is associated, for example, for example, ORA_WORK_ORDER.
    • CaptureObjectTypeName; string; Name of the object to which the symptom is associated, for example, Work Order.
    • Comments; string; Free text comments that describe the symptom.
    • CreatedBy; string; User who created the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.
    • CreationDate; string; Date when the diagnostic symptom is created. The application automatically sets this value during creation. This attribute is read-only.
    • DiagnosticCode; string; Abbreviation that uniquely identifies the problem diagnosis. The code is required and must be unique under the capture object.
    • DiagnosticCodeCategoryCode; string; Abbreviation that uniquely identifies the category of symptom.
    • DiagnosticCodeCategoryName; string; Name of the diagnostic code category. The name is optional.
    • DiagnosticCodeDescription; string; Description of the diagnostic code. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.
    • DiagnosticCodeId; integer; Value that uniquely identifies the diagnostic code. The value is system generated and read-only.
    • DiagnosticCodeName; string; Name of the diagnosis. The name is optional and if defined must be unique under the capture object.
    • LastUpdateDate; string; Date when the user most recently updated the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.
    • LastUpdateLogin; string; Login that the user used when updating the diagnostic symptom. The application assigns a value to this attribute during creation. This attribute is read-only.
    • LastUpdatedBy; string; User who most recently updated the diagnostic symptom. The application assigns a value to this attribute during creation. This attribute is read-only.
    • OrganizationCode; string; Abbreviation that uniquely identifies the organization to which a work order is association.
    • OrganizationId; integer; Value that uniquely identifies the organization to which a work order is association. The value is system generated and read-only.
    • SymptomId; integer; Value that uniquely identifies the symptom. The value is system generated and read-only.
    • WorkOrderDescription; string; Description of the work order to which a symptom is related.
    • WorkOrderNumber; string; Name that uniquely identifies a work order to which a symptom is related.
  • 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 : assetDiagnosticSymptoms
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetDiagnosticSymptoms-item-response
Type: object
Show Source
  • Title: Inactive Date
    Read Only: true
    Date when the symptom becomes inactive.
  • Title: Capture Object ID
    Value that uniquely identifies the capture object (e.g. ORA_WORK_ORDER). The value is system generated and read-only.
  • Title: Capture Object Type
    Maximum Length: 30
    Code of the object to which the symptom is associated, for example, for example, ORA_WORK_ORDER.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Name of the object to which the symptom is associated, for example, Work Order.
  • Title: Comments
    Maximum Length: 2000
    Free text comments that describe the symptom.
  • Read Only: true
    Maximum Length: 64
    User who created the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the diagnostic symptom is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Diagnostic Code
    Abbreviation that uniquely identifies the problem diagnosis. The code is required and must be unique under the capture object.
  • Title: Diagnostic Category Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the category of symptom.
  • Title: Diagnostic Category Name
    Name of the diagnostic code category. The name is optional.
  • Title: Description
    Read Only: true
    Maximum Length: 540
    Description of the diagnostic code. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.
  • Title: Diagnostic Code ID
    Value that uniquely identifies the diagnostic code. The value is system generated and read-only.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the diagnosis. The name is optional and if defined must be unique under the capture object.
  • Read Only: true
    Date when the user most recently updated the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the diagnostic symptom. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the diagnostic symptom. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: Organization Code
    Abbreviation that uniquely identifies the organization to which a work order is association.
  • Value that uniquely identifies the organization to which a work order is association. The value is system generated and read-only.
  • Title: Symptom ID
    Read Only: true
    Value that uniquely identifies the symptom. The value is system generated and read-only.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work order to which a symptom is related.
  • Title: Work Order Number
    Name that uniquely identifies a work order to which a symptom is related.
Back to Top

Examples

This example describes how to get all asset diagnostic symptoms.

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/assetDiagnosticSymptoms"

Example Response Body

The following shows an example of the response body in JSON format.
"{
    "items": [
        {
            "SymptomId": 300100555303607,
            "DiagnosticCodeId": 300100555299724,
            "CaptureObjectId": 300100118613665,
            "CaptureObjectType": "ORA_WORK_ORDER",
            "Comments": "Test",
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-22T12:54:17.040+00:00",
            "LastUpdateDate": "2021-11-22T12:54:17.040+00:00",
            "LastUpdateLogin": "D14D173038D4610CE053A9B1F20A40A9",
            "LastUpdatedBy": "MNT_QA",
            "ActiveEndDate": null,
            "DiagnosticCode": "DC3",
            "DiagnosticCodeCategoryName": null,
            "DiagnosticCodeDescription": "DC3",
            "DiagnosticCodeName": "DC3",
            "DiagnosticCodeCategoryCode": null,
            "OrganizationId": 300100113363336,
            "WorkOrderNumber": "0554S 250717 2243",
            "OrganizationCode": "MNTALM",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetDiagnosticSymptoms/300100555303607",
                    "name": "assetDiagnosticSymptoms",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetDiagnosticSymptoms/300100555303607",
                    "name": "assetDiagnosticSymptoms",
                    "kind": "item"
                }
            ]
        },
        {
            "SymptomId": 300100554849877,
            "DiagnosticCodeId": 300100551758857,
            "CaptureObjectId": 75469,
            "CaptureObjectType": "ORA_WORK_ORDER",
            "Comments": "Test comments",
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-22T05:06:24.462+00:00",
            "LastUpdateDate": "2021-11-22T05:06:24.463+00:00",
            "LastUpdateLogin": "D14D176A1ADF6106E053A9B1F20A2B38",
            "LastUpdatedBy": "MNT_QA",
            "ActiveEndDate": null,
            "DiagnosticCode": "DIAGNOSTIC_CODE_01",
            "DiagnosticCodeCategoryName": "Category code meaning 101",
            "DiagnosticCodeDescription": "DIAGNOSTIC_CODE_01",
            "DiagnosticCodeName": "DIAGNOSTIC_CODE_01",
            "DiagnosticCodeCategoryCode": "DEMO_CAT_CODE",
            "OrganizationId": 300100113363336,
            "WorkOrderNumber": "FL201",
            "OrganizationCode": "MNTALM",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetDiagnosticSymptoms/300100554849877",
                    "name": "assetDiagnosticSymptoms",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetDiagnosticSymptoms/300100554849877",
                    "name": "assetDiagnosticSymptoms",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetDiagnosticSymptoms",
            "name": "assetDiagnosticSymptoms",
            "kind": "collection"
        }
    ]
}"
Back to Top