[JENKINS-8927] Create a view from the XML API - Jenkins Jira

XML

Word

Printable

Details

Type: New Feature
Status: Open (View Workflow)
Priority: Major
Resolution: Unresolved
Component/s: core
Labels:
- view

Similar Issues:

Show

Description

Hello,

It's not possible to create a view from the API, since the views are part of the Hudson config.xml itself, it seems that the createItem URL doesn't match the need as it looks designed to create the new config.xml for a dedicated job.

The REST API could be some thing like:

GET http://myserver:8080/view (All views)
GET http://myserver:8080/view/myView (switch to Specific view - myView)
POST http://myserver:8080/view (Create new view as defined in the posted XML)

Can you please have a look?

Thanks and regards,

Julien

Attachments

Issue Links

is related to

JENKINS-23172 Config file provided via the REST api is missing "owner" tags

Open

JENKINS-9264 Create a new job into a view via REST API

Open

Activity

Ascending order - Click to sort in descending order

Julien Faucher created issue - 2011-03-02 10:04

William Zhang made changes - 2012-05-28 09:20

Field	Original Value	New Value
Labels		view

Rüdiger zu Dohna made changes - 2012-07-03 15:54

Link

This issue is related to JENKINS-9264 [ JENKINS-9264 ]

Simon Endele added a comment - 2012-07-24 12:17

It is possible to create a view, though it's a bit complicated:
wget --post-data='name=ViewX&mode=hudson.model.ListView&json=

{"name": "ViewX", "mode": "hudson.model.ListView"}

' http://.../jenkins/createView

Both parameters "name" and "mode" are required twice, as POST parameter and in the json argument. If one is missing, Jenkins responds with "400 Bad Request".
I think this URL is not meant to be used as remote REST API, but it actually can.

I would suggest to fix the problem above, so that either POST parameters can be used or a JSON snippet can be posted.

Simon Endele added a comment - 2012-07-24 12:17 It is possible to create a view, though it's a bit complicated: wget --post-data='name=ViewX&mode=hudson.model.ListView&json= {"name": "ViewX", "mode": "hudson.model.ListView"} ' http://.../jenkins/createView Both parameters "name" and "mode" are required twice, as POST parameter and in the json argument. If one is missing, Jenkins responds with "400 Bad Request". I think this URL is not meant to be used as remote REST API, but it actually can. I would suggest to fix the problem above, so that either POST parameters can be used or a JSON snippet can be posted.

Nalin Makar added a comment - 2013-01-28 02:46

another option:

java -jar jenkins-cli.jar -s <jenkins_url> groovy createView.groovy --username <user> --password <passwd>

where createView.groovy contains

hudson.model.Hudson.instance.addView(new hudson.model.ListView("ViewX"))

Nalin Makar added a comment - 2013-01-28 02:46 another option: java -jar jenkins-cli.jar -s <jenkins_url> groovy createView.groovy --username <user> --password <passwd> where createView.groovy contains hudson.model.Hudson.instance.addView(new hudson.model.ListView("ViewX"))

Patrik Boström added a comment - 2014-02-10 14:29 - edited

Found this by looking through the source code:
It is possible in Jenkins 1.509.4 to create views via the REST api

view.xml:

 
<?xml version="1.0" encoding="UTF-8"?>
<hudson.model.ListView>
<name>MyView</name>
<filterExecutors>false</filterExecutors>
<filterQueue>false</filterQueue>
<properties class="hudson.model.View$PropertyList"/>
<jobNames>
<comparator class="hudson.util.CaseInsensitiveComparator"/>
</jobNames>
<jobFilters/>
<columns>
<hudson.views.StatusColumn/>
<hudson.views.WeatherColumn/>
<hudson.views.JobColumn/>
<hudson.views.LastSuccessColumn/>
<hudson.views.LastFailureColumn/>
<hudson.views.LastDurationColumn/>
<hudson.views.BuildButtonColumn/>
</columns>
</hudson.model.ListView>

Create the view:

curl -vvv -X POST -d @view.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/createView?name=MyView

Get the configuration:

curl http://localhost:8080/jenkins/view/MyView/config.xml

Update the view:

curl -X POST -d @view.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/view/MyView/config.xml

Patrik Boström added a comment - 2014-02-10 14:29 - edited Found this by looking through the source code: It is possible in Jenkins 1.509.4 to create views via the REST api view.xml: <?xml version= "1.0" encoding= "UTF-8" ?> <hudson.model.ListView> <name> MyView </name> <filterExecutors> false </filterExecutors> <filterQueue> false </filterQueue> <properties class= "hudson.model.View$PropertyList" /> <jobNames> <comparator class= "hudson.util.CaseInsensitiveComparator" /> </jobNames> <jobFilters/> <columns> <hudson.views.StatusColumn/> <hudson.views.WeatherColumn/> <hudson.views.JobColumn/> <hudson.views.LastSuccessColumn/> <hudson.views.LastFailureColumn/> <hudson.views.LastDurationColumn/> <hudson.views.BuildButtonColumn/> </columns> </hudson.model.ListView> Create the view: curl -vvv -X POST -d @view.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/createView?name=MyView Get the configuration: curl http://localhost:8080/jenkins/view/MyView/config.xml Update the view: curl -X POST -d @view.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/view/MyView/config.xml

Oleg Nenashev added a comment - 2014-05-20 14:21

@Patrik
Should we consider the issue as "Resolved"?

Oleg Nenashev added a comment - 2014-05-20 14:21 @Patrik Should we consider the issue as "Resolved"?

Daniel Beck added a comment - 2014-05-21 22:57

Oleg: Needs to be documented on the /view/Foo/api page, similar to 'Create Job' on /api.

Daniel Beck added a comment - 2014-05-21 22:57 Oleg: Needs to be documented on the /view/Foo/api page, similar to 'Create Job' on /api.

Daniel Beck made changes - 2014-06-12 08:56

Link

This issue is related to JENKINS-23172 [ JENKINS-23172 ]

Lukasz Tasz added a comment - 2015-01-23 14:12

this solution works pretty well with few limitation:

nestedView plugin does not register it's own class and curl end with exception that NestedView is not resolved.
in case of subviews, xml needs to be extended with <parent> node, unfortunately in case of coping view a to b, parent node is not visible.

Lukasz Tasz added a comment - 2015-01-23 14:12 this solution works pretty well with few limitation: nestedView plugin does not register it's own class and curl end with exception that NestedView is not resolved. in case of subviews, xml needs to be extended with <parent> node, unfortunately in case of coping view a to b, parent node is not visible.

R. Tyler Croy made changes - 2016-07-25 23:49

Workflow

JNJira [ 139071 ]

JNJira + In-Review [ 175010 ]

rajasekaran radhakrishnan added a comment - 2017-02-01 11:59

patbos oleg_nenashev
May I know the folder location of my view configuration page.

curl http://localhost:8080/jenkins/view/MyView/config.xml is not working for me.

-raja

rajasekaran radhakrishnan added a comment - 2017-02-01 11:59 patbos oleg_nenashev May I know the folder location of my view configuration page. curl http://localhost:8080/jenkins/view/MyView/config.xml is not working for me. -raja

rajasekaran radhakrishnan added a comment - 2017-02-01 12:04 - edited

Also I am unable to create new view using curl

curl -vvv -X POST -d @viewconfig.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/createView?name=My-Test-View -u admin:e973b7863cbsa11dsacdf2cd9db758091
Note: Unnecessary use of -X or --request, POST is already inferred.

Trying 127.0.0.1...
Connected to localhost (127.0.0.1) port 8080 (#0)
Server auth using Basic with user 'admin'
> POST /jenkins/createView?name=My-Test-View HTTP/1.1
> Host: localhost:8080
> Authorization: Basic YWRtaW46ZTk3M2dsDYzY2IwNTExNzlhY2FmDEWViNzIwOTE=
> User-Agent: curl/7.47.0
> Accept: /
> Content-Type: text/xml
> Content-Length: 1410
> Expect: 100-continue
>
< HTTP/1.1 404 Not Found
< Date: Wed, 01 Feb 2017 12:00:48 GMT
< X-Content-Type-Options: nosniff
< Content-Type: text/html; charset=ISO-8859-1
< Cache-Control: must-revalidate,no-cache,no-store
< Content-Length: 302
< Connection: close
< Server: Jetty(9.2.z-SNAPSHOT)
<
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Error 404 Not Found</title>
</head>
<body><h2>HTTP ERROR 404</h2>
<p>Problem accessing /jenkins/createView. Reason:
<pre> Not Found</pre></p><hr><i><small>Powered by Jetty://</small></i><hr/>

</body>
</html>

Closing connection 0

rajasekaran radhakrishnan added a comment - 2017-02-01 12:04 - edited Also I am unable to create new view using curl curl -vvv -X POST -d @viewconfig.xml -H "Content-Type: text/xml" http://localhost:8080/jenkins/createView?name=My-Test-View -u admin:e973b7863cbsa11dsacdf2cd9db758091 Note: Unnecessary use of -X or --request, POST is already inferred. Trying 127.0.0.1... Connected to localhost (127.0.0.1) port 8080 (#0) Server auth using Basic with user 'admin' > POST /jenkins/createView?name=My-Test-View HTTP/1.1 > Host: localhost:8080 > Authorization: Basic YWRtaW46ZTk3M2dsDYzY2IwNTExNzlhY2FmDEWViNzIwOTE= > User-Agent: curl/7.47.0 > Accept: / > Content-Type: text/xml > Content-Length: 1410 > Expect: 100-continue > < HTTP/1.1 404 Not Found < Date: Wed, 01 Feb 2017 12:00:48 GMT < X-Content-Type-Options: nosniff < Content-Type: text/html; charset=ISO-8859-1 < Cache-Control: must-revalidate,no-cache,no-store < Content-Length: 302 < Connection: close < Server: Jetty(9.2.z-SNAPSHOT) < <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <title>Error 404 Not Found</title> </head> <body><h2>HTTP ERROR 404</h2> <p>Problem accessing /jenkins/createView. Reason: <pre> Not Found</pre></p><hr><i><small>Powered by Jetty://</small></i><hr/> </body> </html> Closing connection 0

rajasekaran radhakrishnan added a comment - 2017-02-01 12:13

PFB the error while creating new view.

curl -X POST 'http://admin:password@localhost:8080/jenkins/createView?name=My-Test-View' --data-binary @viewconfig.xml -H "Content-Type: text/xml"

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Error 404 Not Found</title>
</head>
<body><h2>HTTP ERROR 404</h2>
<p>Problem accessing /jenkins/createView. Reason:
<pre> Not Found</pre></p><hr><i><small>Powered by Jetty://</small></i><hr/>

</body>
</html>

My configuration file lokks:

<?xml version="1.0" encoding="UTF-8"?>
<au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView plugin="build-pipeline-plugin@1.5.6">
<name>my-test-view</name>
<description>my-test-view for check</description>
<filterExecutors>false</filterExecutors>
<filterQueue>false</filterQueue>
<properties class="hudson.model.View$PropertyList"/>
<gridBuilder class="au.com.centrumsystems.hudson.plugin.buildpipeline.DownstreamProjectGridBuilder">
<firstJob>ecs-testing</firstJob>
<firstJobLink>job/ecs-testing/</firstJobLink>
</gridBuilder>
<noOfDisplayedBuilds>2</noOfDisplayedBuilds>
<buildViewTitle>my-test-view for check</buildViewTitle>
<consoleOutputLinkStyle>Lightbox</consoleOutputLinkStyle>
<cssUrl></cssUrl>
<triggerOnlyLatestJob>false</triggerOnlyLatestJob>
<alwaysAllowManualTrigger>false</alwaysAllowManualTrigger>
<showPipelineParameters>false</showPipelineParameters>
<rowHeaders class="au.com.centrumsystems.hudson.plugin.buildpipeline.extension.SimpleRowHeader"/>
<showPipelineParametersInHeaders>false</showPipelineParametersInHeaders>
<columnHeaders class="au.com.centrumsystems.hudson.plugin.buildpipeline.extension.NullColumnHeader"/>
<startsWithParameters>false</startsWithParameters>
<refreshFrequency>3</refreshFrequency>
<showPipelineDefinitionHeader>false</showPipelineDefinitionHeader>
</au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView>

Regards,
Raja

rajasekaran radhakrishnan added a comment - 2017-02-01 12:13 PFB the error while creating new view. curl -X POST 'http://admin:password@localhost:8080/jenkins/createView?name=My-Test-View' --data-binary @viewconfig.xml -H "Content-Type: text/xml" <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <title>Error 404 Not Found</title> </head> <body><h2>HTTP ERROR 404</h2> <p>Problem accessing /jenkins/createView. Reason: <pre> Not Found</pre></p><hr><i><small>Powered by Jetty://</small></i><hr/> </body> </html> My configuration file lokks: <?xml version="1.0" encoding="UTF-8"?> <au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView plugin="build-pipeline-plugin@1.5.6"> <name>my-test-view</name> <description>my-test-view for check</description> <filterExecutors>false</filterExecutors> <filterQueue>false</filterQueue> <properties class="hudson.model.View$PropertyList"/> <gridBuilder class="au.com.centrumsystems.hudson.plugin.buildpipeline.DownstreamProjectGridBuilder"> <firstJob>ecs-testing</firstJob> <firstJobLink>job/ecs-testing/</firstJobLink> </gridBuilder> <noOfDisplayedBuilds>2</noOfDisplayedBuilds> <buildViewTitle>my-test-view for check</buildViewTitle> <consoleOutputLinkStyle>Lightbox</consoleOutputLinkStyle> <cssUrl></cssUrl> <triggerOnlyLatestJob>false</triggerOnlyLatestJob> <alwaysAllowManualTrigger>false</alwaysAllowManualTrigger> <showPipelineParameters>false</showPipelineParameters> <rowHeaders class="au.com.centrumsystems.hudson.plugin.buildpipeline.extension.SimpleRowHeader"/> <showPipelineParametersInHeaders>false</showPipelineParametersInHeaders> <columnHeaders class="au.com.centrumsystems.hudson.plugin.buildpipeline.extension.NullColumnHeader"/> <startsWithParameters>false</startsWithParameters> <refreshFrequency>3</refreshFrequency> <showPipelineDefinitionHeader>false</showPipelineDefinitionHeader> </au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView> Regards, Raja

Daniel Beck added a comment - 2017-02-01 12:15

rajraja This is an issue tracker, not a support site. Please don't ask support type questions here. (Also, please don't ask where to ask. Just search a bit.)

Daniel Beck added a comment - 2017-02-01 12:15 rajraja This is an issue tracker, not a support site. Please don't ask support type questions here. (Also, please don't ask where to ask. Just search a bit.)

People

Assignee:: Unassigned

Reporter:: Julien Faucher

Votes:: 9 Vote for this issue

Watchers:: 14 Start watching this issue

Dates

Created:: 2011-03-02 10:04

Updated:: 2017-02-01 12:15