openapi: 3.1.0
info:
title: Service Management
contact: {}
version: '1.0'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: http://localhost:5555/rest/apigateway
variables: {}
paths:
/apis/{apiId}/versions:
get:
tags:
- Versions
summary: Get Versions of API by ID
description: Retrieve all the versions of the API
operationId: GetVersionsofAPIbyID
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to retrieve the versions
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'401':
description: Unauthorized
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
deprecated: false
post:
tags:
- Versions
summary: Create Version
description: Create a new version of an API and retain applications if required
operationId: CreateVersion
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to be versioned
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CreateVersionRequest'
- examples:
- newApiVersion: '2.0'
retainApplications: 'true'
contentMediaType: application/json
example:
newApiVersion: '2.0'
retainApplications: 'true'
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
'401':
description: Unauthorized
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
deprecated: false
parameters: []
/apis/{apiId}/mock/enable:
put:
tags:
- Mocking
summary: Enable API Mocking
description: "In API Gateway, you can mock an API implementation. API Gateway lets you mock an API by simulating the native service. API Mocking is useful feature in API first approach, where in the provider may choose to expose the mocked API to the consumers when the actual API doesn't exist or isn't complete. \n In API Gateway, when you enable mocking for an API, a default mock response is created for each combination of resource, operation, status code and content-type based on the example and schema set in the API definition. As an API Provider, you can add or modify the default mock responses.\n\nYou can specify conditions at the operation level and configure IS services at the API level for a mocked API in the update API operation. At runtime, when the mocked API is invoked instead of calling the native service, API Gateway returns the mocked response to the consumer based on the below priorities:\n1. If any of the conditions for the invoked operation satisfies, API Gateway returns the associated mocked response.\n2. If no condition is specified or none of the condition for the invoked operation is satisfied, then API Gateway will return \na. the response from an IS service, if an IS service is configured b. default mocked response, if no IS services are configured"
operationId: EnableAPIMocking
parameters:
- name: retainDefaultMockResponses
in: query
description: Flag to retain generated mocked responses. When this is set to true, default mocked responses will be retained. If it's set to false, new default mocked responses will be generated using the examples, schema in the API
required: true
style: form
explode: true
schema:
type: boolean
examples:
- false
- name: apiId
in: path
description: (Required) API Id for the API to be activated
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- '"{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"921604684\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": true\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}"'
contentMediaType: application/json
example: '"{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"921604684\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": true\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}"'
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
deprecated: false
parameters: []
/apis/{apiId}/mock/disable:
put:
tags:
- Mocking
summary: Disable API Mocking
description: Once API is disabled from mocking capability, at runtime all the API invocations are redirected to the native service instead of sending the mocked response
operationId: DisableAPIMocking
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to be deactivated
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'400':
description: Bad Request
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- '"{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"921604684\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": false\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}"'
contentMediaType: application/json
example: '"{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"/generateFromExampleDefault mocked response from example for status code 200\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"921604684\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": false\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}"'
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
deprecated: false
parameters: []
/apis/{apiId}/scopes:
get:
tags:
- Scopes
summary: Get Scopes of API by API Id
description: >-
An API Scope is a collection of resources or operations in an API. Users can create multiple scopes for a single API. Policies can be attached to an API level or scope level. This method retrieves the scopes of an API.
You can create, modify or delete the scopes in the update API operation using PUT /api/{apiId}
operationId: GetScopesofAPIbyAPIId
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to retrieve the versions
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- '"{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}"'
contentMediaType: application/json
example: '"{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}"'
deprecated: false
parameters: []
/apis/{apiId}/scopes/{scopeName}:
get:
tags:
- Scopes
summary: Get Scope of API By API Id and Scope Name
description: Retrieve scopes of an API based on the scope name
operationId: GetScopeofAPIByAPIIdandScopeName
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to retrieve the versions
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: scopeName
in: path
description: (Required) Name of the scope
required: true
style: simple
schema:
type: string
examples:
- Pet Scope
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'401':
description: Unauthorized
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- '"{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}"'
contentMediaType: application/json
example: '"{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}"'
deprecated: false
parameters: []
/apis/{apiId}:
get:
tags:
- APIs
summary: Get API Details by Id
description: Retrieve an API based on the API id.
operationId: GetAPIDetailsbyId
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to be retrieved
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'401':
description: Unauthorized
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n \\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n \\r\\n }\\r\\n ],\\r\\n \\\"teams\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"Administrators\\\",\\r\\n \\\"name\\\": \\\"Administrators\\\",\\r\\n \\\"canDelete\\\": \\\"false\\\"\\r\\n },\\r\\n {\\r\\n \\\"id\\\": \\\"Default\\\",\\r\\n \\\"name\\\": \\\"Default\\\",\\r\\n \\\"canDelete\\\": \\\"true\\\"\\r\\n }\\r\\n ] }\\r\\n}\""
deprecated: false
delete:
tags:
- APIs
summary: Delete API by Id
description: Delete the inactive API
operationId: DeleteAPIbyId
parameters:
- name: forceDelete
in: query
description: Flag for force delete. Required when API is associated with some applications
required: true
style: form
explode: true
schema:
type: boolean
examples:
- true
- name: apiId
in: path
description: (Required) API Id for the API to be deleted
required: true
style: simple
schema:
type: string
examples:
- 3c575e49-73d5-4ae8-a3a5-552544e5a4a0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'400':
description: Bad Request
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReturnstheapiIdalongwiththeerrorwhenunsuccessful'
- examples:
- id:
apiName:
apiVersion:
type:
publishedPortals:
-
-
systemVersion:
teams:
- id:
name:
source:
- id:
name:
source:
active:
apiId:
errorReason:
responseStatus:
contentMediaType: application/json
example:
id:
apiName:
apiVersion:
type:
publishedPortals:
-
-
systemVersion:
teams:
- id:
name:
source:
- id:
name:
source:
active:
apiId:
errorReason:
responseStatus:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
parameters: []
/apis/{apiId}/activate:
put:
tags:
- APIs
summary: Activate API
description: Activate an API so that API is exposed to consumers
operationId: ActivateAPI
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to be activated
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'400':
description: Bad Request
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'404':
description: Not Found
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
deprecated: false
parameters: []
/apis/{apiId}/deactivate:
put:
tags:
- APIs
summary: Deactivate API
description: Deactivate an API so that API is not exposed to consumers
operationId: DeactivateAPI
parameters:
- name: apiId
in: path
description: (Required) API Id for the API to be deactivated
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'401':
description: Unauthorized
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"security\\\": [],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"securityDefinitions\\\": {},\\r\\n \\\"definitions\\\": {},\\r\\n \\\"baseUriParameters\\\": [],\\r\\n \\\"externalDocs\\\": [],\\r\\n \\\"servers\\\": [\\r\\n {\\r\\n \\\"url\\\": \\\"https://api.chucknorris.io/jokes\\\"\\r\\n }\\r\\n ],\\r\\n \\\"components\\\": {\\r\\n \\\"schemas\\\": {}\\r\\n }\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorris\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"08afbfa9-78e1-4c23-bb19-c0012464047e\\\"\\r\\n ],\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2018-09-03 11:56:21 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\",\\r\\n \\\"versions\\\": [\\r\\n {\\r\\n \\\"versionNumber\\\": \\\"1.0\\\",\\r\\n \\\"apiId\\\": \\\"badc18e6-446f-4aa3-96cd-33e46bd40fb5\\\"\\r\\n }\\r\\n ]\\r\\n }\\r\\n}\""
'404':
description: Not Found
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
deprecated: false
parameters: []
/apis/{apiId}/publish:
put:
tags:
- APIs
summary: Publish API
description: This REST operation is used to publish API to the registered API Portal
operationId: PublishAPI
parameters:
- name: portalGatewayId
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
examples:
- d663e093-b39a-4330-93b9-fcb68d1a2c3d
- name: apiId
in: path
description: (Required) API Id for the API to be published
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PublishAPIRequest'
- examples:
- communities:
- 3bdf8005-5685-3ef5-b132-de4681963fb6
endpoints:
- http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5
contentMediaType: application/json
example:
communities:
- 3bdf8005-5685-3ef5-b132-de4681963fb6
endpoints:
- http://SAG-1YVHZY2:5555/gateway/Petstore/1.0.5
required: true
responses:
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""
deprecated: false
parameters: []
/apis/{apiId}/unpublish:
put:
tags:
- APIs
summary: Unpublish API
description: Unpublish API from the registered API Portal
operationId: UnpublishAPI
parameters:
- name: portalGatewayId
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
examples:
- d663e093-b39a-4330-93b9-fcb68d1a2c3d
- name: forceUnpublish
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
examples:
- true
- name: apiId
in: path
description: (Required) API Id for the API to be unpublished
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'404':
description: Not Found
headers: {}
content: {}
'401':
description: Unauthorized
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
examples:
- "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""
contentMediaType: application/json
example: "\"{\\r\\n \\\"apiResponse\\\": {\\r\\n \\\"api\\\": {\\r\\n \\\"apiDefinition\\\": {\\r\\n \\\"type\\\": \\\"rest\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"vendorExtensions\\\": {},\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"version\\\": \\\"1.0\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\",\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"parameters\\\": [],\\r\\n \\\"responses\\\": {},\\r\\n \\\"enabled\\\": true\\r\\n },\\r\\n \\\"enabled\\\": true\\r\\n }\\r\\n },\\r\\n \\\"definitions\\\": {}\\r\\n },\\r\\n \\\"nativeEndpoint\\\": [\\r\\n {\\r\\n \\\"passSecurityHeaders\\\": true,\\r\\n \\\"uri\\\": \\\"https://api.chucknorris.io/jokes\\\",\\r\\n \\\"connectionTimeoutDuration\\\": 0,\\r\\n \\\"alias\\\": false\\r\\n }\\r\\n ],\\r\\n \\\"apiName\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"apiVersion\\\": \\\"1.0\\\",\\r\\n \\\"apiDescription\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"maturityState\\\": \\\"Beta\\\",\\r\\n \\\"isActive\\\": false,\\r\\n \\\"type\\\": \\\"REST\\\",\\r\\n \\\"owner\\\": \\\"Administrator\\\",\\r\\n \\\"policies\\\": [\\r\\n \\\"879068cd-8628-4f2a-b903-4e6613ca12ba\\\"\\r\\n ],\\r\\n \\\"referencedFiles\\\": {\\r\\n \\\"ChuckNorrisAPI.json\\\": \\\"{\\\\r\\\\n \\\\\\\"swagger\\\\\\\": \\\\\\\"2.0\\\\\\\",\\\\r\\\\n \\\\\\\"info\\\\\\\": {\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\\\\\",\\\\r\\\\n \\\\\\\"title\\\\\\\": \\\\\\\"ChuckNorrisAPI\\\\\\\",\\\\r\\\\n \\\\\\\"version\\\\\\\": \\\\\\\"1.0\\\\\\\"\\\\r\\\\n },\\\\r\\\\n \\\\\\\"host\\\\\\\": \\\\\\\"api.chucknorris.io\\\\\\\",\\\\r\\\\n \\\\\\\"basePath\\\\\\\": \\\\\\\"/jokes\\\\\\\",\\\\r\\\\n \\\\\\\"schemes\\\\\\\": [\\\\r\\\\n \\\\\\\"https\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"paths\\\\\\\": {\\\\r\\\\n \\\\\\\"/random\\\\\\\": {\\\\r\\\\n \\\\\\\"get\\\\\\\": {\\\\r\\\\n \\\\\\\"summary\\\\\\\": \\\\\\\"GET\\\\\\\",\\\\r\\\\n \\\\\\\"deprecated\\\\\\\": false,\\\\r\\\\n \\\\\\\"produces\\\\\\\": [\\\\r\\\\n \\\\\\\"application/json\\\\\\\"\\\\r\\\\n ],\\\\r\\\\n \\\\\\\"description\\\\\\\": \\\\\\\"\\\\\\\",\\\\r\\\\n \\\\\\\"operationId\\\\\\\": \\\\\\\"GET\\\\\\\"\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\"\\r\\n },\\r\\n \\\"scopes\\\": [],\\r\\n \\\"publishedPortals\\\": [],\\r\\n \\\"creationDate\\\": \\\"2017-03-13 09:38:30 GMT\\\",\\r\\n \\\"systemVersion\\\": 1,\\r\\n \\\"id\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\",\\r\\n \\\"oauth2ScopeName\\\": \\\"25fb937a-8360-41ab-8be5-987b14fe631d\\\"\\r\\n },\\r\\n \\\"responseStatus\\\": \\\"SUCCESS\\\"\\r\\n }\\r\\n}\""
deprecated: false
parameters: []
/apis/{apiId}/implementation:
put:
tags:
- APIs
summary: Notify API Implementation
description: An API Provider tool can use this operation to update the API in APIGateway after completion of its implementation in their end
operationId: NotifyAPIImplementation
parameters:
- name: nativeBaseURL
in: query
description: Base URL of the native API
required: true
style: form
explode: true
schema:
type: string
examples:
- http://petstore.swagger.io/v2
- name: overwriteAlias
in: query
description: Flag to replace the endpoint alias that is used in the routing policy of the API with the given value of 'nativeBaseURL' parameter.
required: true
style: form
explode: true
schema:
type: boolean
examples:
- false
- name: maturityState
in: query
description: Value of the 'maturity state' attribute of the API. The 'maturity state' of the API can be set to its one of possible value (from its defines values in extended settings configuration) to depict the completion its implementation
required: true
style: form
explode: true
schema:
type: string
examples:
- Beta
- name: apiId
in: path
description: (Required) API Id for the API to be updated
required: true
style: simple
schema:
type: string
examples:
- 2c843837-cc6c-4ba1-aaf3-b10f8e9adbe0
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
examples:
- application/json
responses:
'404':
description: Not Found
headers: {}
content: {}
'400':
description: Bad Request
headers: {}
content: {}
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReturnstheupdatedAPIobject'
- examples:
- apiId:
api:
apiDefinition:
type:
description:
title:
version:
uri:
-
serviceRegistryDisplayName:
nativeEndpoint:
- optimizationTechnique:
passSecurityHeaders:
uri:
connectionTimeoutDuration:
alias:
apiName:
apiVersion:
apiEndpointPrefix:
apiDescription:
maturityState:
apiGroups:
-
-
isActive:
type:
owner:
policies:
-
-
rootFileName:
scopes:
- name:
description:
getoAuth2ScopeName:
policies:
-
-
mashedUpAPI:
- name:
description:
getoAuth2ScopeName:
policies:
-
-
mashedUpAPI:
publishedPortals:
-
-
publishedToRegistry:
creationDate:
lastModified:
prevVersion:
nextVersion:
systemVersion:
provider:
centraSiteURL:
mockService:
enableMock:
runAsUser:
service:
apiDocuments:
-
-
id:
oauth2ScopeName:
responseStatus:
errorReason:
gatewayEndPoints:
-
-
microgatewayEndPoints:
-
-
reason: