Sp-dev-docs: Schema for the actionParams JSON

Created on 7 Jul 2019  路  6Comments  路  Source: SharePoint/sp-dev-docs

In the context of column formatting in SharePoint, it is currently possible to trigger a Flow using the "action" : "executeFlow" in customRowAction of a button element. This is documented here https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting#create-a-button-to-launch-a-flow

Documentation and accompanying examples only show actionParams containing a escaped JSON with a single id attribute. Can other values be passed to actionParams, enabling parametrized execution of flows?

"customRowAction": {
        "action": "executeFlow",
        "actionParams": "='{\"id\": \"11441f46-d8eb-4137-9c7e-a085"}'"
}

Note: since this is a question I omitted the sections Steps to reproduce etc.

Category

  • [x] Question
  • [ ] Typo
  • [ ] Bug
  • [ ] Additional article idea
docs list-formatting powerautomate answered question

All 6 comments

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

This seems to be a question related to flow, not SharePoint development, correct? If so, your question should be posted to the flow community. This issue list is for SharePoint development issues.

https://powerusers.microsoft.com/t5/Microsoft-Flow-Community/ct-p/FlowCommunity

All the code I mentioned is applicable to SharePoint column formatting, and documented in a SharePoint development. I updated my question with the context and the appropriate references to the documentation, it was not very clear.
I鈥檇 assume the code base for parsing the JSON and make the API calls towards MS Flow lies on the SharePoint side, so I鈥檓 inclined to say this is the right repo.

You are correct, there are a couple of other options we should get documented there. Here is the full list of options:

  • id: ID of the Flow to launch (required)
  • headerText: Sets the text at the top of the flow panel (optional)
  • runFlowButtonText: Sets the text of the primary button in the flow panel (optional)

Here's an example of using all three:

"customRowAction": {
    "action": "executeFlow",
    "actionParams": "{\"id\":\"f7ecec0b-15c5-419f-8211-302a5d4e94f1\", \"headerText\":\"It's Flow Time!\",\"runFlowButtonText\":\"Do it\"}"
  }

The code above can be found in the rowactions sample: https://github.com/SharePoint/sp-dev-list-formatting/blob/master/column-samples/generic-rowactions/executeFlow.json

Closing issue as "answered". If you encounter similar issue(s), please open up a NEW issue. Thank you.

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

Was this page helpful?
0 / 5 - 0 ratings

Related issues

StfBauer picture StfBauer  路  3Comments

byrongits picture byrongits  路  3Comments

waldekmastykarz picture waldekmastykarz  路  3Comments

christianbueschi picture christianbueschi  路  3Comments

patrick-rodgers picture patrick-rodgers  路  3Comments