PSO REST APIs

Hi @Ann Degroat, here is an example from my Postman collection:

Endpoint:

{{baseUrl}}/api/v1/scheduling/data?dataType=SCHEDULE&waitForCompletion=true&includeOutput=true&compressed=false&submitCompressed=false

Body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dsScheduleData xmlns="http://360Scheduling.com/Schema/dsScheduleData.xsd">
    <Input_Reference>
        <id>Commit_Activity</id>
        <datetime>2022-03-01T07:00:00+01:00</datetime>
        <input_type>CHANGE</input_type>
        <dataset_id>LXDEMO</dataset_id>
        <account_id>smfsm6e1fsm14</account_id>
    </Input_Reference>
    <Activity_Status>
        <activity_id>A001-TUE</activity_id>
        <status_id>30</status_id>
        <resource_id>R10</resource_id>
        <date_time_stamp>2022-03-01T07:00:00+01:00</date_time_stamp>
        <date_time_status>2022-03-01T07:00:00+01:00</date_time_status>
    </Activity_Status>
</dsScheduleData>

For details of the XML, check out the Scheduling Schema guide.

Try to use a broadcast, here’s an example. First request the broadcast:

{{baseUrl}}/api/v1/scheduling/data?dataType=SCHEDULE&waitForCompletion=true&includeOutput=true&compressed=false&submitCompressed=false

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dsScheduleData xmlns="http://360Scheduling.com/Schema/dsScheduleData.xsd">
    <Input_Reference>
        <id>BCAST</id>
        <datetime>2022-03-01T07:00:00+01:00</datetime>
        <input_type>CHANGE</input_type>
        <dataset_id>LXDEMO</dataset_id>
        <account_id>YOUR ACCOUNT ID</account_id>
    </Input_Reference>
	<Broadcast>
		<id>0002</id>
		<description>Test Broadcast</description>
		<broadcast_type_id>POLLING</broadcast_type_id>
		<plan_type>COMPLETE</plan_type>
		<active>true</active>
		<minimum_plan_quality>98</minimum_plan_quality>
		<minimum_step_interval>1</minimum_step_interval>
		<once_only>true</once_only>
		<allocation_type>1</allocation_type>
		<input_reference_id>BCAST</input_reference_id>
	</Broadcast>
    <Broadcast_Parameter>
        <broadcast_id>0002</broadcast_id>
        <parameter_name>data_tables</parameter_name>
        <parameter_value>Resources</parameter_value>
    </Broadcast_Parameter>
</dsScheduleData>

LXDEMO Is the name of my dataset, 0002 is just an ID.

Then poll the broadcast result:

{{baseUrl}}/api/v1/scheduling/data?datasetId=LXDEMO&includeOutput=true&broadcastId=0002

Polling is just for testing, have a look at the documentation to see what other options you have with broadcasts.

Just fyi - there is also a reporting API on the roadmap (no promise!), which would allow you to get activities and resources directly. Watch out for the PSO release notes...

@Alexander Heinze thanks for providing the information about the APIs.

Regarding the broadcast, i assume it can be only used once (create a broadcast request), or can i create a broadcast request and request the data more than once with the same broadcastId?

Also, is there a way we can check the payload that PSO receives either from the REST API or when FSM sends? When a post call has been made we receives an internal id and also how we can check this. (Environments are hosted on Azure (IFS managed cloud))

Unfortunately the PSO 6.12 documentation we are unable to see.