# Partner Manager Partners API Manage partner profiles, certificates, EDI document types, document flows, and deployment configurations in Anypoint Partner Manager. - **Version:** 1.0.1 - **Category:** B2B - **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/partner-manager-v2-partners/api.yaml) ## Servers - `https://anypoint.mulesoft.com/partnermanager/partners/api/v1` - `https://{region}.anypoint.mulesoft.com/partnermanager/partners/api/v1` - `https://{region}.platform.mulesoft.com/partnermanager/partners/api/v1` ## Operations (85) ### GET /organizations/{organizationId}/environments/{environmentId}/apmRelease **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApmrelease` Get apmRelease **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/certificates **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCertificates` Get Details of all the certificates saved in the environment **Parameters:** | `as2Only` | query | The as2Only query parameter. | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/customAttributes **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributes` Get all customAttributes **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/customAttributes **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributes` Create a new customAttribute **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid` Get customAttributes **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `customAttributeId` | query | The customAttribute ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId} **Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid` Patches customAttribute **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `customAttributeId` | query | The customAttribute ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidCustomattributesByCustomattributeid` Delete customAttribute **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `customAttributeId` | query | The customAttribute ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/deployments **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments` Get Deployment configurations **Parameters:** | `formatVersion` | query | The formatVersion query parameter. | optional | | `receivingEndpointId` | query | The receivingEndpoint ID query parameter. | optional | | `toPartner` | query | The toPartner query parameter. | optional | | `excludeSchemasAndMappings` | query | The excludeSchemasAndMappings query parameter. | optional | | `formatType` | query | The formatType query parameter. | optional | | `status` | query | The status query parameter. | optional | | `excludeAuditHistory` | query | The excludeAuditHistory query parameter. | optional | | `fromPartner` | query | The fromPartner query parameter. | optional | | `docType` | query | The docType query parameter. | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/deployments **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments` Creates new Deployment config **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/deployments/{deploymentId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeploymentsByDeploymentid` Get specific deployment details using deploymentId **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `deploymentId` | query | The deployment ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/environments/{environmentId}/deployments/{deploymentId} **Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeploymentsByDeploymentid` Update deployment details **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `deploymentId` | query | The deployment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows` Get all documents **Parameters:** | `name` | query | The name query parameter. | optional | | `pageSize` | query | Limit the elements to be fetched a page | optional | | `description` | query | The description query parameter. | optional | | `page` | query | The page to be fetched | optional | | `searchString` | query | The searchString query parameter. | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/documentflows **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflows` Create a new documentflow **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid` Get documentflows **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId} **Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid` 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. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowid` Delete documentflow **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappings` Get all mappings **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappings` Create a new mapping **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings/{mappingsId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappingsByMappingsid` Get mappings **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | | `mappingsId` | query | The mappings ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings/{mappingsId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidMappingsByMappingsid` Replace mapping **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | | `mappingsId` | query | The mappings ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/resolvedview **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidResolvedview` Get all resolvedview **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/runtimeValidations **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsByDocumentflowidRuntimevalidations` Get all runtimeValidations **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `documentflowId` | query | The documentflow ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/documentflows/summarylist **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDocumentflowsSummarylist` Get all summarylist **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/ediFormats **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformats` Get all ediFormats **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormat` Get ediFormats **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversions` Get all ediFormatVersions **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions/{versionId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversionsByVersionid` Get ediFormatVersions **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | | `versionId` | query | The version ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions/{versionId}/ediDocumentTypes **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEdiformatsByFormatEdiformatversionsByVersionidEdidocumenttypes` Get all ediDocumentTypes **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | | `versionId` | query | The version ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/endpoints **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpoints` Get endpoints **Parameters:** | `role` | query | The role query parameter. | optional | | `deploymentId` | query | The deployment ID query parameter. | optional | | `deploymentStatus` | query | The deploymentStatus query parameter. | optional | | `partnerId` | query | The partner ID query parameter. | optional | | `typeId` | query | The type ID query parameter. | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/endpoints **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpoints` Create a new endpoint **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid` Get endpoints **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `endpointId` | query | The endpoint ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid` Replace endpoint **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `endpointId` | query | The endpoint ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointsByEndpointid` Delete endpoint **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `endpointId` | query | The endpoint ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/endpointTypes/{type}/configurations **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidEndpointtypesByTypeConfigurations` Get all configurations **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `type` | query | The type to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/identifierTypes **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidIdentifiertypes` Get all identifierTypes **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/identifierTypes/{identifierTypeId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidIdentifiertypesByIdentifiertypeid` Get identifierTypes **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `identifierTypeId` | query | The identifierType ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners` Get all partners **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartners` Create a new partner **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid` Get partners **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid` Replace partner **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartnerid` Delete partner **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/addresses **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddresses` Get all addresses **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/addresses **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddresses` Create a new address **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/addresses/{addressId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid` Get addresses **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `addressId` | query | The address ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/addresses/{addressId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid` Replace address **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `addressId` | query | The address ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/addresses/{addressId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridAddressesByAddressid` Delete address **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `addressId` | query | The address ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificates` Get Details of all the certificates saved in the environment for particular partner **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificates` Create a new Certificate **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates/{certificateId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid` Get certificates **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `certificateId` | query | The certificate ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates/{certificateId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid` Replace certificate **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `certificateId` | query | The certificate ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates/{certificateId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridCertificatesByCertificateid` Delete certificate **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `certificateId` | query | The certificate ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocuments` Get all documents **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocuments` Create a new document **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid` Get documents **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `documentById` | query | The documentBy ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid` Replace document **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `documentById` | query | The documentBy ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridDocumentsByDocumentbyid` Delete document **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `documentById` | query | The documentBy ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurations` Get all configurations **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurations` Create a new configuration **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `format` | query | The format to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid` Get configurations **Parameters:** | `format` | query | The format to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `configId` | query | The config ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid` Replace configuration **Parameters:** | `format` | query | The format to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `configId` | query | The config ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEdiformatsByFormatConfigurationsByConfigid` Delete configuration **Parameters:** | `format` | query | The format to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `configId` | query | The config ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/endpointTypes/{type}/configurations **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurations` Get all configurations **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `type` | query | The type to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/endpointTypes/{type}/configurations **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurations` Create a new configuration **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `type` | query | The type to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/endpointTypes/{type}/configurations/{configId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurationsByConfigid` Get configurations **Parameters:** | `partnerId` | query | The partner ID to identify the target resource. | required | | `configId` | query | The config ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `type` | query | The type to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/endpointTypes/{type}/configurations/{configId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridEndpointtypesByTypeConfigurationsByConfigid` Replace configuration **Parameters:** | `partnerId` | query | The partner ID to identify the target resource. | required | | `configId` | query | The config ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `type` | query | The type to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiers` Get all identifiers **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiers` Create a new identifier **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers/{identifierId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiersByIdentifierid` Get identifiers **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `identifierId` | query | The identifier ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers/{identifierId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentifiersByIdentifierid` Delete identifier **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `identifierId` | query | The identifier ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identityKeys **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentitykeys` Creates a identityKeys. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identityKeys/{identityId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridIdentitykeysByIdentityid` Replaces a identityKeys. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `identityId` | query | The identity ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/keystores **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridKeystores` Creates a keystores. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/keystores/{keystoreId} **Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridKeystoresByKeystoreid` Replaces a keystores. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | | `keystoreId` | query | The keystore ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/logo **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridLogo` Get Partner Logo **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/sequences **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridSequences` Get all sequences **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/sequences **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnersByPartneridSequences` Create a new sequence **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partnerprofiles **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles` Get all partnerprofiles **Parameters:** | `name` | query | Partner Name | optional | | `thirdPartiesOnly` | query | The thirdPartiesOnly query parameter. | optional | | `pageSize` | query | Limit the elements to be fetched a page | optional | | `excludeIdentifiersCount` | query | If true, then dependency counts of particular identifiers are not returned in response | optional | | `description` | query | Partner Description | optional | | `page` | query | The page to be fetched | optional | | `excludeCounts` | query | If true, then deployment counts are not returned in response | optional | | `includeHost` | query | If true, then host details are also fetched in the collection of response | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/partnerprofiles **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofiles` Create a new partnerprofile **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partnerprofiles/{partnerId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesByPartnerid` Get partnerprofiles **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/environments/{environmentId}/partnerprofiles/{partnerId} **Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesByPartnerid` Patches partnerprofile **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `partnerId` | query | The partner ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/partnerprofiles/host **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidPartnerprofilesHost` Get host **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/runtimeUpgrades **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgrades` Get all runtimeUpgrades **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/runtimeUpgrades **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgrades` Create a new runtimeUpgrade **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/runtimeUpgrades/{id} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRuntimeupgradesById` Get runtimeUpgrades **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `id` | query | The id to identify the target resource. | required | ### GET /organizations/{organizationId}/runtimefabric **Operation ID:** `getOrganizationsByOrganizationidRuntimefabric` Get all runtimefabric **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required |