Rest API to create ActivitySpec
Status Transition
| Pre-Status | Post-Status |
|---|---|
| NA | draft |
Request Body
Request body is a JSON object (Content-Type: application/json) includes the following fields.
| Field Name | Mandatory(M) /Optional(O) /Conditional(C) | Validations |
|---|---|---|
| name | M | Unique |
| description | O | |
| category | O | |
| inputs | O | |
| outputs | O |
Sample
Request Headers:
Connection: keep-alive
Accept: application/json
Content-Type: application/json
USER_ID: cs0008
Content-Length: 342
User-Agent: Jakarta Commons-HttpClient/3.1
Host: 192.172.97.237:8080
POST http://192.172.97.237:8080/activityspec-api/v1.0/activity-spec
{
"name": "Stop_VNF",
"description": "Activity to Stop VNF",
"categoryList": [
"VNF"
],
"inputs": [
{
"name": "wait_time",
"type": "string"
}
],
"outputs": [
{
"name": "status",
"type": "string",
"value": "stopped"
}
]
}
Response Body
Response body is a JSON object (Content-Type: application/json) includes the following fields.
| Field Name | Mandatory(M) /Optional(O) /Conditional(C) |
|---|---|
| id | Y |
| versionId | Y |
Sample
Response headers:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 21 Feb 2018 08:13:57 GMT
Transfer-Encoding: chunked
Server: Jetty(9.3.6.v20151106)
DataEncoding: null
{
: "id":"8f2602ea6a764f3ba14d411fe903ffde",
: "versionId":"d70f54067a764cf79dde74c4822bb03d"
}
HTTP Response Codes
| HTTP Response Code | Description |
|---|---|
| 200 | Success |
| TBD | Mandatory Parameters Missing in the Request |
| TBD | Parameters validation failure |
| TBD | Parameter Invalid Format |