ObjectAPI 1.0

a wa:WebAPI & wa:HTTPEndpoint in CloudObjects

This API provides access to object descriptions stored in CloudObjects.

Base URL

The endpoint is located at the following URL:
https://api.cloudobjects.net

Authentication

This API can be used without authentication.

This API supports HTTP Basic Authentication with shared secrets issued by CloudObjects:

Username:

A domain registered as a namespace in CloudObjects

Password:

The shared secret between the username domain and cloudobjects.io

With the CLI Tool installed, you can generate a shared secret with the following command:

cloudobjects domain-providers:secret <DOMAIN> cloudobjects.io

API Methods

These are the methods supported by the API:

• GET /{namespace}/object

  Get the description of a root object in the format specified by the Accept header.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  Send request Change or remove credentials

• GET /{namespace}/object.{extension}

  Get the description of a root object in the format specified by the extension.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  extension	The file extension, identifying the desired object format. One of: rdf, ttl, txt, jsonld

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  extension

  Send request Change or remove credentials

• GET /{namespace}/all

  Get descriptions of all objects in a namespace in the format specified by the Accept header.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.

  Optional parameters:

  type	Only get objects that have this RDF type.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  type

  Send request Change or remove credentials

• GET /{namespace}/all.{extension}

  Get descriptions of all objects in a namespace in the format specified by the extension.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  extension	The file extension, identifying the desired object format. One of: rdf, ttl, txt, jsonld

  Optional parameters:

  type	Only get objects that have this RDF type.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  extension

  type

  Send request Change or remove credentials

• GET /{namespace}/{filename}

  Get the content of a file attached to a root object.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  filename	The filename for the attached file, including extension.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  filename

  Send request Change or remove credentials

• GET /{namespace}/{name}/object

  Get the description of an unversioned object in the format specified by the Accept header.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  Send request Change or remove credentials

• GET /{namespace}/{name}/object.{extension}

  Get the description of an unversioned object in the format specified by the extension.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.
  extension	The file extension, identifying the desired object format. One of: rdf, ttl, txt, jsonld

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  extension

  Send request Change or remove credentials

• GET /{namespace}/{name}/{filename}

  Get the content of a file attached to an unversioned object.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.
  filename	The filename for the attached file, including extension.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  filename

  Send request Change or remove credentials

• GET /{namespace}/{name}/{version}/object

  Get the description of an versioned object in the format specified by the Accept header.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.
  version	The version of the object.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  version

  Send request Change or remove credentials

• GET /{namespace}/{name}/{version}/object.{extension}

  Get the description of an versioned object in the format specified by the extension.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.
  version	The version of the object.
  extension	The file extension, identifying the desired object format. One of: rdf, ttl, txt, jsonld

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  version

  extension

  Send request Change or remove credentials

• GET /{namespace}/{name}/{version}/{filename}

  Get the content of a file attached to an versioned object.

  • Request
  • Response
  • Try it

  Required parameters:

  namespace	The hostname/domain for the namespace.
  name	The name of the object.
  version	The version of the object.
  filename	The filename for the attached file, including extension.

  You need to provide authentication information before using this API:

  Set credentials

  namespace

  name

  version

  filename

  Send request Change or remove credentials

Meta

URI / COID

coid://cloudobjects.io/ObjectAPI/1.0 content_copy

Revision

7-032d7de17b9cfb6145436a44f39dcb7d content_copy

Short ID

co:ObjectAPI/1.0 content_copy

Reference URL

https://coid.link/cloudobjects.io/ObjectAPI/1.0 content_copy

Last updated

2020-04-16 10:59 (UTC)

Export

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

RDF

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

Objects in this namespace

• CloudObjects
• APIMethod
• Audience
• BNode
• CLITool 0.1
• CLITool 0.2
• CLITool 0.3
• CLITool 0.4
• CLITool 0.5
• ConsumerRole
• ConsumersDefault
• CoreIDType
• DNS TXT Verification
• DashboardDomainWidget
• DefaultAccess
• Developer
• Developer Object API 1.0
• Developer Object API 1.1
• DomainRelationsAPI 1.0
• Domain Verification Method
• Exporter
• FullAccess
• MemberRole
• Namespace
• ObjectAPI 1.0
• Owner
• Parent Domain Verification
• Private
• Public
• Root COID
• SharedSecret
• Unversioned COID
• Vendor
• Versioned COID
• Webmaster Mail Verification
• Website Code Verification
• allowsInstanceID
• canConfigureObjects
• canManageConsumers
• canManageDomain
• canManageMembers
• canManageProviders
• displaysConfigurationAssistant
• exportsObjectsWithType
• hasAttachment
• hasInstance
• hasSharedSecret
• hasSubclass
• hasTokenValue
• includeLinkedObjectsOfType
• includesConnectedAccountsFromService
• includesNamespace
• isAtRevision
• isFinal
• isVisibleTo
• makesTriplesVisibleTo
• permitsUsageTo
• recommendsPrefix
• returnsContentType
• supportsExporter
• supportsProperty
• usesFileExtension
• wasCreatedAt
• wasUpdatedAt
• withNamespace