{ "info": { "_postman_id": "ea69c9fd-0cc7-42b7-a855-9831a8a509c8", "name": "Sitefinity Web Services", "description": "This is a collection of sample request supported by Sitefinity Web Services REST API.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "CRUD", "item": [ { "name": "Read an entity set", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ] }, "description": "One of the most common responses from a REST API is a collection of resources. In this case we asked for the Job Openings collection. For each response, the Sitefinity service writes a self-described response (another REST principle) by annotating the response with a context URL. This context URL tells the service that the contents of the response are a collection of things in the Job Openings entity set.\n\nIf the @odata.nextLink annotation is present, the server opted to split the result set across multiple pages. The client can also drive paging using $top and $skip, but server-side paging is a mitigation against DoS attacks. The value property contains the bulk of the response." }, "response": [] }, { "name": "Create an entity", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"content_item_id\", jsonData.Id);", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"Title\": \"News item 1\"\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ] }, "description": "To create a resource, send a POST to a collection. The request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Update an entity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\tTitle: \"Updated news item\"\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})" ] }, "description": "To update a resource, send a PATCH request with the properties you wish to modify. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Get a single entity from an entity set", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})" ] }, "description": "To get a particular entity from a collection, append an id segment enclosed in brackets." }, "response": [] }, { "name": "Select what fields to return from an entity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "tests[\"Response is a primitive number\"] = !isNaN(parseFloat(responseBody)) && isFinite(responseBody) === true;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})?$select=Title, Summary", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})" ], "query": [ { "key": "$select", "value": "Title, Summary" } ] } }, "response": [] }, { "name": "Select all fields to return from an entity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "tests[\"Response is a primitive number\"] = !isNaN(parseFloat(responseBody)) && isFinite(responseBody) === true;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})?$select=*", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})" ], "query": [ { "key": "$select", "value": "*" } ] } }, "response": [] }, { "name": "Delete an entity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_with_taxon_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_with_taxon_id}})" ] }, "description": "To remove a resource, send an HTTP DELETE to the resource URL. Authorization header with a token is usually required for those requests." }, "response": [] } ] }, { "name": "Filter", "item": [ { "name": "Filter a collection", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=contains(Title,'news')", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "contains(Title,'news')" } ] }, "description": "The *$filter* system query option can be used to filter any collection of resources. Note that the response to a filtered collection is a collection of the same type, regardless of the number of matched resources." }, "response": [] }, { "name": "Filter a collection NOT containing element", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=not contains(Title,'news')", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "not contains(Title,'news')" } ] }, "description": "The *$filter* system query option can be used to filter any collection of resources. Note that the response to a filtered collection is a collection of the same type, regardless of the number of matched resources." }, "response": [] }, { "name": "Filter a collection by range", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=PublicationDate gt 2021-04-13T08:21:21Z and PublicationDate lt 2021-05-30T08:21:21Z", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "PublicationDate gt 2021-04-13T08:21:21Z and PublicationDate lt 2021-05-30T08:21:21Z" } ] }, "description": "The *$filter* system query option can be used to filter any collection of resources. Note that the response to a filtered collection is a collection of the same type, regardless of the number of matched resources." }, "response": [] }, { "name": "Filter a collection by equality", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=Author eq 'John Smith'", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "Author eq 'John Smith'" } ] }, "description": "The *$filter* system query option can be used to filter any collection of resources. Note that the response to a filtered collection is a collection of the same type, regardless of the number of matched resources." }, "response": [] }, { "name": "Filter a collection by inequality", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=Author ne 'John Smith'", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "Author ne 'John Smith'" } ] }, "description": "The *$filter* system query option can be used to filter any collection of resources. Note that the response to a filtered collection is a collection of the same type, regardless of the number of matched resources." }, "response": [] }, { "name": "Filter by language culture", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?sf_culture=en", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "sf_culture", "value": "en" } ] }, "description": "You can query the items from a specific language culture when your Sitefinity is in multilingual mode. In this example only the Spanish translations of news items are returned." }, "response": [] }, { "name": "Filter by provider", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?sf_provider=OpenAccessDataProvider", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "sf_provider", "value": "OpenAccessDataProvider" } ] }, "description": "There is support for filtering any type of content by the content provider. Just append *?sf_provider={your-provider}*, and only content from this provider will be returned. If you do not pass a provider the service always returns content from the default provider only." }, "response": [] }, { "name": "Get item from a specific culture and provider", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/newsitems({{item_id}})?sf_culture=en&sf_provider=OpenAccessDataProvider", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "newsitems({{item_id}})" ], "query": [ { "key": "sf_culture", "value": "en" }, { "key": "sf_provider", "value": "OpenAccessDataProvider" } ] }, "description": "You can get an item in specific language culture by appending *?sf_culture={culture}* at the end of the query string." }, "response": [] }, { "name": "Filter by tag", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=Tags/any(x:x eq {{taxon_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "Tags/any(x:x eq {{taxon_id}})" } ] } }, "response": [] }, { "name": "Filter by category", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=Category/any(x:x eq {{taxon_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "Category/any(x:x eq {{taxon_id}})" } ] } }, "response": [] }, { "name": "Filter a collection using logic operators", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=contains(Title,'taxon') and PublicationDate gt 2018-01-01T00:00:00Z", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "contains(Title,'taxon') and PublicationDate gt 2018-01-01T00:00:00Z" } ] }, "description": "You can use and, or and not to create more complex filter clauses." }, "response": [] }, { "name": "Filter a collection by choice field", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=cast(Choices, 'Edm.String') eq '2'", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "cast(Choices, 'Edm.String') eq '2'" } ] } }, "response": [] } ] }, { "name": "Sort", "item": [ { "name": "Sort a collection", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$orderby=Title desc", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$orderby", "value": "Title desc" } ] }, "description": "You can use *$orderby* system query option to request resources in ascending or descending order using *asc* or *desc*. In case *asc* or *desc* is not specified, then the resources will be ordered in ascending order. It is possible to sort on multiple attributes, these have to be comma separated." }, "response": [] }, { "name": "Pagination over a collection", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$orderby=Title asc&$skip=0&$top=1&$count=true", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$orderby", "value": "Title asc" }, { "key": "$skip", "value": "0" }, { "key": "$top", "value": "1" }, { "key": "$count", "value": "true" } ] }, "description": "There are two types of paging in Sitefinity web services, server and client side. Clients can drive paging using *$top* and *$skip*. You can also combine paging and other filtering and sorting options." }, "response": [] } ] }, { "name": "Count", "item": [ { "name": "Counting the elements in a collection", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "tests[\"Response is a primitive number\"] = !isNaN(parseFloat(responseBody)) && isFinite(responseBody) === true;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}/$count", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}", "$count" ] }, "description": "If you want to know how many items meet a condition, you can use the *$count* path segment. Note that the Content-Type header indicates that the content is text/plain." }, "response": [] }, { "name": "Get a collection with count", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "tests[\"Response is a primitive number\"] = !isNaN(parseFloat(responseBody)) && isFinite(responseBody) === true;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$count=true", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$count", "value": "true" } ] } }, "response": [] } ] }, { "name": "Classifications", "item": [ { "name": "Create taxonomy", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"Title\":\"MyCustomFlatTaxonomy\",\n\t\"TaxonName\":\"FlatTaxon\",\n\t\"Type\": \"0\",\n\t\"Name\":\"mycustomflattaxonomy\"\n}" }, "url": { "raw": "{{baseurl}}/api/default/taxonomies", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "taxonomies" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Get taxonomies", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/taxonomies", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "taxonomies" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Create taxon", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Successful POST request\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setGlobalVariable(\"taxon_id\", jsonData.Id);" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Title\": \"MyTaxon\",\n \"UrlName\": \"mytaxon\"\n \"TaxonomyId\": \"{{taxonomy_id}}\",\n \"Name\": \"MyTaxon\"\n}" }, "url": { "raw": "{{baseurl}}/api/default/{{taxaUrl}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{taxaUrl}}" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Get taxa", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{taxaUrl}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{taxaUrl}}" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Add classification to content item", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;", "" ] } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"Tags\": [\"{{taxon_id}}\"]\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{content_item_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{content_item_id}})" ] }, "description": "To create a resource, send a POST to a collection. The request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Filter a collection based on a taxon", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}?$filter=Tags/any(x:x eq {{taxon_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}" ], "query": [ { "key": "$filter", "value": "Tags/any(x:x eq {{taxon_id}})" } ] }, "description": "You can use any and lambda-style expressions to filter items by collection properties." }, "response": [] } ] }, { "name": "Related fields", "item": [ { "name": "Relate", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"@odata.id\":\"{{baseurl}}/api/default/images({{image_id}})\"\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})/Images/$ref", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})", "Images", "$ref" ] }, "description": "You can relate an item using */{relation}/$ref* endpoint. You must provide a *\\\"@odata.id\\\"* parameter with the related item full url in the body of the request." }, "response": [] }, { "name": "Expand related items", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})?$expand=Images", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})" ], "query": [ { "key": "$expand", "value": "Images" } ] }, "description": "You can use the *$expand* system query option to include parent information for hierarchical resources. In Sitefinity every child item has a navigational property called Parent. Keep in mind that navigational properties like Parent and Comments are capitalized." }, "response": [] }, { "name": "Get related items", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})/Images", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})", "Images" ] }, "description": "To navigate to related entities, append the related entity name as defined in $metadata" }, "response": [] }, { "name": "Delete relation", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{baseurl}}/api/default/{{entity}}({{item_id}})/Images({{image_id}})/$ref", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "{{entity}}({{item_id}})", "Images({{image_id}})", "$ref" ] }, "description": "You can delete a relation using the same endpoint */{relation}/$ref*, just send it with delete verb." }, "response": [] } ] }, { "name": "Page Templates", "item": [ { "name": "Get all page templates", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/templates", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "templates" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Get current site page templates", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/templates/filters(name=@sf_filter)?@sf_filter='ThisSite'&sf_site={{site_id}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "templates", "filters(name=@sf_filter)" ], "query": [ { "key": "@sf_filter", "value": "'ThisSite'" }, { "key": "sf_site", "value": "{{site_id}}" } ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Get grouped page templates", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/templates/Default.GetPageTemplates(selectedPages=[])", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "templates", "Default.GetPageTemplates(selectedPages=[])" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Get template thumbnails", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/images?sf_provider=SystemLibrariesProvider", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images" ], "query": [ { "key": "sf_provider", "value": "SystemLibrariesProvider" } ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Create page template", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Successful POST request\"] = responseCode.code === 201;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"Title\":\"CustomTemplate\",\n\t\"Name\":\"CustomTemplate\",\n\t\"Thumbnail\":\"00000000-0000-0000-0000-000000000000\",\n\t\"TemplateId\":\"00000000-0000-0000-0000-000000000000\"\n}" }, "url": { "raw": "{{baseurl}}/api/default/templates", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "templates" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] }, { "name": "Create .Net Core template", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Successful POST request\"] = responseCode.code === 201;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"Title\":\"MyCustomTemplate\",\n\t\"Name\":\"MyCustomTemplate\",\n\t\"Thumbnail\":\"00000000-0000-0000-0000-000000000000\",\n\t\"TemplateName\":\"NetCore.Default\"\n}" }, "url": { "raw": "{{baseurl}}/api/default/templates", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "templates" ] }, "description": "Creating taxon for any taxonomy is simple. created from previous request. Just send a POST request to the taxonomy type url. In the body include the title of the new taxon and the id of the taxonomy." }, "response": [] } ] }, { "name": "Pages", "item": [ { "name": "Get all pages", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default/pages", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages" ] }, "description": "Read a collection of pages" }, "response": [] }, { "name": "Create standard page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setGlobalVariable(\"page_id\", jsonData.Id);" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"Title\":\"Standard page\",\r\n\t\"UrlName\":\"standard-page\"\r\n}\r\n" }, "url": { "raw": "{{baseurl}}/api/default/pages", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages" ] }, "description": "To create a standard page, send a POST to the pages service root. In the request Body, specify the page Title at minimum. All other properties will be auto-generated by Sitefinity. \nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests.\nNOTE: Pages are created in draft state. When you do not specify a UrlName, Sitefinity assigns a random GUID as the page UrlName" }, "response": [] }, { "name": "Create group page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"UrlName\": \"group-page\",\r\n\t\"Title\": \"Group page\",\r\n\t\"PageType\": \"Group\"\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/pages", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages" ] }, "description": "To create a group page, send a POST to the pages service root. In the request Body, in addition to Urlname and Title parameter, you must specify a PageType: \"Group\".\nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Create redirect page external URL", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"UrlName\": \"external-redirect-page\",\r\n\t\"Title\": \"External redirect page\",\r\n\t\"PageType\": \"Redirect\",\r\n\t\"RedirectPage\": \r\n\t{\r\n\t\t\"RedirectUrl\": \"https://www.progress.com/sitefinity-cms\"\r\n\t}\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/pages", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages" ] }, "description": "To create a redirect page, send a POST to the pages service root. In the request Body, in addition to Urlname and Title parameter, you must specify a PageType: \"Redirect\", and define the RedirectPage in your JSON. When creating a redirect page that points to an external page you must specify the URL of the page your redirct page must point to in the RedirectPage object RedirectUrl property.\nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Create redirect page internal page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"UrlName\": \"internal-redirect-page\",\r\n\t\"Title\": \"Internal redirect page\",\r\n\t\"PageType\": \"Redirect\",\r\n\t\"RedirectPage\": \r\n\t{\r\n\t \"NodeId\": \"a9eafbd0-20e0-4846-99f9-5f069e4d14c4\"\r\n }\r\n}" }, "url": { "raw": "{{baseurl}}/api/default/pages", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages" ] }, "description": "To create a redirect page, send a POST to the pages service root. In the request Body, in addition to Urlname and Title parameter, you must specify a PageType: \"Redirect\", and define the RedirectPage in your JSON. When creating a redirect page that points to an internal page of your website you must specify the Id of the page your redirct page must point to in the RedirectPage object NodeId property.\nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests." }, "response": [] }, { "name": "Create synced page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 204;", "" ] } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"Title\":\"Synced page\",\r\n\t\"UrlName\":\"synced-page\",\r\n\t\"EnableSync\": true\r\n}\r\n" }, "url": { "raw": "{{baseurl}}/api/default/pages({{page_id}})?sf_culture={{culture}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages({{page_id}})" ], "query": [ { "key": "sf_culture", "value": "{{culture}}" } ] }, "description": "To create a standard page, send a POST to the pages service root. In the request Body, specify the page Title at minimum. All other properties will be auto-generated by Sitefinity. \nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests.\nNOTE: Pages are created in draft state. When you do not specify a UrlName, Sitefinity assigns a random GUID as the page UrlName" }, "response": [] }, { "name": "Create split page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 204;", "" ] } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\t\"Title\":\"Split page\",\r\n\t\"UrlName\":\"split-page\",\r\n\t\"EnableSplit\": true\r\n}\r\n" }, "url": { "raw": "{{baseurl}}/api/default/pages({{page_id}})?sf_culture={{culture}}", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages({{page_id}})" ], "query": [ { "key": "sf_culture", "value": "{{culture}}" } ] }, "description": "To create a standard page, send a POST to the pages service root. In the request Body, specify the page Title at minimum. All other properties will be auto-generated by Sitefinity. \nThe request format can be viewed on the service */sfhelp* web page. Authorization header with a token is usually required for those requests.\nNOTE: Pages are created in draft state. When you do not specify a UrlName, Sitefinity assigns a random GUID as the page UrlName" }, "response": [] }, { "name": "Set home page", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n\tpageId:\"a9eafbd0-20e0-4846-99f9-5f069e4d14c4\"\r\n}\t" }, "url": { "raw": "{{baseurl}}/api/default/pages/Default.SetHomePage()", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "pages", "Default.SetHomePage()" ] }, "description": "To set a page as yor website home page, use the Default.SetHomePage() method when doing a POSt to the pages service root. In the request body you must specify the pageId parameter (the Id of the page you want to set as a home page). Authorization header with a token is usually required for those requests.\nNOTE: Note the pageid parameter begins with lowercase!" }, "response": [] } ] }, { "name": "Media", "item": [ { "name": "Create album", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"image_library_id\", jsonData.Id);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"Title\": \"New library\", \r\n \"BlobStorageProvider\": \"Database\", \r\n \"UrlName\": \"new-library\",\r\n \"ParentId\":\"00000000-0000-0000-0000-000000000000\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/albums", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "albums" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Get image albums", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"image_library_id\", jsonData.value[0].Id);", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/albums", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "albums" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Get image album", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/albums({{image_library_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "albums({{image_library_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Delete an album", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/albums({{image_library_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "albums({{image_library_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Create a folder", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"folder_id\", jsonData.Id);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"Title\": \"New folder\", \r\n \"UrlName\": \"new-folder\",\r\n \"ParentId\":\"{{image_library_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/folders", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "folders" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Get all folders", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"folder_id\", jsonData.value[0].Id);", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/folders", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "folders" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Get a collection of images", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"image_id\", jsonData.value[0].Id);", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/images", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Get an image", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"image_id\", jsonData.value[0].Id);", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/images({{image_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images({{image_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Create image", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 201\"] = responseCode.code === 201;", "", "var jsonData = JSON.parse(responseBody);", "postman.setGlobalVariable(\"image_id\", jsonData.Id);" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" }, { "key": "X-Sf-Properties", "value": "{ParentId:\"{{image_library_id}}\"}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/images", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Update an image (partial)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;", "" ], "type": "text/javascript" } } ], "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"AlternativeText\": \"Meaningful alternative text\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/images({{image_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images({{image_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Update an image (full)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;", "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"AlternativeText\":\"Meaningful alternative text\",\r\n \"Title\":\"Update title\",\r\n \"Description\":\"\",\r\n \"IncludeInSitemap\": \"False\",\r\n \"Ordinal\": 0,\r\n \"UrlName\":\"some-url-name\",\r\n \"ParentId\":\"{{image_library_id}}\",\r\n \"Category\": [],\r\n \"Tags\": [],\r\n \"Author\": \"Some photographer\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/images({{image_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images({{image_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Delete an image", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;", "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/images({{image_id}})", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images({{image_id}})" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Add image to culture", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 204\"] = responseCode.code === 204;" ] } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/images({{image_id}})?sf_culture=de", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "images({{image_id}})" ], "query": [ { "key": "sf_culture", "value": "de" } ] }, "description": "To add different image for a specific language culture just append *?sf_culture={{your culture}}* to the URI of the image and make a PATCH request with the new image." }, "response": [] }, { "name": "Folder recursive search", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "image/jpeg" }, { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "{{baseurl}}/api/default/albums/Default.FoldersRecursiveSearch(parentId=null)?recursive=true", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "albums", "Default.FoldersRecursiveSearch(parentId=null)" ], "query": [ { "key": "recursive", "value": "true" } ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] }, { "name": "Regenerate thumbnails", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"action\": \"\",\r\n \"itemId\": \"{{image_library_id}}\",\r\n \"taskType\": \"RegenerateThumbnails\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/api/default/Default.ManageBackgroundTasks", "host": [ "{{baseurl}}" ], "path": [ "api", "default", "Default.ManageBackgroundTasks" ] }, "description": "Media is also suported. **Add an image to the body** and send a POST request." }, "response": [] } ] }, { "name": "Authenticate using Oidc", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "", "var jsonData = JSON.parse(responseBody);", "", "postman.setEnvironmentVariable(\"token\", jsonData.access_token);", "postman.setEnvironmentVariable(\"token_type\", jsonData.token_type);", "" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "username", "value": "{{username}}", "type": "text" }, { "key": "password", "value": "{{password}}", "type": "text" }, { "key": "grant_type", "value": "password", "type": "text" }, { "key": "scope", "value": "openid", "type": "text" }, { "key": "client_id", "value": "testApp", "type": "text" }, { "key": "client_secret", "value": "secret", "type": "text" } ] }, "url": { "raw": "{{baseurl}}/Sitefinity/Authenticate/OpenID/connect/token", "host": [ "{{baseurl}}" ], "path": [ "Sitefinity", "Authenticate", "OpenID", "connect", "token" ] }, "description": "Sitefinity Web Services REST APIs have a single entry point from which a generic hypermedia client can navigate to the resources in the service. In the response we see links to the $metadata document that describes the schema of the service and information about the content types exposed by the service like News, Blogs and Offices." }, "response": [] }, { "name": "Authenticate using Oauth", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = JSON.parse(responseBody);", "", "postman.setEnvironmentVariable(\"token\", jsonData.access_token);", "postman.setEnvironmentVariable(\"token_type\", jsonData.token_type);", "", "var jsonData = JSON.parse(responseBody);", "tests[\"Expiration is 3600\"] = jsonData.expires_in === 1799;", "tests[\"Token type\"] = jsonData.token_type=== \"bearer\";", "", "tests[\"Has access token property\"] = responseBody.has(\"\\\"access_token\\\":\\\"\");" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "x-sf-service-request", "value": "true" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "username", "value": "{{username}}", "type": "text" }, { "key": "password", "value": "{{password}}", "type": "text" }, { "key": "grant_type", "value": "password", "type": "text" }, { "key": "client_id", "value": "testApp", "type": "text" }, { "key": "client_secret", "value": "secret", "type": "text" } ] }, "url": { "raw": "{{baseurl}}/sitefinity/oauth/token", "host": [ "{{baseurl}}" ], "path": [ "sitefinity", "oauth", "token" ] }, "description": "login" }, "response": [] }, { "name": "Read the service root", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{token_type}} {{token}}" } ], "url": { "raw": "{{baseurl}}/api/default", "host": [ "{{baseurl}}" ], "path": [ "api", "default" ] }, "description": "You can authenticate using the special */login* endpoint. The service returns a token that can be added as authentication header for requests that require authentication.\n\n**All requests after this one depend on the authorization token in the response.**" }, "response": [] }, { "name": "Read the service metadata", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;", "tests[\"Body has Edmx tag\"] = responseBody.has(\"