Jump to

• Request
• Response
• Examples

Get one asset diagnostic symptom

get

/fscmRestApi/resources/11.13.18.05/assetDiagnosticSymptoms/{SymptomId}

Request

Path Parameters

• SymptomId(required): integer(int64)
  Value that uniquely identifies the symptom. The value is system generated and read-only.

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assetDiagnosticSymptoms-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Inactive Date

  Read Only: true

  Date when the symptom becomes inactive.
• CaptureObjectId: integer (int64)
  Title: Capture Object ID

  Value that uniquely identifies the capture object (e.g. ORA_WORK_ORDER). The value is system generated and read-only.
• CaptureObjectTypeCode: string
  Title: Capture Object Type

  Maximum Length: 30

  Code of the object to which the symptom is associated, for example, for example, ORA_WORK_ORDER.
• CaptureObjectTypeName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the object to which the symptom is associated, for example, Work Order.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  Free text comments that describe the symptom.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the diagnostic symptom is created. The application automatically sets this value during creation. This attribute is read-only.
• DiagnosticCode: string
  Title: Diagnostic Code

  Abbreviation that uniquely identifies the problem diagnosis. The code is required and must be unique under the capture object.
• DiagnosticCodeCategoryCode: string
  Title: Diagnostic Category Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the category of symptom.
• DiagnosticCodeCategoryName: string
  Title: Diagnostic Category Name

  Name of the diagnostic code category. The name is optional.
• DiagnosticCodeDescription: string
  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.
• DiagnosticCodeId: integer (int64)
  Title: Diagnostic Code ID

  Value that uniquely identifies the diagnostic code. The value is system generated and read-only.
• DiagnosticCodeName: string
  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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Title: Organization Code

  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 (int64)
  Title: Symptom ID

  Read Only: true

  Value that uniquely identifies the symptom. The value is system generated and read-only.
• WorkOrderDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work order to which a symptom is related.
• WorkOrderNumber: string
  Title: Work Order Number

  Name that uniquely identifies a work order to which a symptom is related.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the diagnostic symptom. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the diagnostic symptom is created. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work order to which a symptom is related.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaptureObjectId":{
            "title":"Capture Object ID",
            "type":"integer",
            "description":"Value that uniquely identifies the capture object (e.g. ORA_WORK_ORDER). The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DiagnosticCodeDescription":{
            "title":"Description",
            "maxLength":"540",
            "type":"string",
            "description":"Description of the diagnostic code. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiagnosticCodeCategoryCode":{
            "title":"Diagnostic Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the category of symptom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Free text comments that describe the symptom.",
            "nullable":true,
            "x-queryable":true
        },
        "DiagnosticCodeName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the diagnosis.  The name is optional and if defined must be unique under the capture object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which a work order is association. The value is system generated and read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "DiagnosticCodeId":{
            "title":"Diagnostic Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the diagnostic code. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaptureObjectTypeName":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the object to which the symptom is associated, for example, Work Order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "type":"string",
            "description":"Name that uniquely identifies a work order to which a symptom is related.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization to which a work order is association.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CaptureObjectTypeCode":{
            "title":"Capture Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the object to which the symptom is associated, for example, for example, ORA_WORK_ORDER.",
            "nullable":false,
            "x-queryable":true
        },
        "DiagnosticCode":{
            "title":"Diagnostic Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the problem diagnosis. The code is required and must be unique under the capture object.",
            "nullable":true,
            "x-queryable":true
        },
        "DiagnosticCodeCategoryName":{
            "title":"Diagnostic Category Name",
            "type":"string",
            "description":"Name of the diagnostic code category. The name is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the symptom becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SymptomId":{
            "title":"Symptom ID",
            "type":"integer",
            "description":"Value that uniquely identifies the symptom.  The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the diagnostic symptom. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

This example describes how to get one asset diagnostic symptom.

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

Example Response Body

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

"{
    "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"
        }
    ]
}"

Back to Top