URL redirects

    List the URL redirects created on a site

    Request

    • Method: GET
    • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

      Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
      • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
    • Path: /webresources/api/v3/sites/current/tags
      • alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    An array of the first 10 tags; each object has the following properties:

    • id - the tag's ID (numeric)
    • siteId - the site's ID (numeric)
    • pageURL - the source URL (string)
    • redirect301 - the destination URL (string)
    • enabled (boolean)
    • createDate - the date this record was created (dateTime)
    • lastUpdateDate - the date the record was updated (dateTime)

    You can output additional fields to those listed above as default, see the API v3 Discovery APP for additional details.

    Accepts and returns JSON as Content-Type.


    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/urlredirects",
        type: "GET",
        connection: "keep-alive",    contentType: "application/json",
        headers: {
            "Authorization": $.cookie('access_token')
        }
    });
    request.done(function (msg) {
        console.log(msg);
    })
    request.fail(function (jqXHR) {
        console.log("Request failed.");
        console.log("Error code: " + jqXHR.status);
        console.log("Error text: " + jqXHR.statusText);
        console.log("Response text: " + jqXHR.responseText);
    })

    Sample response

    {
      "items": [
        {
    		createDate: "2018-01-11T16:38:20.147"
    		enabled: true
    		id: 5027650
    		lastUpdateDate: "2018-10-10T10:00:03.457"
    		pageUrl: "/Home.htm"
    		redirect301: ""
    		siteId: 146985
        },
        {
         createDate: "2018-01-14T15:22:53.563"
    		enabled: true
    		id: 5040452
    		lastUpdateDate: "2018-10-10T16:47:58.623"
    		pageUrl: "/search_results"
    		redirect301: "/search"
    		siteId: 146985
        }
      ],
      "totalItemsCount": 2,
      "skip": 0,
      "limit": 10
    }