Api Definitions - Export Specification

Service:

API Center

API Version:

2024-02-01-preview

Export an API specification asynchronously.

POST https://{serviceName}.data.azure-apicenter.net/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}:exportSpecification?api-version=2024-02-01-preview

URI Parameters

Name	In	Required	Type	Description
apiName	path	True	string	Api identifier.
definitionName	path	True	string	API definition identifier.
serviceName	path	True	string	Region-unique API Center service name
versionName	path	True	string	Version identifier.
workspaceName	path	True	string	Workspace identifier.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
202 Accepted		The request has been accepted for processing, but processing has not yet completed. Headers Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://azure-apicenter.net/user_impersonation

Examples

ApiDefinitions_ExportSpecification

Sample request

HTTP

POST https://{serviceName}.data.azure-apicenter.net/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/default:exportSpecification?api-version=2024-02-01-preview

Sample response

Status code:

202

Operation-Location: https://contoso.data.azure-apicenter.net/.../definitions/default/operations/00000000-0000-0000-0000-000000000001

{
  "status": "Succeeded",
  "result": {
    "value": "{ ... }",
    "format": "link"
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Azure.Core.Foundations.Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.