Possible to modify job frames via REST or API?

Deadline
1

Is it possible to modify a job’s frame range using either the scripting or REST APIs? I can’t find anything in the scripting API docs, and the REST API seems to only map to a highly selective subset of the deadlinecommand commands.

Thanks.

2

Hello,

The APIs do not have any functionality like this as of the present version, but perhaps in the future we will see it added in. I know you can use the SetJobFrameRange option in deadline command though if that is an option for you.

3

That’s really too bad. The lack of an API method is really surprising, since deadlinecommand is obviously calling something internally. Also, given that the REST API is mostly just a remapping of some deadlinecommand commands, I’m really surprised the whole set isn’t available.

4

Hello Nathan,

So it appears in my answer I was half wrong. The REST API has a function to change the frame range and chunk size. In the REST python API there is a function called SetJobFrameRange, and if you want to interact directly with the web service then you would send a put request like this:

host:port/api/jobs with the message body of {“Command”:“setjobframerange”,“JobID”:somejobid, “FrameList”:theframelistasalist, “ChunkSize”:thechunksize}

I hope this helps.

5

Thanks for the follow-up information. I had tried using that exact request, but I think I was accidentally using a PUT request instead of a POST. I’ll give it another try.

6

Sorry for the delayed update, but this doesn’t actually work.

When I POST the JSON data, nothing happens. However, I get a response with a 200 status (which should mean “all good”), but the body says “Error: Must provide JobInfo, PluginInfo and AuxFiles entries.” So it seems Pulse handles all POST requests as job submission attempts. As mentioned previously, PUT doesn’t work either.

7

You actually do need to use PUT.

host:port/api/jobs with the message body of {“Command”:“setjobframerange”,“JobID”:somejobid, “FrameList”:theframeliststring, “ChunkSize”:thechunksize}

I have confirmed that if you do that exact command as a PUT request this works in Deadline 7.0. Deadline 6.2 does not have the option to modify the frame list in the REST API.

All POST requests for Jobs through the Web Service are handled as job submissions.

Hope that helps,

Ryan G.

8

Thanks Ryan. Still using 6.2 here, so that explains it.