Develop > API calls > Custom roles APIs > List all the custom roles

List all custom roles

Lists all the custom roles created in Codar. The response of the API contains the roles and lifecycle stage information associated with each role. The information retrieved through this API is specific to release pipeline management and does not contain the permissions and users who are a part of this role.

URI Method Parameters Returns

http://[host]:[port]/csa/api/codar/role

 GET

 

200 - updated
400 - bad request
404 - not found
500 - Server Exception

Example

The following URL was sent:

https://<codar server>:8444/csa/api/codar/role

The following JSON was returned:

{ "@total" : 5,
"@self" : "/csa/api/codar/role/",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role:collection",
"members" : [ {
"@self" : "/csa/api/codar/role/710e7e12cb8c4e8992bf9e7400a7301f",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role",
"name" : "CODAR_APPLICATION_DEVELOPER",
"displayName" : "Application Developer",
"description" : "The Application Developer can create, edit, delete, deploy package in development stage and promote package from development stage to testing stage.",
"icon" : "/csa/images/categories/role/service_consumer.png",
"editable" : false,
"permissions" : [ {
"name" : "APPLICATION_PACKAGE_DEPLOY",
"displayName" : "Package deploy",
"description" : "Allows to view and deploy and undeploy application packages" }, {
"name" : "APPLICATION_PACKAGE_PROMOTE",
"displayName" : "Package promote",
"description" : "Allows to view and promote application packages" } ],
"stages" : [ {
"@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a5", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "DEVELOPMENT",
"image" : "images/applications/dev.png",
"color" : "#D1AF89" } ] }, {
"@self" : "/csa/api/codar/role/4552b9da88a24767ac7e5b605f050df5",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role",
"name" : "CODAR_APPLICATION_ARCHITECT",
"displayName" : "Application Architect",
"description" : "The Application Architect can embrace component, create, edit, delete Application and application version, deploy, create, edit and delete package in development stage. Application Architect cannot reject package in any stage.",
"icon" : "/csa/images/categories/role/service_designer.png",
"editable" : false,
"permissions" : [ {
"name" : "APPLICATION_DESIGN_CREATE",
"displayName" : "Design create",
"description" : "Allow to embrace component, create, edit, delete application design and versions." }, {
"name" : "APPLICATION_PACKAGE_DEPLOY",
"displayName" : "Package deploy",
"description" : "Allows to view and deploy and undeploy application packages" }, {
"name" : "APPLICATION_CUSTOM_ROLE_CREATE",
"displayName" : "Custom role create",
"description" : "Allows to create, edit and delete custom role for application lifecycle management" } ],
"stages" : [ {
"@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a5", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "DEVELOPMENT",
"image" : "images/applications/dev.png", "color" : "#D1AF89" } ] }, {
"@self" : "/csa/api/codar/role/5e78c029ace644ce8778f3a50f88873b",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role",
"name" : "CODAR_APPLICATION_RELEASE_MANAGER",
"displayName" : "Application Release Manager",
"description" : "The Application Release Manager can deploy, reject, edit, delete package in staging and production stages and promote package from staging stage to production stage.", "icon" : "/csa/images/categories/role/service_business_manager.png",
"editable" : false, "permissions" : [ {
"name" : "APPLICATION_PACKAGE_DEPLOY",
"displayName" : "Package deploy",
"description" : "Allows to view and deploy and undeploy application packages" }, {
"name" : "APPLICATION_PACKAGE_PROMOTE",
"displayName" : "Package promote",
"description" : "Allows to view and promote application packages" }, {
"name" : "APPLICATION_PACKAGE_REJECT",
"displayName" : "Package reject",
"description" : "Allows to view and reject application packages" }, {
"name" : "APPLICATION_DASHBOARD_VIEW", "displayName" : "Dashboard view",
"description" : "Allows to view the package application dashboard" }, {
"name" : "APPLICATION_CUSTOM_ROLE_CREATE",
"displayName" : "Custom role create",
"description" : "Allows to create, edit and delete custom role for application lifecycle management" } ],
"stages" : [ {
"@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a7", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "STAGING", "image" : "images/applications/stage.png", "color" : "#E188CA" }, { "@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a8", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "PRODUCTION", "image" : "images/applications/prod.png", "color" : "#FF7D6A" } ] }, {
"@self" : "/csa/api/codar/role/40faa9a2769b451f8fecd1104260d062",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role",
"name" : "CODAR_APPLICATION_QA",
"displayName" : "Application QA",
"description" : "The Application QA can deploy, edit, delete and reject package in testing and staging stages and promote package from testing stage to staging stage.",
"icon" : "/csa/images/categories/role/service_consumer.png",
"editable" : false, "permissions" : [ {
"name" : "APPLICATION_PACKAGE_DEPLOY",
"displayName" : "Package deploy",
"description" : "Allows to view and deploy and undeploy application packages" }, {
"name" : "APPLICATION_PACKAGE_PROMOTE",
"displayName" : "Package promote",
"description" : "Allows to view and promote application packages" }, {
"name" : "APPLICATION_PACKAGE_REJECT",
"displayName" : "Package reject",
"description" : "Allows to view and reject application packages" } ],
"stages" : [ {
"@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a6", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "TESTING", "image" : "images/applications/test.png", "color" : "#FFC300" } ] }, { "@self" : "/csa/api/codar/role/6ff42967987c4a58ab5751817088607d",
"@type" : "urn:x-hp:2012:software:cloud:data_model:role",
"name" : "CODAR_APPLICATION_Operations_MANAGER",
"displayName" : "Application Operations Manager",
"description" : "The Application Operations Manager can deploy, reject, edit, delete package in staging stage.",
"icon" : "/csa/images/categories/role/service_staging_manager.png",
"editable" : false, "permissions" : [ {
"name" : "APPLICATION_PACKAGE_DEPLOY",
"displayName" : "Package deploy",
"description" : "Allows to view and deploy and undeploy application packages" }, {
"name" : "APPLICATION_PACKAGE_PROMOTE",
"displayName" : "Package promote",
"description" : "Allows to view and promote application packages" }, {
"name" : "APPLICATION_PACKAGE_REJECT",
"displayName" : "Package reject",
"description" : "Allows to view and reject application packages" } ],
"stages" : [ {
"@self" : "/csa/api/codar/app-lifecycle/stages/84905d24-d92f-4916-b312-78af206d31a7", "@type" : "urn:x-hp:2012:software:cloud:data_model:lifeCycleStage",
"name" : "STAGING", "image" : "images/applications/stage.png", "color" : "#E188CA" } ] } ] }
}

Send Help Center feedback