Skip to main content
M
MF_104105331-Visitor
1-Visitor
September 9, 2022
Solved

Software Content Management

  • September 9, 2022
  • 3 replies
  • 1704 views

I have some questions to the SCM.

Does the Software Content Management support a REST API? I can only find a JAVA API documented.

 

Best answer by nmutter

To extend on the first sentence: Everything you click in the SCM mashups you can also do via REST API. Every click basically just makes a REST call. Hard part is just to figure out which services you need with which parameters.

 

To find out which services to call you can go to the browsers DEV tools (F12) Network tab and have a look what calls are made. E.g. if you want to create an instruction based package like just follow the steps in the mashup with dev tools open:

nmutter_1-1663103940299.png

´When pressing Save I can see the following request in the Network console

nmutter_0-1663103914060.png

Now you know to "Save" a package you need to call on which thing which service http://flow.local.rnd.ptc.com/Thingworx/Things/TW.RSM.SFW.MashupHelper.Package/Services/CreateInstructionPackage and also which parameters.

For each step you do in the SCM you need to find the corresponding REST call. There are many calls which do things in the mashup but you only need the 'final' one to complete the step. There is no offical documentation stating which services you need for which step.

 

SideNote: If you do not use the mashups your logic may fail when PTC changes SCM later (maybe a REST call changes).

 

Hope that helps!

3 replies

V
VladimirRosu_11662719-Tanzanite
19-Tanzanite
September 9, 2022

As a basic capability, ThingWorx exposes almost all of its capabilities via REST. Very few exceptions exist to this rule.

Were you able to find a service that is documented in the JAVA API documentation but it is not present as a ThingWorx service?

If yes, can you share its name?

N
nmutter16-PearlAnswer
16-Pearl
September 13, 2022

To extend on the first sentence: Everything you click in the SCM mashups you can also do via REST API. Every click basically just makes a REST call. Hard part is just to figure out which services you need with which parameters.

 

To find out which services to call you can go to the browsers DEV tools (F12) Network tab and have a look what calls are made. E.g. if you want to create an instruction based package like just follow the steps in the mashup with dev tools open:

nmutter_1-1663103940299.png

´When pressing Save I can see the following request in the Network console

nmutter_0-1663103914060.png

Now you know to "Save" a package you need to call on which thing which service http://flow.local.rnd.ptc.com/Thingworx/Things/TW.RSM.SFW.MashupHelper.Package/Services/CreateInstructionPackage and also which parameters.

For each step you do in the SCM you need to find the corresponding REST call. There are many calls which do things in the mashup but you only need the 'final' one to complete the step. There is no offical documentation stating which services you need for which step.

 

SideNote: If you do not use the mashups your logic may fail when PTC changes SCM later (maybe a REST call changes).

 

Hope that helps!

V
24-Ruby III
VladimirN24-Ruby III
24-Ruby III
September 9, 2022

 Hi,

 

Here is a helpful article - "How to use ThingWorx REST API": https://www.ptc.com/en/support/article/CS329281 

M
MF_104105331-VisitorAuthor
1-Visitor
September 12, 2022

I just looked around the documentation and found the SCM in ThingWorx Utilities. Insiede this docu only the Java API was linked (https://support.ptc.com/help/thingworx/utilities/r9/de/#page/ThingWorx_Utilities%2FApiDocumentation.html). So how can I identify whether somwething is present as ThingWorx service?

V
VladimirRosu_11662719-Tanzanite
19-Tanzanite
September 12, 2022

Eh, that documentation lists also many services used by other components of ThingWorx Utilities (like the resource providers). In short, it's not only SCM that's in the Javadoc, and further complicating a bit, you'll see indeed also internal Java services that are used internally by the "userland" components.

First, select the com.thingworx.scm.api. You'll get to see only the SCMManagerApi class.

In there, all the non-protected methods are exposed in ThingWorx in the "SoftwareContentManagerApi" Thing - I know this because that class extends Thing.

But I must warn you, before jumping on executing this, you should really understand well what SCM does and its workflow. Remember that we do provide APIs for doing things, but SCM is primarily a fully built solution with an existing UI.

Terms & ConditionsAccessibility statement