2022
...
The ApiCode distribution REST API provide provides programmatic access to read and write 'Read' and 'Write' replication data. The REST API identifies the application and its users using OAUTH ; and, responses are available in jsonJSON. 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 to access the CW-API management platform for unregistered user.
Checklist Before Getting Started Started:
There are various API methods list which that are exposed for in this release , we . We will be adding more methods in the upcoming releases.
...
The ApicodeApiCode-distribution is an API which that is used to deploy Apicode ApiCode based rest on REST services from a git Git repository to the underlying Api management server.
The Tables below tables explains the various model schema and model schemas and attributes which that form the model class class:
...
Parameter | Description | Data Type |
---|---|---|
apiCodeServerUsername(optional) | The |
Username of the ApiCode server instance. |
String | |
apiCodeServerPassword(optional) | The |
Password of the ApiCode server instance. |
String | |
environment(optional) | User has the flexibility to define his/her environment in which s/he wishes to deploy |
the code base. |
String |
Parameter | Description | Data Type |
---|---|---|
url(optional) | The |
Git repository url of the user from which he would like to deploy the code base. |
String | |
branch(optional) | The branch inside of a repository from which the user wishes to deploy the code base. |
String | |
username(optional) | Valid |
User name of the |
Git repository |
String | |
password(optional) | Valid password of the |
Git repository |
String |
Below table gives the attribute list of the response class
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 |
. It sends out the response value. | String |
errorMessage(optional) | In case |
the status value is False, an error message is |
returned. | Array[string] |
...
Code Block |
---|
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"appCodeServerUsername":"anil.b@mydbsync.com","appCodeServerPassword":"dbsync2015","environment":"dev","url":"https://sureshullagaddi@bitbucket.org/dbsync/amazons3.git","branch":"dev","username":"suresh.u@avankia.com","password":"suresh@12345"}' 'https://staging.mydbsync.com:443/api/appcode/v1/appcode-distribution/gitCompile'
|
Code Block |
---|
https://staging.mydbsync.com:443/api/appcode/v1/appcode-distribution/gitCompile. |
Code Block |
---|
{ "error": "AppCode:appcode-distribution does not exist, Please check your URL". } |
Code Block |
---|
200. |
Code Block |
---|
{
"access-control-allow-origin": "*",
"date": "Fri, 24 Feb 2017 13:23:54 GMT",
"connection": "Keep-Alive",
"keep-alive": "timeout=150, max=92","content-length": "78",
"content-type": "application/json"
}
|