Sharepoint Rest Api in SPFX Update/Create taxonomy field value

 Scenario - creating custom form for SPListItem, with stuff... all html/css/js/ts

When sending primitive values such as string/number/bool/choice, you just need to find the internal name of your field and give the actual value, example:

Title : "My Awesome Achievements!!"

to find the internal name just go to your SPList => list settings -> click your column => on the end of the URL you will find &Field=MyFieldInternalName

so if my field is named "My Best Quality" and you click that you should see something like "myBestQuality" and your code should send

{ 

  Title : "My Awesome Achievements!!",

  myBestQuality : "I Can Think!" 

}

PS - the internal name can be very very different from the Display Name.

PS2 -  the internal name be encoding like "_x8473_x8573", in that case your internal name is "odata__x8473_x8573"


When we want People columns we need to get the userId and send that while adding "Id" to the internal name like:

{ 

  Title : "My Awesome Achievements!!",

  myBestQuality : "I Can Think!", 

  projectManagerId: 148, 

}

I wont get into how we get our list of users, but... use this endpoint "/_api/web/SiteUsers"


For TAXONOMY fields it gets interesting...

PS3 - get your taxo tree with this awesome code from git


Single Taxo need just the term guid

valueForRest = {

    TermGuid: valueOfGuid, 

    WssId: -1

}

and then the body is

{ 

  Title : "My Awesome Achievements!!",

  myBestQuality : "I Can Think!", 

  projectManagerId: 148, 

  singleTaxoField: valueForRest, 

}


and now for the real fun... TaxonomyFieldTypeMulti


first, you need the Hidden Name of the column which is a guid of sort, and can be acquired via the api like this 

say i have a field named "My Coool Multi Taxo" (thats the display name!) i will go to this endpoint:

/sites/New-Proj/_api/web/lists/GetByTitle('My Coll List')/Fields/GetByTitle('My Coool Multi Taxo_0')/InternalName

that will retrieve something like "h01c0d38859b5538868471f40a78f4c4" and that is our column name for the body.

next, is how we build the value for this multi taxo, its like "'-1;#TermName|TermGuid;'" and seperated by #.



=======================================================

=======================================================

=======================================================



Let me show my final code, the HTML is rendered with angular, your can easily remake it in your TS, print the options with a for loop, and use "addEventListener" for "input" event.

      <select multiple (input)="emitInput($event)">

        <option value="" selected></option>

        <option *ngFor="let c of plTaxo" [value]="c.guid" >{{c.name}}</option>

     </select>  

next creating the REAL value (the "h01c0d38859b5538868471f40a78f4c4" i took manually since i needed only 1). event is the JS event from the "select" element "input" event

  emitInput(event: any) {

        let terms = event.target.selectedOptions as HTMLCollection

        value = ''

        for (let i = 0; i < terms.length; i++) {

          let t = terms[i] as HTMLOptionElement

          value += `-1#;${t.text}|${t.value};#`

        }

        value = value.slice(0, -1)

        this.myService.setValueToBody(

             "h01c0d38859b5538868471f40a78f4c4", value )

}


BONUS my generic create item function:

    public createListItemInWeb(web:string, listName: string, body: object): Promise<any> {
        const spOpts: string = JSON.stringify(body);
        let promise = new Promise((resolve, reject) => {
            this.context.spHttpClient.post(`${web}/_api/web/lists/GetByTitle('${listName}')/items`, SPHttpClient.configurations.v1, {
                headers: {
                    'Accept': 'application/json;odata=nometadata',
                    'Content-type': 'application/json;odata=nometadata',
                    'odata-version': ''
                },
                body: spOpts
            })
                .then((response: SPHttpClientResponse) => {
                     response.json().then((responseJSON: JSON) => {
                        console.log(responseJSON);
                        resolve(responseJSON);
                    });
                });
        });
        return promise
    }


HAVE FUN

Comments

Post a Comment

Popular posts from this blog

OverTheWire[.com] Natas Walkthrough - JUST HINT, NO SPOILERS

game portal: http://overthewire.org/wargames/natas/ PASSWORDS for each level are stored in /etc/natas_webpass/natasX I made this walkthrough for people like me, i needed some help, but didnt want the spoiler, so here i will give you all the information needed to pass each level, yet not the solution. For levels needed custom web request i made a different post for powershell and javascript  with how-to's, since is a piece of learning for itself, and also for those of us that play at work and have only powershell at their hands. Although its not a complete spoiler there, its quite most of the solution so try yourself 1st. Natas The Natas game is from basic to advances web hacking. Every few levels is about whole new exploitation (with some harder ones doing comeback later), so a lot of learning. If you're new, you're the reason i am writing so much even for the 1st level, just please google EVERY topic you see, since in the following levels i assume you know the ...
Read more

Asp.Net Ending Response options, Response.End() vs CompleteRequest()

this blog is for any1 who get the ThreadAbortException when caling Response.End(), and then tried the other options such as HttpContext.Current.ApplicationInstance.CompleteRequest() and found out that there was no replacement. i'll start with the bottom line: if you want to stop right now your response and send it as is you dont have any other option other than Response.End(), period and it's the right thing to throw that EX in that case. the answer is its because there is the "HTTP pipeline" and the "Asp.Net pipeline", and CompleteRequest() cuts the HTTP pipeline but not the Asp.Net one so everything that is from handlers forwars (including all page events) continues but your part, the asp one, stays in your hands so that no information will be lost, so ur suppose to manage your code currectly, since information lost is really a bad thing, although in most cases we use Response.End() we know what we are losing and we want it. see this short article ab...
Read more

SOLVED The item could not be indexed successfully because the item failed in the indexing subsystem

if you got an error like this The item could not be indexed successfully because the item failed in the indexing subsystem. ( The item could not be indexed successfully because the item failed in the indexing subsystem.; Failed to recover content group; Aborting insert of item in Link Database because it was not inserted to the Search Index.; ; SearchID = 04081656-B51B-4DCD-96D4-6DB2D2CEEEE7 ) as well as these: The item could not be indexed successfully because the item failed in the indexing subsystem. ( The item could not be indexed successfully because the item failed in the indexing subsystem.; Caught exception when preparing generation GID[7]: (Previous generation (last=GID[6], curr=GID[7]) is still active. Cannot open GID[7]); Aborting insert of item in Link Database because it was not inserted to the Search Index.; ; SearchID = 92EB0180-C086-4853-BED8-F4878D9748AD ) the solution for me was to clear configuration cache (PS)  and then restart SP Search Services. THX ...
Read more