Partner Manager Partners API

Get Organizations By Organizationid Environments By Environmentid Apmrelease getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApmrelease

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get apmRelease

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Certificates getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCertificates

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Query Parameters

as2Only

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get Details of all the certificates saved in the environment

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

as2Only: string

The as2Only query parameter.

default: false

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Customattributes getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributes

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all customAttributes

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Customattributes createOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributes

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new customAttribute

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Customattributes By Customattributeid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

customAttributeId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get customAttributes

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

customAttributeId *: string

The customAttribute ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Patch Organizations By Organizationid Environments By Environmentid Customattributes By Customattributeid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid

PATCH

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

customAttributeId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Patches customAttribute

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

customAttributeId *: string

The customAttribute ID to identify the target resource.

Request Body

json

Response

200

200 204 400 404 500

Successful operation.

Examples

application/json

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

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Customattributes By Customattributeid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

customAttributeId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete customAttribute

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

customAttributeId *: string

The customAttribute ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Deployments getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Query Parameters

formatVersion

receivingEndpointId

toPartner

excludeSchemasAndMappings

formatType

status ACTIVE INACTIVE DRAFT

excludeAuditHistory

fromPartner

docType

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get Deployment configurations

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

formatVersion: string

The formatVersion query parameter.

receivingEndpointId: string

The receivingEndpoint ID query parameter.

toPartner: string

The toPartner query parameter.

excludeSchemasAndMappings: boolean

The excludeSchemasAndMappings query parameter.

formatType: string

The formatType query parameter.

status: string

The status query parameter.

default: ACTIVE

excludeAuditHistory: boolean

The excludeAuditHistory query parameter.

fromPartner: string

The fromPartner query parameter.

docType: string

The docType query parameter.

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Deployments createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Creates new Deployment config

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

202

202

json

Request accepted for processing.

id *: string

message: string

Examples

application/json

{ "id": "f4ace7b9-6da1-4322-8852-823532633c18", "message": "" }

Get Organizations By Organizationid Environments By Environmentid Deployments By Deploymentid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeploymentsByDeploymentid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

deploymentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get specific deployment details using deploymentId

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Patch Organizations By Organizationid Environments By Environmentid Deployments By Deploymentid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeploymentsByDeploymentid

PATCH

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

deploymentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Update deployment details

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id

Request Body

json

Response

200

200 204 400 404 500

Successful operation.

Examples

application/json

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

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Documentflows getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Query Parameters

name

pageSize

description

page

searchString

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all documents

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

name: string

The name query parameter.

pageSize: integer

Limit the elements to be fetched a page

default: 100

description: string

The description query parameter.

page: integer

The page to be fetched

default: 1

searchString: string

The searchString query parameter.

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Documentflows createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new documentflow

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Documentflows By Documentflowid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get documentflows

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Patch Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid

PATCH

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Post APM release 2.21.0, Message flows can be created with or without identifier based routing.
Example DocumentFlowWithGranularRouting depicts flow with identifier based routing where an identifier from host and another identifier from partner profile is provided for message routing.
Example DocumentFlowWithOutGranularRouting depicts flow without identifier based routing, that flow accepts any of the configured identifiers for message flow routing.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Request Body

json

Response

200

200 204 400 404 500

Successful operation.

Examples

application/json

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

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete documentflow

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid Mappings getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappings

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all mappings

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid Mappings createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappings

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new mapping

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Documentflows By Documentflowid Mappings By Mappingsid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappingsByMappingsid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

mappingsId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get mappings

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

mappingsId *: string

The mappings ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid Mappings By Mappingsid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappingsByMappingsid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

mappingsId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace mapping

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

mappingsId *: string

The mappings ID to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid Resolvedview getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidResolvedview

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all resolvedview

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Documentflows By Documentflowid Runtimevalidations getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidRuntimevalidations

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

documentflowId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all runtimeValidations

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

documentflowId *: string

The documentflow ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Documentflows Summarylist getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsSummarylist

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all summarylist

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Ediformats getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformats

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all ediFormats

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Ediformats By Format getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormat

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

format * X12 EDIFACT JSON CSV XML

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get ediFormats

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

format *: string

The format to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Ediformats By Format Ediformatversions getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversions

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

format * X12 EDIFACT JSON CSV XML

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all ediFormatVersions

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

format *: string

The format to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Ediformats By Format Ediformatversions By Versionid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversionsByVersionid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

format * X12 EDIFACT JSON CSV XML

versionId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get ediFormatVersions

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

format *: string

The format to identify the target resource.

versionId *: string

The version ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversions.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Ediformats By Format Ediformatversions By Versionid Edidocumenttypes getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversionsByVersionidEdidocumenttypes

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

format * X12 EDIFACT JSON CSV XML

versionId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all ediDocumentTypes

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

format *: string

The format to identify the target resource.

versionId *: string

The version ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversions.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Endpoints getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpoints

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Query Parameters

role RECEIVE SEND RECEIVE_ACK PRE_API POST_API STORAGE_API

deploymentId

deploymentStatus ACTIVE INACTIVE

partnerId

typeId

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get endpoints

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

role: string

The role query parameter.

deploymentId: string

The deployment ID query parameter.

deploymentStatus: string

The deploymentStatus query parameter.

partnerId: string

The partner ID query parameter.

typeId: string

The type ID query parameter.

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Endpoints createOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpoints

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new endpoint

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Endpoints By Endpointid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

endpointId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get endpoints

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

endpointId *: string

The endpoint ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Endpoints By Endpointid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

endpointId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace endpoint

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

endpointId *: string

The endpoint ID to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Endpoints By Endpointid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

endpointId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete endpoint

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

endpointId *: string

The endpoint ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Endpointtypes By Type Configurations getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointtypesByTypeConfigurations

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

type *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all configurations

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

type *: string

The type to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Identifiertypes getOrganizationsByOrganizationidEnvironmentsByEnvironmentidIdentifiertypes

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all identifierTypes

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Identifiertypes By Identifiertypeid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidIdentifiertypesByIdentifiertypeid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

identifierTypeId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get identifierTypes

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

identifierTypeId *: string

The identifierType ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all partners

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new partner

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get partners

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace partner

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete partner

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Addresses getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddresses

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all addresses

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Addresses createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddresses

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new address

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Addresses By Addressid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

addressId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get addresses

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

addressId *: string

The address ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Addresses By Addressid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

addressId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace address

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

addressId *: string

The address ID to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid Addresses By Addressid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

addressId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete address

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

addressId *: string

The address ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Certificates getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificates

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get Details of all the certificates saved in the environment for particular partner

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Certificates createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificates

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body multipart/form-data

Response

Body Headers

Create a new Certificate

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

multipart/form-data

certType *: string

certName *: string

certFile *: string(binary)

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Certificates By Certificateid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

certificateId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get certificates

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

certificateId *: string

The certificate ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Certificates By Certificateid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

certificateId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace certificate

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

certificateId *: string

The certificate ID to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid Certificates By Certificateid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

certificateId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete certificate

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

certificateId *: string

The certificate ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Documents getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocuments

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all documents

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Documents createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocuments

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new document

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Documents By Documentbyid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

documentById *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get documents

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

documentById *: string

The documentBy ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Documents By Documentbyid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

documentById *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace document

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

documentById *: string

The documentBy ID to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid Documents By Documentbyid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

documentById *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete document

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

documentById *: string

The documentBy ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Ediformats By Format Configurations getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurations

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

format *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all configurations

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

format *: string

The format to identify the target resource.

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Ediformats By Format Configurations createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurations

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

format *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new configuration

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

format *: string

The format to identify the target resource.

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Ediformats By Format Configurations By Configid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid

GET

Try it out

Sending Send Copy cURL

Path Parameters

format *

partnerId *

configId *

environmentId *

organizationId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get configurations

Path Parameters

format *: string

The format to identify the target resource.

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

configId *: string

The config ID to identify the target resource.

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

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[*]']

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Ediformats By Format Configurations By Configid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

format *

partnerId *

configId *

environmentId *

organizationId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace configuration

Path Parameters

format *: string

The format to identify the target resource.

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

configId *: string

The config ID to identify the target resource.

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

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[*]']

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid Ediformats By Format Configurations By Configid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

format *

partnerId *

configId *

environmentId *

organizationId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete configuration

Path Parameters

format *: string

The format to identify the target resource.

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

configId *: string

The config ID to identify the target resource.

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

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[*]']

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Endpointtypes By Type Configurations getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurations

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

type *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all configurations

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

type *: string

The type to identify the target resource.

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Endpointtypes By Type Configurations createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurations

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

type *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new configuration

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

type *: string

The type to identify the target resource.

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Endpointtypes By Type Configurations By Configid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurationsByConfigid

GET

Try it out

Sending Send Copy cURL

Path Parameters

partnerId *

configId *

environmentId *

organizationId *

type *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get configurations

Path Parameters

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

configId *: string

The config ID to identify the target resource.

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

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[*]']

type *: string

The type to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Endpointtypes By Type Configurations By Configid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurationsByConfigid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

partnerId *

configId *

environmentId *

organizationId *

type *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Replace configuration

Path Parameters

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

configId *: string

The config ID to identify the target resource.

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

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[*]']

type *: string

The type to identify the target resource.

Request Body

json

Response

204

204 400 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Identifiers getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiers

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all identifiers

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Identifiers createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiers

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new identifier

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partners By Partnerid Identifiers By Identifierid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiersByIdentifierid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

identifierId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get identifiers

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

identifierId *: string

The identifier ID to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Delete Organizations By Organizationid Environments By Environmentid Partners By Partnerid Identifiers By Identifierid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiersByIdentifierid

DELETE

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

identifierId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Delete identifier

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

identifierId *: string

The identifier ID to identify the target resource.

Response

204

204 404 500

Operation completed successfully with no content returned.

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Identitykeys createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentitykeys

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body multipart/form-data

Response

Body Headers

Creates a identityKeys.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

multipart/form-data

type *: string

Type of identity file

name *: string

Unique name for identity key

keyPassphrase *: string

Passphrase for the file being uploaded

keyFile *: object

The file(s) to be uploaded

expirationDate *: string

Expiration date of key

algorithm: string

Algorithm

Response

200

200

Successful operation.

Examples

application/json

{ "secretId": "bf4e0d7d-3baa-4663-9e5c-f34f628ab8f2", "secretGroupId": "756f3961-b1ac-44f0-ab26-c478f8876083", "certificateId": "a8000e40-4058-4cd0-9517-0d15869d3241" }

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Identitykeys By Identityid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentitykeysByIdentityid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

identityId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body multipart/form-data

Response

Body Headers

Replaces a identityKeys.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

identityId *: string

The identity ID to identify the target resource.

Request Body

multipart/form-data

type *: string

Type of identity file

name *: string

Unique name for identity key

keyPassphrase *: string

Passphrase for the file being uploaded

keyFile *: object

The file(s) to be uploaded

expirationDate *: string

Expiration date of key

algorithm: string

Algorithm

Response

200

200

Successful operation.

Examples

application/json

{ "secretId": "ca17dfd1-3c55-43e4-80c0-9140a926f700", "secretGroupId": "756f3961-b1ac-44f0-ab26-c478f8876083" }

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Keystores createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridKeystores

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body multipart/form-data

Response

Body Headers

Creates a keystores.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

multipart/form-data

type *: string

Type of kesystore file

name *: string

Unique name for keystore

keyFile *: object

Private key - Binary file(s) to be uploaded

certificateFile *: object

Public key - Binary file(s) to be uploaded

keyPassphrase *: string

Passphrase for the file being uploaded

secretGroupId: string

Secret GroupId

secretId: string

SecretId

Response

200

200

Successful operation.

Examples

application/json

{ "secretId": "1c168228-23b9-4176-b6c7-8ce317919c6f", "secretGroupId": "756f3961-b1ac-44f0-ab26-c478f8876083", "certificateId": "96bd42fd-fd1e-47b3-94bd-2b457d04ece3" }

Update Organizations By Organizationid Environments By Environmentid Partners By Partnerid Keystores By Keystoreid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridKeystoresByKeystoreid

PUT

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

keystoreId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body multipart/form-data

Response

Body Headers

Replaces a keystores.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

keystoreId *: string

The keystore ID to identify the target resource.

Request Body

multipart/form-data

type *: string

Type of kesystore file

name *: string

Unique name for keystore

keyFile *: object

Private key - Binary file(s) to be uploaded

certificateFile *: object

Public key - Binary file(s) to be uploaded

keyPassphrase *: string

Passphrase for the file being uploaded

secretGroupId: string

Secret GroupId

secretId: string

SecretId

Response

200

200

Successful operation.

Examples

application/json

{ "secretId": "1c168228-23b9-4176-b6c7-8ce317919c6f", "secretGroupId": "756f3961-b1ac-44f0-ab26-c478f8876083", "certificateId": "96bd42fd-fd1e-47b3-94bd-2b457d04ece3" }

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Logo getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridLogo

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get Partner Logo

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200 404

Successful operation.

Examples

application/octet-stream

{ "title": "logo-response", "LogoResponse": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wgARCADIAMgDASIAAhEBAxEB/8QAHAABAAMBAQEBAQAAAAAAAAAAAAUGBwQDAggB/8QAGgEBAAMBAQEAAAAAAAAAAAAAAAIDBAUBBv/aAAwDAQACEAMQAAAB/VIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABU5wtghMAAqdsnAITAA4K9zUXo4b5/Mq0+2uZlcDu8ZdN2gco982qs5VubyWqme/c46xXMm3eMpPo/Pt9hLousHk8vO7fcC32Eg5u8ACjeE55bsea7Vn+hmEfdrjuhikaLPcEvPjfcw0/m7sCW5vx0f8AQ/5mtT2H7bLyyh30ae4PXxvuYafzdwYdgBSLvLKEdQAAA+Hn2qfvZhpOtktIpVdd1fP1HSD0ADFpzi1rb8bXoeveyXrdJrJq9ktxxU/fybRTp3wq6URf/fM42ytItvPo4lvqtxr9HZ8OWv2C7j2yqd8fXvnLlTblR3Aq6QGXajDTNvMynk0j6u5DPrBcoaqR7SsXKqr9durdmCy1" }

application/json

{ "title": "logo-response", "LogoResponse": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wgARCADIAMgDASIAAhEBAxEB/8QAHAABAAMBAQEBAQAAAAAAAAAAAAUGBwQDAggB/8QAGgEBAAMBAQEAAAAAAAAAAAAAAAIDBAUBBv/aAAwDAQACEAMQAAAB/VIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABU5wtghMAAqdsnAITAA4K9zUXo4b5/Mq0+2uZlcDu8ZdN2gco982qs5VubyWqme/c46xXMm3eMpPo/Pt9hLousHk8vO7fcC32Eg5u8ACjeE55bsea7Vn+hmEfdrjuhikaLPcEvPjfcw0/m7sCW5vx0f8AQ/5mtT2H7bLyyh30ae4PXxvuYafzdwYdgBSLvLKEdQAAA+Hn2qfvZhpOtktIpVdd1fP1HSD0ADFpzi1rb8bXoeveyXrdJrJq9ktxxU/fybRTp3wq6URf/fM42ytItvPo4lvqtxr9HZ8OWv2C7j2yqd8fXvnLlTblR3Aq6QGXajDTNvMynk0j6u5DPrBcoaqR7SsXKqr9durdmCy1" }

Not found. The requested resource does not exist.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partners By Partnerid Sequences getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridSequences

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all sequences

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partners By Partnerid Sequences createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridSequences

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new sequence

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners.$.id

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partnerprofiles getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Query Parameters

name

thirdPartiesOnly

pageSize

excludeIdentifiersCount

description

page

excludeCounts

includeHost

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all partnerprofiles

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

name: string

Partner Name

thirdPartiesOnly: string

The thirdPartiesOnly query parameter.

default: false

pageSize: integer

Limit the elements to be fetched a page

default: 100

excludeIdentifiersCount: string

If true, then dependency counts of particular identifiers are not returned in response

default: false

description: string

Partner Description

page: integer

The page to be fetched

default: 1

excludeCounts: string

If true, then deployment counts are not returned in response

default: false

includeHost: string

If true, then host details are also fetched in the collection of response

default: false

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Partnerprofiles createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new partnerprofile

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Partnerprofiles By Partnerid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesByPartnerid

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get partnerprofiles

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles.$.id

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Patch Organizations By Organizationid Environments By Environmentid Partnerprofiles By Partnerid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesByPartnerid

PATCH

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

partnerId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Patches partnerprofile

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

partnerId *: string

The partner ID to identify the target resource.

Related Operations:

partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles.$.id

Request Body

json

Response

200

200 204 400 404 500

Successful operation.

Examples

application/json

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

Operation completed successfully with no content returned.

Examples

application/json

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

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

Examples

application/json

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

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Partnerprofiles Host getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesHost

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get host

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Environments By Environmentid Runtimeupgrades getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgrades

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all runtimeUpgrades

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Response

200

200

Successful operation.

Examples

application/json

{}

Create Organizations By Organizationid Environments By Environmentid Runtimeupgrades createOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgrades

POST

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Request Body application/json

Response

Body Headers

Create a new runtimeUpgrade

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Request Body

json

Response

201

201 400 500

Resource created successfully.

Examples

application/json

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

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 Environmentid Runtimeupgrades By Id getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgradesById

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

environmentId *

id *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get runtimeUpgrades

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

id *: string

The id to identify the target resource.

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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

Get Organizations By Organizationid Runtimefabric getOrganizationsByOrganizationidRuntimefabric

GET

Try it out

Sending Send Copy cURL

Path Parameters

organizationId *

Custom Query Parameters

+ Add Query Parameter

Custom Headers

+ Add Header

Response

Body Headers

Get all runtimefabric

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[*]']

Response

200

200 404 500

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

Examples

application/json

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

Internal server error.

Examples

application/json

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