RecommEngineManagement

In this document:

Schema

The considered APS type (download) looks as follows:

{
  "name": "RecommEngineManagement",
  "id": "http://www.odin.com/receng/management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/abstract/types/unlimited-resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "pullRecommEngineSalesOrders": {
      "path": "pullRecommEngineSalesOrders/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "pullRecommEngineResources": {
      "path": "pullRecommEngineResources/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION

VERB

PATH

RETURNS

Description

pullRecommEngineSalesOrders

POST

/pullRecommEngineSalesOrders/{requestId}

pullRecommEngineResources

POST

/pullRecommEngineResources/{requestId}

pullRecommEngineSalesOrders

HTTP Request

POST /aps/2/resources/{aps-id}/pullRecommEngineSalesOrders/{requestId}

Description

Parameters

PARAMETER

TYPE

DESCRIPTION

id

String

requestId

String

Returns

pullRecommEngineResources

HTTP Request

POST /aps/2/resources/{aps-id}/pullRecommEngineResources/{requestId}

Description

Parameters

PARAMETER

TYPE

DESCRIPTION

id

String

requestId

String

Returns

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.