Copy a list item using REST API - choice field with multiple selections allowed - why is this so difficult?

[M_Ott]

HELP! I'm trying to copy a list item from one list to another using the SharePoint REST API... I'm using the API because the Flow is configured in such a way as to support multiple sites containing that "same" list.

The list has a Choice field with multiple selections allowed (a checkbox), but I have yet to figure out how to structure the JSON for posting the item to the destination list... 

I've tried several things such as creating the item then updating it with the choice field (Flow runs and never seems to complete) and also adding the selected choices to the "body" to input to the REST API as a single delimited string (example "Designation":"Oak Street;#Pine Street;#Willow Street").  The latter gives the error "BadGateway" with the message "

Invalid choice value.\n\nA choice field contains invalid data. Please check the value and try again."

I have search the Internet in vain for any "official" documentation of how to do this with finding any useful results. Any help is greatly appreciated.

[annajhaveri · Accepted solution]

@M_Ott  please follow below steps to update multi valued choice field using REST API

1. In your browser, first browse to https://<siteurl>/_api/lists/getbytitle('<listtitle>')?$select=ListItemEntityTypeFullName

Replace <siteurl> with your site url and replace <listtitle> with your list title. This will show result in your browser, take the value that is between <d:ListItemEntityTypeFullName> tag. In my case it is SP.Data.ProjectsTestListItem

2. Now configure the "Send an HTTP request to SharePoint" as shown below

Uri: _api/Web/Lists/getByTitle('ProjectsTest')/Items(1)

Replace ProjectsTest with you list title and replace 1 with your item id which you want to update

Provide the all the header values as shown in screenshot

Provide below json in body parameter. Replace SP.Data.ProjectsTestListItem with your text that you have from the step 1. Replace choice values with your choice options that you want to save.

{
 "__metadata": { type: "SP.Data.ProjectsTestListItem" },
"Multichoice":
{
"__metadata":{"type":"Collection(Edm.String)"},
"results":["Choice 1","Choice 2","Choice 4"]
}
}

[M_Ott]

So I tried that ... when I try to create my list item on the target list I use:

{
  "__metadata": {
    "type": "SP.Data.@{variables('TargetList')}ListItem"
  },
  "Title": "@{variables('ItemTitle')}",
  "Submittal_x0020_Type": "@{variables('SubmittalType')}",
  "Submittal_x0020__x0023_": "@{variables('SubmittalNum')}",
  "Submittal_x0020_Version": "@{variables('SubmittalVersion')}",
  "Contract_x0020_Item_x0020_Number": "@{variables('ContractItemNumber')}",
  "Specification_x0020__x0023_": "@{variables('SpecificationNum')}",
  "SubmittalStatus": "@{variables('Status')}",
  "Submittal_x0020_Comments": "@{variables('Comments')}",
  "Discipline": "@{variables('Discipline')}",
  "Designation": {
    "__metadata": {
      "type": "Collection(Edm.String)"
    },
    "results": @{variables('Designation')}
  },
  "Submitted_x0020_ById": "@{variables('SubmittedByID')}"
}

where the variable designation is an Array

I get the following error

Incompatible type kinds were found. The type 'Collection(Edm.String)' was found to be of kind 'Collection' instead of the expected kind 'Primitive'.

If I remove the __metadata bit like so:

{
  "__metadata": {
    "type": "SP.Data.@{variables('TargetList')}ListItem"
  },
  "Title": "@{variables('ItemTitle')}",
  "Submittal_x0020_Type": "@{variables('SubmittalType')}",
  "Submittal_x0020__x0023_": "@{variables('SubmittalNum')}",
  "Submittal_x0020_Version": "@{variables('SubmittalVersion')}",
  "Contract_x0020_Item_x0020_Number": "@{variables('ContractItemNumber')}",
  "Specification_x0020__x0023_": "@{variables('SpecificationNum')}",
  "SubmittalStatus": "@{variables('Status')}",
  "Submittal_x0020_Comments": "@{variables('Comments')}",
  "Discipline": "@{variables('Discipline')}",
  "Designation": {
    "results": @{variables('Designation')}
  },
  "Submitted_x0020_ById": "@{variables('SubmittedByID')}"
}

I get this error

An unexpected 'StartObject' node was found when reading from the JSON reader. A 'PrimitiveValue' node was expected.

[annajhaveri]

@M_Ott  can you please double check if your choice field is multi valued, i had got the same error when my choice field was not multi valued.

[M_Ott]

Yes, it is multiple choice.. here's a screen cap of the edit form showing the choices and the two items that have been selected.

[M_Ott]

@annajhaveri Actually that was it!  I was using site content types for my two lists and I *thought* I had changed the site column but had not actually checked it.  The site's admin had changed the choice field at the list level to allow multiple selections which was confusing things.  After I changed to site column in question, your code did indeed work.  So, I'm both relieved and disappointed in myself at the same time!

The moral of the story is ALWAYS CHECK YOUR INPUTS

[annajhaveri]

@M_Ott  i am glad that you figured it out and solution worked for you.