org.openecomp.sdcrests.action.rest

Interface Actions

All Known Implementing Classes:

ActionsImpl

@Path(value="/workflow/v1.0/actions")
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @Validated
public interface Actions

Defines various CRUD API that can be performed on Action.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	actOnAction(String actionInvariantUuId, String requestJson, javax.servlet.http.HttpServletRequest servletRequest) Performs Checkout/Undo_Checkout/Checkin/Submit Operation on Action.
javax.ws.rs.core.Response	createAction(String requestJson, javax.servlet.http.HttpServletRequest servletRequest) Create a new Action based on request JSON.
javax.ws.rs.core.Response	deleteAction(String actionInvariantUuId, javax.servlet.http.HttpServletRequest servletRequest) Delete an action.
javax.ws.rs.core.Response	deleteArtifact(String actionInvariantUuId, String artifactUuId, javax.servlet.http.HttpServletRequest servletRequest)
javax.ws.rs.core.Response	downloadArtifact(String actionUuId, String artifactUuId, javax.servlet.http.HttpServletRequest servletRequest)
javax.ws.rs.core.Response	getActionsByActionInvariantUuId(String actionInvariantUuId, String actionUuId, javax.servlet.http.HttpServletRequest servletRequest) List All Major, Last Minor and Candidate version if any for Given Action Invariant UUID
javax.ws.rs.core.Response	getEcompComponents(javax.servlet.http.HttpServletRequest servletRequest) List ECOMP Components supported by Action Library.
javax.ws.rs.core.Response	getFilteredActions(String vendor, String category, String name, String modelId, String componentId, javax.servlet.http.HttpServletRequest servletRequest) Get list of actions based on a filter criteria.
javax.ws.rs.core.Response	updateAction(String actionInvariantUuId, String requestJson, javax.servlet.http.HttpServletRequest servletRequest) Update an existing action with parameters provided in requestJson.
javax.ws.rs.core.Response	updateArtifact(String actionInvariantUuId, String artifactUuId, String artifactName, String artifactLabel, String artifactCategory, String artifactDescription, String artifactProtection, String checksum, org.apache.cxf.jaxrs.ext.multipart.Attachment artifactToUpdate, javax.servlet.http.HttpServletRequest servletRequest)
javax.ws.rs.core.Response	uploadArtifact(String actionInvariantUuId, String artifactName, String artifactLabel, String artifactCategory, String artifactDescription, String artifactProtection, String checksum, org.apache.cxf.jaxrs.ext.multipart.Attachment artifactToUpload, javax.servlet.http.HttpServletRequest servletRequest) Upload an artifact to an action.

Method Detail

getActionsByActionInvariantUuId

@GET
 @Path(value="/{actionInvariantUUID}")
javax.ws.rs.core.Response getActionsByActionInvariantUuId(@PathParam(value="actionInvariantUUID")
                                                                                                      String actionInvariantUuId,
                                                                                                      @QueryParam(value="version")
                                                                                                      String actionUuId,
                                                                                                      @Context
                                                                                                      javax.servlet.http.HttpServletRequest servletRequest)

List All Major, Last Minor and Candidate version if any for Given Action Invariant UUID

Returns:

List of All Major, Last Minor and Candidate version if any Of Action with given actionInvariantUuId. If actionUUID is provided then only action with given actionInvariantUuId and actionUUID

getFilteredActions

@GET
javax.ws.rs.core.Response getFilteredActions(@QueryParam(value="vendor")
                                                  String vendor,
                                                  @QueryParam(value="category")
                                                  String category,
                                                  @QueryParam(value="name")
                                                  String name,
                                                  @QueryParam(value="modelId")
                                                  String modelId,
                                                  @QueryParam(value="componentId")
                                                  String componentId,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest servletRequest)

Get list of actions based on a filter criteria. If no filter is sent all actions will be returned

Returns:

List Of Last Major and Last Minor of All Actions based on filter criteria

getEcompComponents

@GET
 @Path(value="/components")
javax.ws.rs.core.Response getEcompComponents(@Context
                                                                              javax.servlet.http.HttpServletRequest servletRequest)

List ECOMP Components supported by Action Library.

Returns:

List of ECOMP Components supported by Action Library.

createAction

@POST
javax.ws.rs.core.Response createAction(String requestJson,
                                             @Context
                                             javax.servlet.http.HttpServletRequest servletRequest)

Create a new Action based on request JSON.

Returns:

Metadata object ActionResponseDto object for created Action.

updateAction

@PUT
 @Path(value="/{actionInvariantUUID}")
javax.ws.rs.core.Response updateAction(@PathParam(value="actionInvariantUUID")
                                                                                   String actionInvariantUuId,
                                                                                   String requestJson,
                                                                                   @Context
                                                                                   javax.servlet.http.HttpServletRequest servletRequest)

Update an existing action with parameters provided in requestJson.

Returns:

Metadata object ActionResponseDto object for created Action.

deleteAction

@DELETE
 @Path(value="/{actionInvariantUUID}")
javax.ws.rs.core.Response deleteAction(@PathParam(value="actionInvariantUUID")
                                                                                      String actionInvariantUuId,
                                                                                      @Context
                                                                                      javax.servlet.http.HttpServletRequest servletRequest)

Delete an action.

Parameters:

actionInvariantUuId - Invariant UUID of the action to be deleted.

servletRequest - Servlet request object.

Returns:

Empty response object.

actOnAction

@POST
 @Path(value="/{actionInvariantUUID}")
javax.ws.rs.core.Response actOnAction(@PathParam(value="actionInvariantUUID")
                                                                                   String actionInvariantUuId,
                                                                                   String requestJson,
                                                                                   @Context
                                                                                   javax.servlet.http.HttpServletRequest servletRequest)

Performs Checkout/Undo_Checkout/Checkin/Submit Operation on Action.

Returns:

Metadata object ActionResponseDto object for created Action.

uploadArtifact

@POST
 @Path(value="/{actionInvariantUUID}/artifacts")
 @Consumes(value="multipart/form-data")
javax.ws.rs.core.Response uploadArtifact(@PathParam(value="actionInvariantUUID")
                                                                                                                                        String actionInvariantUuId,
                                                                                                                                        String artifactName,
                                                                                                                                        String artifactLabel,
                                                                                                                                        String artifactCategory,
                                                                                                                                        String artifactDescription,
                                                                                                                                        String artifactProtection,
                                                                                                                                        @HeaderParam(value="Content-MD5")
                                                                                                                                        String checksum,
                                                                                                                                        org.apache.cxf.jaxrs.ext.multipart.Attachment artifactToUpload,
                                                                                                                                        @Context
                                                                                                                                        javax.servlet.http.HttpServletRequest servletRequest)

Upload an artifact to an action.

Parameters:

actionInvariantUuId - Invariant UUID of the action to which the artifact is uploaded.

artifactName - Name of the artifact.

artifactLabel - Label of the artifact.

artifactCategory - Category of the artifact.

artifactDescription - Description of the artifact.

artifactProtection - Artifact protection mode.

checksum - Checksum of the artifact.

artifactToUpload - Artifact content object.

servletRequest - Servlet request object.

Returns:

Generated UUID of the uploaded artifact.

downloadArtifact

@GET
 @Path(value="/{actionUUID}/artifacts/{artifactUUID}")
 @Produces(value="application/octet-stream")
javax.ws.rs.core.Response downloadArtifact(@PathParam(value="actionUUID")
                                                                                                                                                    String actionUuId,
                                                                                                                                                    @PathParam(value="artifactUUID")
                                                                                                                                                    String artifactUuId,
                                                                                                                                                    @Context
                                                                                                                                                    javax.servlet.http.HttpServletRequest servletRequest)

deleteArtifact

@DELETE
 @Path(value="/{actionInvariantUUID}/artifacts/{artifactUUID}")
javax.ws.rs.core.Response deleteArtifact(@PathParam(value="actionInvariantUUID")
                                                                                                                 String actionInvariantUuId,
                                                                                                                 @PathParam(value="artifactUUID")
                                                                                                                 String artifactUuId,
                                                                                                                 @Context
                                                                                                                 javax.servlet.http.HttpServletRequest servletRequest)

updateArtifact

@PUT
 @Path(value="/{actionInvariantUUID}/artifacts/{artifactUUID}")
 @Consumes(value="multipart/form-data")
javax.ws.rs.core.Response updateArtifact(@PathParam(value="actionInvariantUUID")
                                                                                                                                                      String actionInvariantUuId,
                                                                                                                                                      @PathParam(value="artifactUUID")
                                                                                                                                                      String artifactUuId,
                                                                                                                                                      String artifactName,
                                                                                                                                                      String artifactLabel,
                                                                                                                                                      String artifactCategory,
                                                                                                                                                      String artifactDescription,
                                                                                                                                                      String artifactProtection,
                                                                                                                                                      @HeaderParam(value="Content-MD5")
                                                                                                                                                      String checksum,
                                                                                                                                                      org.apache.cxf.jaxrs.ext.multipart.Attachment artifactToUpdate,
                                                                                                                                                      @Context
                                                                                                                                                      javax.servlet.http.HttpServletRequest servletRequest)