CloudObjects / Directory / Web API / WebAPIImportAPI
Sign in

WebAPIImportAPI

a phpmae:ControllerClass in Web API
Base URL

The API 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.

    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
    
    
  • 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.

    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
    
    
Meta
URI / COID
coid://webapi.cloudobjects.io/WebAPIImportAPI
Revision
8-3996c281e9ab2fd33c8ecfeb0e740c8c
Last updated
2017-05-28 13:38 (UTC)
Created at
2017-08-23 17:49 (UTC)
Usage permission
co:Private