Yleistä
Nämä ohjeet selittävät kuinka voit lisätä yksittäisen tiedoston halutulle entiteetille RESTiä käyttäen. Onnistuneeseen prosessiin vaaditaan muutama avainasia. Käyttäjän täytyy määrittää mihin moduuliin [module] he haluavat lisätä tiedoston ja mihin entiteettiin [id] tiedosto liitetään. Valtuutuksena toimii bearer [token] ja [crm_address] on domain-nimesi.
Alla oleva esimerkki näyttää kuinka tehdä tiedoston lisääminen HTTP:n POST metodilla:
POST /api/v1/[module]/[id]/files HTTP/1.1 Accept: application/vnd.api+json Content-Type: multipart/form-data; boundary=---011000010111000001101001 Authorization: Bearer [token] Host: [crm_address] Content-Length: 377 -----011000010111000001101001 Content-Disposition: form-data; name="file"; filename="example.txt" Content-Type: text/plain -----011000010111000001101001 Content-Disposition: form-data; name="attributes[file_usage_type]" Entity Attachment -----011000010111000001101001 Content-Disposition: form-data; name="attributes[file_category]" Category -----011000010111000001101001-- Content-Disposition: form-data; name="attributes[file_access_type]" Internal -----011000010111000001101001-- |
Esimerkki on samanlainen kuin standardi HTML-lomake tiedoston lähetyksellä. Se, mitä paikallista tiedostoa käytetään määritetään yllä olevassa kutsussa kohdassa name=”file”; filename=”example.txt” eli tämä esimerkki lisäisi kohteeseen example.txt tiedoston. Esimerkissä käytetyt tiedoston attribuutit ovat pakollisia, mutta voit lisätä tiedostoon myös muita attribuutteja.
Seuraava esimerkki näyttää miten sama POST-pyyntö tehdään Curl-ohjelmalla:
curl --request POST \ --url https://[crm_address]/api/v1/[module]/[id]/files \ --header 'Accept: application/vnd.api+json' \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer [token]' \ --form 'file=@[full_file_path]' \ --form 'attributes[file_usage_type]=Internal' \ --form 'attributes[file_category]=Category' |
Yllä olevassa esimerkissä se, mitä paikallista tiedostoa käytetään määritellään kohdassa [full_file_path] johon syötetään halutun tiedoston absoluuttinen polku.