1. Overview

View the details of outbound 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/OutboundIntegrationMonitoring
Schemes : HTTPS

1.3. Tags

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

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

1.4. Consumes

  • application/json

1.5. Produces

  • application/json

1.6. External Docs

2. Paths

2.1. View the EDMX document for OutboundIntegrationMonitoring Integration Objects.

GET /$metadata

2.1.1. Description

Requests for EDMX documents. The metadata is an Entity Data Model XML (EDMX) document 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 OutboundRequests.

GET /OutboundRequests

2.2.1. Description

Retrieves OutboundRequests.

2.2.2. Parameters

Type Name Description Schema

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

Retrieved entities.

400

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

401

Unauthorized exception responses.

403

Forbidden exception responses.

404

An error response that may occur when the requested property is not defined on the OutboundRequest EntityType.

2.2.4. Produces

  • application/json

2.2.5. Tags

  • Outbound Requests

2.2.6. Example HTTP response

Response 400
{
  "error" : {
    "code" : "integration_key_not_supported",
    "message" : {
      "lang" : "en",
      "value" : "Filtering by integration key is not supported. Please supply the key with the Integration Object (e.g. https://.../OutboundIntegrationMonitoring/OutboundRequests('testSapPassport'))"
    }
  }
}
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 OutboundRequest.

GET /OutboundRequests('{integrationKey}')

2.3.1. Description

Retrieves an OutboundRequest by its integrationKey.

2.3.2. Parameters

Type Name Description Schema

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 because the format of the integrationKey does not match the same format that the EntityType’s integration key format is in.

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

  • Outbound 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 [OutboundRequest] 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" : "[OutboundRequest] with integration key [someSapPassport] was not found."
    }
  }
}

2.4. View the count of all OutboundRequests.

GET /OutboundRequests/$count

2.4.1. Description

Displays the total count of all OutboundRequests.

2.4.2. Responses

HTTP Code Description Schema

200

A success response displaying the total count of OutboundRequests.

string

2.4.3. Produces

  • text/plain

2.4.4. Tags

  • Outbound Requests

3. Definitions

3.1. $inlinecount

Type : enum (allpages, none)

3.2. CollectionofOutboundRequest

Name Schema

results
optional

< OutboundRequest > array

3.3. Error

Name Schema

code
required

string

innererror
optional

string

message
required

3.4. HttpMethod

Name Description Schema

code
required

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

string

3.5. 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.6. Message

Name Schema

lang
optional

string

value
optional

string

3.7. 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 OutboundProduct, which comes from the service part of the request URI (for example, https://localhost:9002/odata2webservices/OutboundProduct/Products).
Example : "OutboundProduct"

string

3.8. OutboundRequest

Name Description Schema

destination
required

string

error
optional

string

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

source
optional

status
optional

type
required

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

string

3.9. OutboundRequest1

Name Schema

d
optional

3.10. OutboundSource

Name Description Schema

code
required

The code for outbound source. Indicates the source from where an outbound request is made. Values can be UNKNOWN, OUTBOUNDSYNC or WEBHOOKSERVICES.
Example : "UNKNOWN"

string

3.11. Wrapper

Name Schema

d
optional

3.12. errorResponseObj

Name Schema

error
optional

4. Security

4.1. auth

Type : basic