1. Overview

View the details of inbound requests and any errors in Backoffice. For more information, see Integration API Request Monitoring

1.1. Version information

Version : 1.0.0

1.2. URI scheme

Host : localhost:9002
BasePath : /odata2webservices/InboundIntegrationMonitoring
Schemes : HTTPS

1.3. Tags

  • Inbound Requests : Requests for information about Inbound Requests that exist in the system. Inbound Requests are monitoring records that capture information about Integration API requests sent to the SAP Commerce Cloud.

  • Metadata : Requests for EDMX documents. The metadata is an Entity Data Model XML (EDMX) document that describes the entity types and their properties.

1.4. Consumes

  • application/json

1.5. Produces

  • application/json

1.6. External Docs

2. Paths

2.1. View the EDMX document for InboundIntegrationMonitoring Integration Objects

GET /$metadata

2.1.1. Description

Requests for the metadata which is an Entity Data Model XML (EDMX) schema that describes the entity types and their properties.

2.1.2. Responses

HTTP Code Description Schema

200

A valid EDMX schema.

No Content

401

Unauthorized exception responses

403

Forbidden exception responses

2.1.3. Produces

  • application/xml

2.1.4. Tags

  • Metadata

2.2. View InboundRequests.

GET /InboundRequests

2.2.1. Description

Retrieves InboundRequests

2.2.2. Parameters

Type Name Description Schema

Header

Accept-Language
optional

Accept-Language header specifying the language localized data will be returned in.

string

Query

$expand
optional

Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See $expand

string

Query

$filter
optional

A predicate expression for selecting a subset of the items identified by the resource path. See $filter

string

Query

$inlinecount
optional

Specifies if the total number of items should be included in the response. See $inlinecount

enum (allpages, none)

Query

$skip
optional

The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See $skip

integer (int32)

Query

$top
optional

The maximum number of items to return. If it’s greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it’s less than the number of matching items in the platform, a subset containing top number of items will be returned. See $top

integer (int32)

2.2.3. Responses

HTTP Code Description Schema

200

A collection of 0 or more InboundRequests.

400

Error responses that may occur due to an exception related to the filter query parameter or misconfigured metadata.

401

Unauthorized exception responses

403

Forbidden exception responses

404

Not Found exception responses for GET operations.

2.2.4. Produces

  • application/json

2.2.5. Tags

  • Inbound Requests

2.2.6. Example HTTP response

Response 400
{
  "error" : {
    "code" : "filter_not_supported",
    "message" : {
      "lang" : "en",
      "value" : "Nested filter [inboundRequest/user] of more than one level is not supported."
    }
  }
}
Response 401
{
  "error" : {
    "code" : "unauthorized",
    "message" : {
      "lang" : "en",
      "value" : "user must be authenticated"
    }
  }
}
Response 403
{
  "error" : {
    "code" : "forbidden",
    "message" : {
      "lang" : "en",
      "value" : "user is not authorized for the operation"
    }
  }
}
Response 404
{
  "error" : {
    "code" : "null",
    "message" : {
      "lang" : "en",
      "value" : "Could not find property with name: 'nonExistingItemAttributeName'."
    }
  }
}

2.3. View an individual InboundRequest.

GET /InboundRequests('{integrationKey}')

2.3.1. Description

Retrieves an InboundRequest by its integrationKey.

2.3.2. Parameters

Type Name Description Schema

Header

Accept-Language
optional

Accept-Language header specifying the language localized data will be returned in.

string

Path

integrationKey
required

key: integrationKey

string

Query

$expand
optional

Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See $expand

string

2.3.3. Responses

HTTP Code Description Schema

200

Retrieved entity

400

An error occurred due to an invalid integrationKey found in the url because one or more Integration Objects have been misconfigured.

401

Unauthorized exception responses

403

Forbidden exception responses

404

Not Found exception responses for GET operations.

2.3.4. Produces

  • application/json

2.3.5. Tags

  • Inbound Requests

2.3.6. Example HTTP response

Response 400
{
  "error" : {
    "code" : "invalid_key",
    "message" : {
      "lang" : "en",
      "value" : "The integration key [0215Cssss%7C] is invalid. Please consult the IntegrationKey definition of [InboundRequest] for configuration details."
    }
  }
}
Response 401
{
  "error" : {
    "code" : "unauthorized",
    "message" : {
      "lang" : "en",
      "value" : "user must be authenticated"
    }
  }
}
Response 403
{
  "error" : {
    "code" : "forbidden",
    "message" : {
      "lang" : "en",
      "value" : "user is not authorized for the operation"
    }
  }
}
Response 404
{
  "error" : {
    "code" : "not_found",
    "message" : {
      "lang" : "en",
      "value" : "[InboundRequest] with integration key [1576006021554%7C%7CStaged%257CDefault%257Cprod1] was not found."
    }
  }
}

2.4. View the count of all InboundRequests.

GET /InboundRequests/$count

2.4.1. Description

Displays the total count of all InboundRequests.

2.4.2. Responses

HTTP Code Description Schema

200

A success response displaying the total count of InboundRequests.

string

2.4.3. Produces

  • text/plain

2.4.4. Tags

  • Inbound Requests

3. Definitions

3.1. $inlinecount

Type : enum (allpages, none)

3.2. Code

The code for http method. Indicates the http method for the request made. Values can be POST, DELETE or PATCH.

Type : enum (POST, DELETE, PATCH)

3.3. CollectionofInboundRequests

Name Schema

results
optional

< InboundRequest > array

3.4. Error

Name Schema

code
required

string

innererror
optional

string

message
required

3.5. HttpMethod

Name Schema

code
required

3.6. InboundRequest

Name Description Schema

creationtime
optional

string

errors
optional

httpMethod
optional

messageId
optional

The messageId provided in the request header. The messageId allows the user to trace the Monitored Request back to the original request.
Example : "requestHeaderId"

string

requestIntegrationKey
optional

Derived from the payload. For more information, see The EDMX Key Value
Example : "requestCode"

string

sapPassport
optional

The value of the SAP-PASSPORT header, when provided with the request.
Example : "sapPassportValue"

string

status
optional

type
required

Set to the Integration Object type, for example InboundProduct, which comes from the service part of the request URI (for example, https://localhost:9002/odata2webservices/InboundProduct/Products).
Example : "InboundProduct"

string

user
optional

3.7. InboundRequestError

Name Schema

code
required

string

creationtime
optional

string

inboundRequest
optional

message
required

string

3.8. InboundUser

Name Schema

name
optional

string

uid
required

string

3.9. IntegrationRequestStatus

Name Description Schema

code
required

The code for the integration request status. Values can be SUCCESS or ERROR. SUCCESS means that the Integration Object persisted successfully. Otherwise, the status is set to ERROR.
Example : "SUCCESS"

string

3.10. Message

Name Schema

lang
optional

string

value
optional

string

3.11. MonitoredRequest

Name Description Schema

messageId
optional

The messageId provided in the request header. The messageId allows the user to trace the Monitored Request back to the original request.
Example : "requestHeaderId"

string

requestIntegrationKey
optional

Derived from the payload. For more information, see The EDMX Key Value
Example : "requestCode"

string

sapPassport
optional

The value of the SAP-PASSPORT header, when provided with the request.
Example : "sapPassportValue"

string

status
optional

type
required

Set to the Integration Object type, for example InboundProduct, which comes from the service part of the request URI (for example, https://localhost:9002/odata2webservices/InboundProduct/Products).
Example : "InboundProduct"

string

3.12. Wrapper

Name Schema

d
optional

3.13. Wrapper1

Name Schema

d
optional

3.14. errorResponseObj

Name Schema

error
optional

4. Security

4.1. auth

Type : basic