Get workflowItemId for entity via API

To perform feedback from BPM to OroCRM I need to transit workflow item for opportunity entity to next step via api. To do this I need to know ID of workflow item associated with opportunity entity because of requirements of API method:

/api/rest/{version}/workflow/transit/{workflowItemId}/{transitionName}

To get workflow item ID I tried to get this information by call get opportunity method:

/api/rest/{version}/opportunities/{id}

For my test opportunity I’ve got this result (for debug I switched off WSSE authentication):

$ curl -i -H "Accept: application/json" --user nixikanius:q123 http://localhost:4001/app_dev.php/api/rest/v1/opportunities/72.json HTTP/1.1 200 OK Date: Wed, 06 Aug 2014 13:50:57 GMT Server: Apache/2.2.22 (Debian) X-Powered-By: PHP/5.5.14-1~dotdeb.1 Set-Cookie: CRMID=tcdo2fh9jg7g4klq57tqbce871; path=/; HttpOnly Cache-Control: no-cache X-Debug-Token: e54474 Vary: Accept-Encoding Connection: close Transfer-Encoding: chunked Content-Type: application/json {"id":72,"name":"Buckeye Furniture","closeDate":"2014-08-04T00:00:00+00:00","probability":1,"budgetAmount":null,"closeRevenue":"1.0000","customerNeed":"2416","proposedSolution":"5893","createdAt":"2014-07-18T14:16:33+00:00","updatedAt":"2014-08-06T13:50:52+00:00","notes":null,"status":"In Progress","closeReason":"Won","contact":"Ema Bade","account":"Buckeye Furniture","lead":"Buckeye Furniture","owner":"simon.pace_22dcc","workflowItem":{"__initializer__":{},"__cloner__":{},"__isInitialized__":false},"workflowStep":{"__initializer__":{},"__cloner__":{},"__isInitialized__":false}}

1 2 3 4 5 6 7 8 9 10 11 12 13 14

$ curl -i -H "Accept: application/json" --user nixikanius:q123 http://localhost:4001/app_dev.php/api/rest/v1/opportunities/72.json HTTP/1.1 200 OK Date: Wed, 06 Aug 2014 13:50:57 GMT Server: Apache/2.2.22 (Debian) X-Powered-By: PHP/5.5.14-1~dotdeb.1 Set-Cookie: CRMID=tcdo2fh9jg7g4klq57tqbce871; path=/; HttpOnly Cache-Control: no-cache X-Debug-Token: e54474 Vary: Accept-Encoding Connection: close Transfer-Encoding: chunked Content-Type: application/json   {"id":72,"name":"Buckeye Furniture","closeDate":"2014-08-04T00:00:00+00:00","probability":1,"budgetAmount":null,"closeRevenue":"1.0000","customerNeed":"2416","proposedSolution":"5893","createdAt":"2014-07-18T14:16:33+00:00","updatedAt":"2014-08-06T13:50:52+00:00","notes":null,"status":"In Progress","closeReason":"Won","contact":"Ema Bade","account":"Buckeye Furniture","lead":"Buckeye Furniture","owner":"simon.pace_22dcc","workflowItem":{"__initializer__":{},"__cloner__":{},"__isInitialized__":false},"workflowStep":{"__initializer__":{},"__cloner__":{},"__isInitialized__":false}}

Result of call says me that no workflow item associated with my opportunity entity, but I know that is not right:

ID of associated workflow entity is 97. How can I get this via API to perform transit?

Topic

[Yevhen ShyshkinParticipant]

Hello, Nikita.

Probably, there are no easy answer to your question. We need to refactor entities API so they return relation information (workflow item ID, workflow step ID etc), and need to create API method that will return workflow item information not only by workflow item ID, but also by class + identifier.

For now you can implement your API method in your bundle to proxy WorkflowManager::getWorkflowItemByEntity into API. We would really appreciate if you’d do pull request to WorkflowBundle with this method. :)

[Nikita PetrovParticipant]

Yevhen, thank you. I will try.

[roldanParticipant]

Hi,

Is there any news about getting workflowItem and workflowStep through API?
I’m using ApiEntityManager::getSerializationConfig() to set the fields that cget will return but cannot add workflowItem there because I get 500 error.

Thanks,
Matias

[mfejczarukParticipant]

Hello,
Please provide logs and environment information so we can see where’s the problem.
Best regards

[Author]

Replies