1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Maintenance Recommendations

Get one recommendation

get

/fscmRestApi/resources/11.13.18.05/maintenanceRecommendations/{RecId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : maintenanceRecommendations-item-response
Type: object
Show Source
  • Maximum Length: 30
    Abbreviation that identifies the action to be performed on the reccommendation.
  • Level of confidence for the recommendation. For example, .85 or 85%.
  • Read Only: true
    Maximum Length: 64
    User who created the recommendation. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the recommendation is created. The application automatically sets this value during creation. This attribute is read-only.
  • Current value recommended for the business object. The entity attribute and their values provide this value.
  • Maximum Length: 2000
    Recommendation insight provided in text that describes the need for the recommendation.
  • Value that identifies the insight that provides details for scoring, training, learning, and starting the recommendation.
  • Maximum Length: 30
    Abbreviation that identifies the insight object type.
  • Read Only: true
    Date when the user most recently updated the recommendation. 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 recommendation. 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 recommendation. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Maximum Length: 32
    Value that identifies the reference workflow thread that provides details for scoring, training, learning, and starting the recommendation.
  • Maximum Length: 32
    Value that identifies the reference workflow that provides details for scoring, training, learning, and starting the recommendation.
  • Links
  • Maximum Length: 30
    First attribute in the business object that the recommendation references. The application uses this attribute when it requires more than two attributes to identify the record in the entity.
  • First attribute in the business object that the recommendation references.
  • Maximum Length: 30
    Third attribute in the business object that the recommendation references. The application uses this attribute when it requires more than two attributes to identify the record in the entity.
  • Third attribute in the business object that the recommendation references.
  • Maximum Length: 30
    Second attribute in the business object that the recommendation references. The application uses this attribute when it requires more than two attributes to identify the record in the entity.
  • Second attribute in the business object that the recommendation references.
  • The primary key for the recommendation business object. The application creates this value. This attribute is read-only.
  • Maximum Length: 30
    Business object that the recommendation references. A lookup provides the value you can use, such as ORA_WORK_REQUIREMENT, ORA_WORK_ORDER, and so on.
  • Value that identifies the business object that the recommendation references.
  • New value recommended for the business object. The entity attribute and their values provide this value.
  • Maximum Length: 32
    Value that identifies the recommendation from the application that started the recommendation. The REST resource persists this value so the learning application can use it throughout the maintenance activity.
Back to Top

Examples

This example describes how to get one recommendation.

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/maintenanceRecommendations/RecId"

For example, the following command gets one recommendation where the recommendation identifier is 300100154622389:

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenanceRecommendations/300100154622389"

Example Response Body

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

{
    "RecId": 300100154622389,
    "SourceRecId": null,
    "RecObjectId": 300100129335494,
    "RecObject": "ORA_WORK_REQUIREMENT",
    "RecEntityAttrOne": "ORA_METER_INTERVAL",
    "RecEntityAttrOneValue": 300100129335496,
    "RecEntityAttrTwo": null,
    "RecEntityAttrTwoValue": null,
    "RecEntityAttrThree": null,
    "RecEntityAttrThreeValue": null,
    "ConfidenceLevel": 0.93,
    "RecommendedValue": 5,
    "CurrentValue": 10,
    "Insight": "Extremely low failures",
    "InsightObjectId": null,
    "LearningThreadId": null,
    "LearningWorkflowId": null,
    "InsightObjectTypeCode": null
}
Back to Top