Create and Update Profiles using REST (deprecated api)

Owned by Andy Brook [Plugin People]
Last updated: Oct 31, 2022 by Mike Harrison
1 min read

This API is deprecated, use /jemh/1.0/public/ instead. See Use JEMH Public Rest API to Export, Import and Update profiles for more information.

Why?

You may want to hard commit your JEMH Profiles into source control, maybe you want to replicate configuration over multiple instances...

How it works

JEMH has supported a Profile export/ import in XML format forever.  Recently we enabled Profile update through the Customer Acceptance Testing feature, but it wasn't possible to use REST, but we've now added some rest endpoints to allow the standard JEMH XML files to be uploaded and even updated.

Endpoints

CREATE

/rest/jemh/1.0/api/profile/create

UPDATE

/rest/jemh/1.0/api/profile/update

Deploying a new Profile

Is as easy as:

curl -v -X POST -F "profileXml=@profile.xml" --user admin:admin http://localhost:8080/rest/jemh/1.0/api/profile/create

Updating an existing Profile

The Profile XML contains a <profileId> element, we use that on upload to locate an existing profile, and if its found, we update ALL profile fields. 

 During update, all 'top level' configuration fields are just overwritten, the lower level object graphs (eg Project Mappings) are deleted and rebuilt, so, one should probably not do this on a busy live system.

curl -v -X POST -F "profileXml=@profile.xml" --user admin:admin http://localhost:8080/rest/jemh/1.0/api/profile/update