WebAPIImportAPI

a phpmae:ControllerClass, WebAPI, phpmae:Class & HTTPEndpoint in Web API

Base URL

The endpoint is located at the following URL:
https://webapi.cloudobjects.io/import/

Authentication

This API can be used without authentication.

API Methods

These are the methods supported by the API:

• POST /convertData Convert Data

  Converts an existing machine-readable API definition into a Web API object configuration. The existing API definition needs to be sent with the request.

  • Request
  • Response
  • Try it

  Required parameters:

  coid	The COID for the Web API to be generated.
  data	The content of the API definition.

  Optional parameters:

  audience	The COID for the audience of the Web API.

  Success response:

  A JSON-LD representation of the Web API.

  Status Code	200
  Content Type	application/ld+json

  You need to provide authentication information before using this API:

  Set credentials

  coid

  data

  audience

  Send request Change or remove credentials

• GET /convertFromURL Convert from URL

  Converts an existing machine-readable API definition into a Web API object configuration. The existing API definition is taken from a URL.

  • Request
  • Response
  • Try it

  Required parameters:

  coid	The COID for the Web API to be generated.
  url	The URL to an API definition file.

  Optional parameters:

  audience	The COID for the audience of the Web API.

  Success response:

  A JSON-LD representation of the Web API.

  Status Code	200
  Content Type	application/ld+json

  You need to provide authentication information before using this API:

  Set credentials

  coid

  url

  audience

  Send request Change or remove credentials

Public PHP Methods

This class has no public methods yet or a problem occurred while retrieving them.

Meta

URI / COID

coid://webapis.co-n.net/WebAPIImportAPI content_copy

Revision

2-59752e2cb14be0e785e36c2b06d0b862 content_copy

Short ID

wa:WebAPIImportAPI content_copy

Reference URL

https://coid.link/webapis.co-n.net/WebAPIImportAPI content_copy

Last updated

2017-05-28 13:38 (UTC)

Export

• openapi.json (via OpenAPIExporter 3.0)
• postman.json (via PostmanCollectionExporter v2)
• swagger.json (via SwaggerExporter 2.0)

RDF

• JSON-LD
• RDF/XML
• Turtle
• N-Triples

Objects in this namespace

• Web API
• APIKeyAuthentication
• APIMethod
• APIResponse
• AnonymousAccess
• AuthenticationMechanism
• CookieParameter
• DirectoryTemplateVariableGenerator
• EmptyResponse
• ExampleResponse
• FormDataParameter
• GraphQLEndpoint
• HTTPBasicAuthentication
• HTTPEndpoint
• MD5-hash Shared Secret Authentication (via API Key)
• HeaderParameter
• JSONResponse
• OpenAPIConverter 3.0
• OpenAPIExporter 3.0
• Parameter
• PathParameter
• PostmanCollectionExporter v2
• QueryParameter
• Shared Secret Authentication (via HTTP Basic)
• SwaggerExporter 2.0
• WebAPI
• WebAPIImportAPI
• hasBaseURL
• hasBody
• hasContentType
• hasDataType
• hasDefaultValue
• hasErrorResponse
• hasFixedAPIKey
• hasFixedPassword
• hasFixedUsername
• hasJSONBodyWithSchema
• hasJSONRequestBodyWithSchema
• hasJSONSchema
• hasKey
• hasMethod
• hasPath
• hasStatusCode
• hasSuccessResponse
• hasVerb
• requiresParameter
• supportsAuthenticationMechanism
• supportsCORSAnyOrigin
• supportsCORSForDirectory
• supportsOptionalParameter
• usesAPIKeyFrom
• usesAuthenticationParameter
• usesPasswordFrom
• usesUsernameFrom