2022

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

The ApiCode distribution REST API provide programmatic access to read and write replication data. The REST API identifies the application and its users using OAUTH  ; responses are available in json.  We have used SWAGGER editor for the end users to make the API calls so that they can try out APIs exposed by API management platform. 

Click Here for accessing the CW-API management platform for unregistered user.

Checklist Before Getting Started 

...

Parameter

Description

Data type

ServiceURL(optional)

The website url to access the service

String

docURL(optional)

Retrieves the URL of the file in the web layout directory

Date

SwaggerURL(optional)

The swagger url is the return type on which the response is listed 

Date

status(optional)

The possible values are True and False which sends out the response value

String

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7ee5bef0-a9c2-4b42-a9de-53c166dcf469"><ac:plain-text-body><![CDATA[

errorMessage(optional)

In case of the status value is False, an error message is returned 

Array[string]

]]></ac:plain-text-body></ac:structured-macro>

Example For Un Sucessful Deployment

...