Jump to

• Request
• Response
• Examples

Create recommendations

post

/fscmRestApi/resources/11.13.18.05/maintenanceRecommendations

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Abbreviation that identifies the action to be performed on the reccommendation.
• ConfidenceLevel: number
  Level of confidence for the recommendation. For example, .85 or 85%.
• CurrentValue: number
  Current value recommended for the business object. The entity attribute and their values provide this value.
• Insight: string
  Maximum Length: 2000

  Recommendation insight provided in text that describes the need for the recommendation.
• InsightObjectId: integer (int64)
  Value that identifies the insight that provides details for scoring, training, learning, and starting the recommendation.
• InsightObjectTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the insight object type.
• LearningThreadId: string
  Maximum Length: 32

  Value that identifies the reference workflow thread that provides details for scoring, training, learning, and starting the recommendation.
• LearningWorkflowId: string
  Maximum Length: 32

  Value that identifies the reference workflow that provides details for scoring, training, learning, and starting the recommendation.
• RecEntityAttrOne: string
  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.
• RecEntityAttrOneValue: integer (int64)
  First attribute in the business object that the recommendation references.
• RecEntityAttrThree: string
  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.
• RecEntityAttrThreeValue: integer (int64)
  Third attribute in the business object that the recommendation references.
• RecEntityAttrTwo: string
  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.
• RecEntityAttrTwoValue: integer (int64)
  Second attribute in the business object that the recommendation references.
• RecId: integer (int64)
  The primary key for the recommendation business object. The application creates this value. This attribute is read-only.
• RecObject: string
  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.
• RecObjectId: integer (int64)
  Value that identifies the business object that the recommendation references.
• RecommendedValue: number
  New value recommended for the business object. The entity attribute and their values provide this value.
• SourceRecId: string
  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.

{
    "type":"object",
    "properties":{
        "InsightObjectId":{
            "type":"integer",
            "description":"Value that identifies the insight that provides details for scoring, training, learning, and starting the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecEntityAttrTwoValue":{
            "type":"integer",
            "description":"Second attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InsightObjectTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the insight object type.",
            "nullable":true
        },
        "RecEntityAttrThree":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "RecEntityAttrOne":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the action to be performed on the reccommendation.",
            "nullable":true
        },
        "CurrentValue":{
            "type":"number",
            "description":"Current value recommended for the business object. The entity attribute and their values provide this value.",
            "nullable":true
        },
        "LearningThreadId":{
            "maxLength":32,
            "type":"string",
            "description":"Value that identifies the reference workflow thread that provides details for scoring, training, learning, and starting the recommendation.",
            "nullable":true
        },
        "RecommendedValue":{
            "type":"number",
            "description":"New value recommended for the business object. The entity attribute and their values provide this value.",
            "nullable":false
        },
        "RecEntityAttrTwo":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SourceRecId":{
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "LearningWorkflowId":{
            "maxLength":32,
            "type":"string",
            "description":"Value that identifies the reference workflow that provides details for scoring, training, learning, and starting the recommendation.",
            "nullable":true
        },
        "ConfidenceLevel":{
            "type":"number",
            "description":"Level of confidence for the recommendation.  For example, .85 or 85%.",
            "nullable":true
        },
        "RecEntityAttrOneValue":{
            "type":"integer",
            "description":"First attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecEntityAttrThreeValue":{
            "type":"integer",
            "description":"Third attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecId":{
            "type":"integer",
            "description":"The primary key for the recommendation business object. The application creates this value. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Insight":{
            "maxLength":2000,
            "type":"string",
            "description":"Recommendation insight provided in text that describes the need for the recommendation.",
            "nullable":true
        },
        "RecObjectId":{
            "type":"integer",
            "description":"Value that identifies the business object that the recommendation references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RecObject":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• ActionCode: string
  Maximum Length: 30

  Abbreviation that identifies the action to be performed on the reccommendation.
• ConfidenceLevel: number
  Level of confidence for the recommendation. For example, .85 or 85%.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the recommendation. The application automatically sets this value during creation. This attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  Date when the recommendation is created. The application automatically sets this value during creation. This attribute is read-only.
• CurrentValue: number
  Current value recommended for the business object. The entity attribute and their values provide this value.
• Insight: string
  Maximum Length: 2000

  Recommendation insight provided in text that describes the need for the recommendation.
• InsightObjectId: integer (int64)
  Value that identifies the insight that provides details for scoring, training, learning, and starting the recommendation.
• InsightObjectTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the insight object type.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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.
• LearningThreadId: string
  Maximum Length: 32

  Value that identifies the reference workflow thread that provides details for scoring, training, learning, and starting the recommendation.
• LearningWorkflowId: string
  Maximum Length: 32

  Value that identifies the reference workflow that provides details for scoring, training, learning, and starting the recommendation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecEntityAttrOne: string
  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.
• RecEntityAttrOneValue: integer (int64)
  First attribute in the business object that the recommendation references.
• RecEntityAttrThree: string
  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.
• RecEntityAttrThreeValue: integer (int64)
  Third attribute in the business object that the recommendation references.
• RecEntityAttrTwo: string
  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.
• RecEntityAttrTwoValue: integer (int64)
  Second attribute in the business object that the recommendation references.
• RecId: integer (int64)
  The primary key for the recommendation business object. The application creates this value. This attribute is read-only.
• RecObject: string
  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.
• RecObjectId: integer (int64)
  Value that identifies the business object that the recommendation references.
• RecommendedValue: number
  New value recommended for the business object. The entity attribute and their values provide this value.
• SourceRecId: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the recommendation 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
        },
        "RecEntityAttrThree":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the action to be performed on the reccommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentValue":{
            "type":"number",
            "description":"Current value recommended for the business object. The entity attribute and their values provide this value.",
            "nullable":true,
            "x-queryable":true
        },
        "LearningThreadId":{
            "maxLength":32,
            "type":"string",
            "description":"Value that identifies the reference workflow thread that provides details for scoring, training, learning, and starting the recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "RecEntityAttrTwo":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LearningWorkflowId":{
            "maxLength":32,
            "type":"string",
            "description":"Value that identifies the reference workflow that provides details for scoring, training, learning, and starting the recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfidenceLevel":{
            "type":"number",
            "description":"Level of confidence for the recommendation.  For example, .85 or 85%.",
            "nullable":true,
            "x-queryable":true
        },
        "RecEntityAttrThreeValue":{
            "type":"integer",
            "description":"Third attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecId":{
            "type":"integer",
            "description":"The primary key for the recommendation business object. The application creates this value. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Insight":{
            "maxLength":2000,
            "type":"string",
            "description":"Recommendation insight provided in text that describes the need for the recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the recommendation. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InsightObjectId":{
            "type":"integer",
            "description":"Value that identifies the insight that provides details for scoring, training, learning, and starting the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecEntityAttrTwoValue":{
            "type":"integer",
            "description":"Second attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the recommendation. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InsightObjectTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the insight object type.",
            "nullable":true,
            "x-queryable":true
        },
        "RecEntityAttrOne":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RecommendedValue":{
            "type":"number",
            "description":"New value recommended for the business object. The entity attribute and their values provide this value.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceRecId":{
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RecEntityAttrOneValue":{
            "type":"integer",
            "description":"First attribute in the business object that the recommendation references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecObjectId":{
            "type":"integer",
            "description":"Value that identifies the business object that the recommendation references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the recommendation. 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 recommendation. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecObject":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "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 create recommendations.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/maintenanceRecommendations"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "SourceRecId": null,
    "RecObject": "ORA_WORK_REQUIREMENT",
    "RecObjectId": 300100129335494,
    "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
}

Example Response Body

The following example includes the contents 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