Partner Manager v2 Tracking API - Anypoint Platform APIs

Overview

Statistics

11 Operations

0 Skills

B2B Category

Track and replay B2B message activity, review transmission status, and query message contents in Anypoint Partner Manager.

Servers

https://anypoint.mulesoft.com/partnermanager/tracking/api/v1
https://{region}.anypoint.mulesoft.com/partnermanager/tracking/api/v1
https://{region}.platform.mulesoft.com/partnermanager/tracking/api/v1

Authentication & Security

bearerAuth http
Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login
clientAuth oauth2
OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token
oauth_2_0 http
Authentication via oauth_2_0.

Get Organizations By Organizationid Environments By Envid Activity Transmissions getOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissions

GET

Try it out

Path Parameters

organizationId *

envId *

Query Parameters

overdue

reviewed

pageSize

ackStatus

page

replay

direction

partnerId

hostMessageFormat

searchString

status

dateReceivedFrom

hostMessageType

partnerMessageFormat

partnerMessageType

transactionId

dateReceivedTo

dateLimit

Custom Query Parameters

Custom Headers

Get all transmissions

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

overdue: string

For transmissions expecting acknowledgements, filter by their ack overdue status.

reviewed: string

Filter transmissions by their reviewed status when required.

pageSize: integer

Limit the elements to be fetched a page

default: 100

ackStatus: string

Ack Status of the transmission .

page: integer

The page to be fetched

default: 1

replay: boolean

The replay query parameter.

direction: string

Filter transmissions by specific direction. By default, both inbound and outbound transmissions are returned.

partnerId: string

Filter transmission for specific partner.

hostMessageFormat: string

Filter transmissions for a specific message format exchanged with Host's internal applications. This is required if hostMessageType is specified.

searchString: string

search string used for searching transmissions with additional parameters.

status: string

Filter transmissions by status.

dateReceivedFrom: string(date-time)

Get transmissions received after certain time.

hostMessageType: string

Filter transmissions for a specific message type in a given host message format. This is required if hostMessageFormat is specified.

partnerMessageFormat: string

Filter transmissions for a specific message format exchanged with Trading Partner. This is required if partnerMessageType is specified.

partnerMessageType: string

Filter transmissions for a specific message type in a given partner message format. This is required if partnerMessageFormat is specified.

transactionId: string

The transaction ID query parameter.

dateReceivedTo: string(date-time)

Get transmissions received until certain time.

dateLimit: string(date-time)

Get transmissions up to this limit.

Response

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Envid Activity Transmissions Replay createOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsReplay

POST

Try it out

Path Parameters

organizationId *

envId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new replay

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

json

items: array

Array items

Response

Resource created successfully.

Examples

application/json

{ "entityCreatedResponseList": [ { "id": "fe6fc070-9f9a-49d9-b609-a454c54d316f", "message": "ACCEPTED" }, { "id": "34fb099e-83d2-4f42-a1f0-acb4aab89191", "message": "NOT_ACCEPTED" } ] }

Bad request. The request was malformed or contains invalid parameters.

Examples

application/json

{ "message": "Operation completed successfully." }

Internal server error.

Examples

application/json

{ "message": "Operation completed successfully." }

Get Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid getOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionid

GET

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

Custom Query Parameters

Custom Headers

Get all transmissions

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

Response

Successful operation.

Examples

application/json

{}

Get Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid Reviews getOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionidReviews

GET

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

Query Parameters

page

pageSize

Custom Query Parameters

Custom Headers

Get the review
with id =
{reviewId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

Query Parameters

page: integer

The page to be fetched

default: 1

pageSize: integer

Limit the elements to be fetched a page

default: 100

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid Reviews createOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionidReviews

POST

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new review

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

Request Body

json

comment *: string

reviewType *: string

reviewName *: string

id *: string

reviewedBy *: string

reviewedAt *: string

Response

Resource created successfully.

Examples

application/json

{ "entityCreatedResponse": { "id": "fe6fc070-9f9a-49d9-b609-a454c54d316f", "message": "ACCEPTED" } }

Bad request. The request was malformed or contains invalid parameters.

Examples

application/json

{ "message": "Your request does not have the correct values" }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Update Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid Reviews By Reviewid updateOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionidReviewsByReviewid

PUT

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

reviewId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replace review

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

reviewId *: string

The review ID to identify the target resource.

Request Body

json

comment *: string

reviewType *: string

reviewName *: string

id *: string

reviewedBy *: string

reviewedAt *: string

Response

Operation completed successfully with no content returned.

Examples

application/json

{ "message": "Operation completed successfully." }

Bad Request.

Examples

application/json

{ "message": "Your request does not have the correct values" }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid Summaries getOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionidSummaries

GET

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

Query Parameters

page

pageSize

Custom Query Parameters

Custom Headers

Get all summaries

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

Query Parameters

page: integer

The page to be fetched

default: 1

pageSize: integer

Limit the elements to be fetched a page

default: 100

Response

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Envid Activity Transmissions By Transmissionid Replays createOrganizationsByOrganizationidEnvironmentsByEnvidActivityTransmissionsByTransmissionidReplays

POST

Try it out

Path Parameters

organizationId *

envId *

transmissionId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new replay

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

transmissionId *: string

The transmission ID to identify the target resource.

Request Body

json

createdBy *: string

createdAt *: string(date-time)

id: string

updatedBy *: string

updatedAt *: string(date-time)

environmentId *: string

deletedAt *: string(date-time)

replayedTransmissionId: string

organizationId *: string

status: string

originalTransmissionId *: string

Response

Resource created successfully.

Examples

application/json

{ "entityCreatedResponse": { "id": "fe6fc070-9f9a-49d9-b609-a454c54d316f", "message": "ACCEPTED" } }

Bad request. The request was malformed or contains invalid parameters.

Examples

application/json

{ "message": "Your request does not have the correct values" }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Environments By Envid Activity Messages getOrganizationsByOrganizationidEnvironmentsByEnvidActivityMessages

GET

Try it out

Path Parameters

organizationId *

envId *

Query Parameters

overdue

reviewed

pageSize

customAttributeValue1

ackStatus

page

customAttributeId1

direction

partnerId

hostMessageFormat

searchString

status

dateReceivedFrom

expandCustomAttributes

hostMessageType

partnerMessageFormat

partnerMessageType

transactionId

dateReceivedTo

dateLimit

Custom Query Parameters

Custom Headers

Get all messages

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

overdue: string

For messages expecting acknowledgements, filter by their ack overdue status.

reviewed: string

Filter messages by their reviewed status when required.

pageSize: integer

Limit the elements to be fetched a page

default: 100

customAttributeValue1: string

The customAttributeValue1 query parameter.

ackStatus: string

Ack Status of the transmission

page: integer

The page to be fetched

default: 1

customAttributeId1: string

The customAttribute ID1 query parameter.

direction: string

Filter messages by specific direction. By default, both inbound and outbound transmissions are returned.

partnerId: string

Filter messages for specific partner.

hostMessageFormat: string

Filter messages for a specific message format exchanged with Host's internal applications.

searchString: string

Search string used for searching transmissions with additional parameters.

status: string

Filter messages by status

dateReceivedFrom: string(date-time)

Get messages received after certain time.

expandCustomAttributes: boolean

Show custom attributes from the message.

hostMessageType: string

Filter messages for a specific message type in a given host message format.

partnerMessageFormat: string

Filter messages for a specific message format exchanged with Trading Partner.

partnerMessageType: string

Filter messages for a specific message type in a given partner message format.

transactionId: string

The transaction ID query parameter.

dateReceivedTo: string(date-time)

Get messages received until certain time.

dateLimit: string(date-time)

Get messages up to this limit.

Response

Successful operation.

Examples

application/json

{}

Get Organizations By Organizationid Environments By Envid Activity Messages By Messageid getOrganizationsByOrganizationidEnvironmentsByEnvidActivityMessagesByMessageid

GET

Try it out

Path Parameters

organizationId *

envId *

messageId *

Custom Query Parameters

Custom Headers

Get the message
with id =
{messageId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

messageId *: string

The message ID to identify the target resource.

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Environments By Envid Contents By Contentid getOrganizationsByOrganizationidEnvironmentsByEnvidContentsByContentid

GET

Try it out

Path Parameters

organizationId *

envId *

contentId *

Custom Query Parameters

Custom Headers

Retrieves a contents.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The env ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

contentId *: string

The content ID to identify the target resource.

Response

Successful operation.

Examples

plain/text

{ "message": "Operation completed successfully." }