Curl request for getting entry

$ curl 'http://localhost:8080/rest/1/entry/0b336f9c-6734-42b4-96f1-f75612a18b0d' -i

Path parameters entry

/rest/1/entry/{xid}
Parameter Description

xid

Entry xid

Request for getting entry

GET /rest/1/entry/0b336f9c-6734-42b4-96f1-f75612a18b0d HTTP/1.1
Host: localhost:8080

Response entry

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 9049

{
  "type" : "entry",
  "data" : {
    "xid" : "0b336f9c-6734-42b4-96f1-f75612a18b0d",
    "appXid" : "test-report",
    "name" : "Some report",
    "parentXid" : "2c2f8fa6-43da-45d6-839e-400b8bf827d6",
    "version" : 2,
    "lastModifierLogin" : "superuser-admin",
    "loadCode" : "test-load-code",
    "excerpt" : "description (platform description)",
    "completeness" : 100,
    "workflowState" : {
      "type" : "workflowstateinstance",
      "data" : {
        "xid" : "9301abb7-f117-4a9d-851b-8105518d93bf",
        "workflowId" : "default",
        "workflowStateId" : "public",
        "stateName" : "Public"
      }
    },
    "fields" : {
      "entrySynonym" : {
        "values" : [ "tst", "tst2" ]
      },
      "entryOwnerDisplay" : "<div class=\"xf3-userlist-container\">\n                        <span style=\"display:none\">nomarginplease</span>\n                                                                                            <div class=\"xf3-user-listview popup-entry-link\" target-xid = \"69e62835-dfa3-4425-ac81-f1cd316bdd78\">\n                            <a href=\"/viewentry?xid=69e62835-dfa3-4425-ac81-f1cd316bdd78\"\n                               style=\"font-size:16px; \"\n                               >\n                                <img src=\"/x/icon?xid=person\"\n                                     style=\"width:30px; height: 30px;border-radius:50%;margin-right: 16px;\n                                                                                      \"/>\n                            </a>\n                        </div>\n                                                        </div>",
      "worksheeet" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "lifecycleStatus" : "<div class=\"popup statuses-container\" data-xid='0b336f9c-6734-42b4-96f1-f75612a18b0d'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "MainThumbnail" : [ {
        "xid" : "d786f2ec-e215-4e96-9ec5-356f39f4d948",
        "url" : "/file/d786f2ec-e215-4e96-9ec5-356f39f4d948",
        "name" : "tst.txt",
        "type" : "xf3attachment"
      } ],
      "manualtag" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "description" : "description",
      "displayStatus" : "<div class='entry-statuses-container'>\n                <div class=\"xf3-status popularity-container\" name=\"popularity\">\n            <label for=\"popularity\" class=\"control-label\">Popularity</label>\n            <div class=\"popularity-container popup\" data-xid=\"0b336f9c-6734-42b4-96f1-f75612a18b0d\">\n    <div class=\"popularity-indicator\">\n                <div class=\"popularity-bar\" style=\"width: 15.9%\"></div>\n    </div>\n</div>\n        </div>\n            </div>\n\n                    <style>\n                        div.state-container {\n                            display:none;\n                        }\n                    </style>",
      "entryExtendedNameWithSynonyms" : "Some report (tst, tst2)",
      "openableUrl" : "https://www.google.com",
      "lastModificationDate" : "04/06 23:52",
      "dataconnections" : {
        "data" : [ {
          "server" : "localhost",
          "dbname" : "database",
          "dbclass" : "DB class",
          "port" : "8080",
          "caption" : "caption",
          "inpdata" : "xf3:_xid_",
          "username" : "database"
        } ]
      },
      "tbltag" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "nview" : "17",
      "entryLikeCount" : "0",
      "entryOwner" : [ {
        "xid" : "69e62835-dfa3-4425-ac81-f1cd316bdd78",
        "url" : "/rest/1/entry/69e62835-dfa3-4425-ac81-f1cd316bdd78",
        "name" : "David Vonka",
        "type" : "person"
      } ],
      "tbltagEdit" : "<div name=\"tbltag\"\n         class=\"form-control-static-x list-of-rels \">\n                                           <a href='/viewentry?xid=b1c0b378-0e4c-4081-a613-4e696fed915e' class='linkable xf3-extended-link linkable-Entry popup-entry-link' target=_self target-xid = b1c0b378-0e4c-4081-a613-4e696fed915e><span class='linkable-text'>Some report 2</span></a>\n                                        <br/>\n                </div>",
      "entryTypeIcon" : "/x/icon?xid=test-report",
      "entryNameWithSynonyms" : "tst, tst2 (<wbr>Some report)",
      "labeltag" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "entryAttachments" : [ {
        "xid" : "d786f2ec-e215-4e96-9ec5-356f39f4d948",
        "url" : "/file/d786f2ec-e215-4e96-9ec5-356f39f4d948",
        "name" : "tst.txt",
        "type" : "xf3attachment"
      } ],
      "relatedTerm" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "recentlyUpdated" : [ ],
      "entryPopularity" : "0.15851942",
      "joincodition" : "join condition",
      "reportversion" : "2",
      "entryExtendedName" : "Some report",
      "my_relations" : "<a class=\"open-embedded-nexus-icon\" data-toggle=\"modal\" data-version=\"2\" data-xid=\"0b336f9c-6734-42b4-96f1-f75612a18b0d\"\n   data-target=\"#xf3-nexus-dialog\" nexus-mode=\"Lineage\">\n        <img src=\"/img/embedded_nexus.png\" title=\"Open nexus\">\n</a>\n<div class=\"embedded-nexus\" field-code=\"my_relations\"></div>\n    <script type=\"application/javascript\">\n    jQuery(document).ready(function () {\n        var container = $(\".embedded-nexus[field-code='my_relations']\")\n\n        var mode = localStorage.getItem(\"nexusMode\");\n        localStorage.setItem(\"nexusMode\", \"Lineage\");\n\n        new initNexus(container, \"0b336f9c-6734-42b4-96f1-f75612a18b0d\", \"2\", function () {\n            container[0].style.width = \"unset\";\n\n            if (mode != null && mode != undefined) {\n                localStorage.setItem(\"nexusMode\", mode);\n            }\n\n        });\n    });\n</script>",
      "relatedtables" : {
        "data" : [ {
          "inpdata" : "xf3:_xid_",
          "schema_name" : "schema",
          "table_name" : "table"
        } ]
      },
      "userdefref_rep" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "entryExcerpt" : "description&nbsp;(platform description)",
      "createdat" : "Apr 6, 2018 11:52:12 PM",
      "datasource" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "entryName" : "Some report",
      "platformDescription" : "<p>platform description</p>",
      "reportFrequency" : [ {
        "xid" : "b1c0b378-0e4c-4081-a613-4e696fed915e",
        "url" : "/rest/1/entry/b1c0b378-0e4c-4081-a613-4e696fed915e",
        "name" : "Some report 2",
        "type" : "test-report"
      } ],
      "contributors" : "<div class=\"xf3-userlist-container\">\n                                    <div class=\"xf3-user-listview popup-entry-link\" target-xid = \"superuser-admin\">\n                <a href=\"/superadmin\"\n                   style=\"font-size:16px; \"\n                   >\n                <img src=\"/img/generic_user.png\" style=\"width:30px; height: 30px;border-radius:50%;margin-right: 16px;\n                    background-color: white;\n                        \"/>\n                </a>\n            </div>\n            </div>\n\n                                <style type=\"text/css\">\n                                                                        div[data-field-id=entryOwnerDisplay] .xf3-info-field:first-child,\n                                    div[data-field-id=contributors] .xf3-info-field:first-child{\n                                        margin-top: 0;\n                                    }\n                                </style>",
      "tableDisplayStatus" : "<div class=\"popup statuses-container\" data-xid='0b336f9c-6734-42b4-96f1-f75612a18b0d'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "updatedat" : "Apr 6, 2018 11:52:12 PM",
      "entryParentLink" : "<a href='/viewentry?xid=2c2f8fa6-43da-45d6-839e-400b8bf827d6'>Entry Rest SUB Folder</a>"
    }
  }
}

Response entry fields

Path Type Description

type

String

Entry type

data.xid

String

Entry xid

data.appXid

String

Entry application xid

data.name

String

Entry name

data.parentXid

String

Entry parent xid

data.version

Number

Entry version

data.lastModifierLogin

String

Last modifier login

data.loadCode

String

Entry load code

data.excerpt

String

Entry excerpt

data.completeness

Number

Number showing how much entry is completed

data.workflowState.type

String

Entry type of workflow state

data.workflowState.data.xid

String

WorkflowState xid

data.workflowState.data.workflowId

String

Workflow id of workflow state

data.workflowState.data.workflowStateId

String

WorkflowState id

data.workflowState.data.stateName

String

WorkflowState state name

data.fields.entryPopularity

String

Display of entry popularity

data.fields.lifecycleStatus

String

Display of lifecycle status

data.fields.entryExtendedName

String

Entry extended name that includes parent names

data.fields.entryExtendedNameWithSynonyms

String

Entry extended name with synonyms that includes parent names

data.fields.entryExcerpt

String

Entry excerpt

data.fields.lastModificationDate

String

Last modification date

data.fields.entryName

String

Entry name

data.fields.entryLikeCount

String

Display of entry likes/dislikes

data.fields.entryOwner

Array

Entry owner

data.fields.tableDisplayStatus

String

Table display status

data.fields.entryTypeIcon

String

Icon representing entry type

data.fields.entryNameWithSynonyms

String

Entry name with synonyms

data.fields.entryParentLink

String

Entry parent link

data.fields.entrySynonym.values

Array

Array of entry synonyms

data.fields.entryOwnerDisplay

String

Display of entry owner

data.fields.displayStatus

String

Display of entry status

data.fields.nview

String

Number of times entry being viewed

data.fields.tbltagEdit

String

data.fields.joincodition

String

Join condition string

data.fields.reportversion

String

Report version number

data.fields.my_relations

String

data.fields.createdat

String

Time entry was created at

data.fields.platformDescription

String

Platform description

data.fields.contributors

String

Entry contributors

data.fields.updatedat

String

Time entry was updated at

data.fields.description

String

Entry description

data.fields.openableUrl

String

Some external link

data.fields.recentlyUpdated

Array

Field that shows last updates to entry and its children

data.fields.entryOwner[].xid

String

Xid of related entry

data.fields.entryOwner[].url

String

Url of related entry

data.fields.entryOwner[].name

String

Name of related entry

data.fields.entryOwner[].type

String

Target application type

data.fields.relatedTerm[].xid

String

Xid of related entry

data.fields.relatedTerm[].url

String

Url of related entry

data.fields.relatedTerm[].name

String

Name of related entry

data.fields.relatedTerm[].type

String

Target application type

data.fields.entryAttachments[].xid

String

Attachment xid

data.fields.entryAttachments[].url

String

Attachment url

data.fields.entryAttachments[].name

String

Attachment name

data.fields.entryAttachments[].type

String

Attachment type (xf3attachment)

data.fields.worksheeet[].xid

String

Xid of related entry

data.fields.worksheeet[].url

String

Url of related entry

data.fields.worksheeet[].name

String

Name of related entry

data.fields.worksheeet[].type

String

Target application type

data.fields.MainThumbnail[].xid

String

Attachment xid

data.fields.MainThumbnail[].url

String

Attachment url

data.fields.MainThumbnail[].name

String

Attachment name

data.fields.MainThumbnail[].type

String

Attachment type (xf3attachment)

data.fields.manualtag[].xid

String

Xid of related entry

data.fields.manualtag[].url

String

Url of related entry

data.fields.manualtag[].name

String

Name of related entry

data.fields.manualtag[].type

String

Target application type

data.fields.labeltag[].xid

String

Xid of related entry

data.fields.labeltag[].url

String

Url of related entry

data.fields.labeltag[].name

String

Name of related entry

data.fields.labeltag[].type

String

Target application type

data.fields.tbltag[].xid

String

Xid of related entry

data.fields.tbltag[].url

String

Url of related entry

data.fields.tbltag[].name

String

Name of related entry

data.fields.tbltag[].type

String

Target application type

data.fields.userdefref_rep[].xid

String

Xid of related entry

data.fields.userdefref_rep[].url

String

Url of related entry

data.fields.userdefref_rep[].name

String

Name of related entry

data.fields.userdefref_rep[].type

String

Target application type

data.fields.datasource[].xid

String

Xid of related entry

data.fields.datasource[].url

String

Url of related entry

data.fields.datasource[].name

String

Name of related entry

data.fields.datasource[].type

String

Target application type

data.fields.reportFrequency[].xid

String

Xid of related entry

data.fields.reportFrequency[].url

String

Url of related entry

data.fields.reportFrequency[].name

String

Name of related entry

data.fields.reportFrequency[].type

String

Target application type

data.fields.relatedtables.data[].inpdata

String

Input data from schema or table

data.fields.relatedtables.data[].schema_name

String

Schema name

data.fields.relatedtables.data[].table_name

String

Table name

data.fields.dataconnections.data[].caption

String

Dataconnection caption

data.fields.dataconnections.data[].dbclass

String

Database class

data.fields.dataconnections.data[].server

String

Server

data.fields.dataconnections.data[].port

String

Port number

data.fields.dataconnections.data[].dbname

String

Database name

data.fields.dataconnections.data[].username

String

Username

data.fields.dataconnections.data[].inpdata

String

Input data from schema, table or view

Entry parent

Curl request for getting entry parent

$ curl 'http://localhost:8080/rest/1/entry/3da5f8cf-723d-4089-96a5-5d4f6d26dd36/parent' -i

Path parameters entry parent

/rest/1/entry/{xid}/parent
Parameter Description

xid

Entry xid

Request for getting entry parent

GET /rest/1/entry/3da5f8cf-723d-4089-96a5-5d4f6d26dd36/parent HTTP/1.1
Host: localhost:8080

Response entry parent

HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 2074

{
  "type" : "entry",
  "data" : {
    "xid" : "01064e51-6eb9-45d9-868e-ffbf8dc19c23",
    "appXid" : "folder",
    "name" : "Entry Rest Folder",
    "parentXid" : "home-folder-xid",
    "version" : 1,
    "lastModifierLogin" : "superuser-admin",
    "loadCode" : null,
    "excerpt" : "",
    "completeness" : -1,
    "workflowState" : {
      "type" : "workflowstateinstance",
      "data" : {
        "xid" : "87a25910-a212-4cbd-ac83-ce9a32e20265",
        "workflowId" : "default",
        "workflowStateId" : "public",
        "stateName" : "Public"
      }
    },
    "fields" : {
      "displaytype" : null,
      "lifecycleStatus" : "<div class=\"popup statuses-container\" data-xid='01064e51-6eb9-45d9-868e-ffbf8dc19c23'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "integrationcode" : null,
      "MainThumbnail" : null,
      "entryExtendedNameWithSynonyms" : "Entry <wbr>Rest <wbr>Folder",
      "lastModificationDate" : "04/06 23:52",
      "listofentries" : [ ],
      "entryLikeCount" : "0",
      "entryOwner" : null,
      "foldertype" : "all-fields-app",
      "isdefault" : null,
      "entryTypeIcon" : "/x/icon?xid=folder",
      "entryNameWithSynonyms" : "Entry <wbr>Rest <wbr>Folder",
      "entryAttachments" : null,
      "entryPopularity" : "",
      "entrySteward" : null,
      "allowDuplicateNames" : null,
      "entryExtendedName" : "Entry Rest Folder",
      "entryExcerpt" : "",
      "entries" : null,
      "entryName" : "Entry Rest Folder",
      "subfolders" : [ {
        "xid" : "3da5f8cf-723d-4089-96a5-5d4f6d26dd36",
        "url" : "/rest/1/entry/3da5f8cf-723d-4089-96a5-5d4f6d26dd36",
        "name" : "Entry Rest SUB Folder",
        "type" : "folder"
      } ],
      "tableDisplayStatus" : "<div class=\"popup statuses-container\" data-xid='01064e51-6eb9-45d9-868e-ffbf8dc19c23'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "desc" : null,
      "entryParentLink" : "<a href='/viewentry?xid=home-folder-xid'>Home</a>"
    }
  }
}

Entry children

Curl request for getting entry children

$ curl 'http://localhost:8080/rest/1/entry/home-folder-xid/children' -i

Path parameters entry children

/rest/1/entry/{xid}/children
Parameter Description

xid

Entry xid

Request for getting entry children

GET /rest/1/entry/home-folder-xid/children HTTP/1.1
Host: localhost:8080

Response entry children

HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 3868

[ {
  "type" : "entry",
  "data" : {
    "xid" : "6f82fb0c-0228-4a96-b3eb-6a011f5724b4",
    "appXid" : "folder",
    "name" : "people",
    "parentXid" : "home-folder-xid",
    "version" : 1,
    "lastModifierLogin" : "superuser-admin",
    "loadCode" : null,
    "excerpt" : "",
    "completeness" : -1,
    "workflowState" : {
      "type" : "workflowstateinstance",
      "data" : {
        "xid" : "41dbbe61-ecaf-40e7-9c60-00e9207b6f10",
        "workflowId" : "default",
        "workflowStateId" : "public",
        "stateName" : "Public"
      }
    },
    "fields" : {
      "displaytype" : null,
      "lifecycleStatus" : "<div class=\"popup statuses-container\" data-xid='6f82fb0c-0228-4a96-b3eb-6a011f5724b4'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "integrationcode" : null,
      "MainThumbnail" : null,
      "entryExtendedNameWithSynonyms" : "people",
      "lastModificationDate" : "04/06 23:47",
      "listofentries" : [ ],
      "entryLikeCount" : "0",
      "entryOwner" : null,
      "foldertype" : "person",
      "isdefault" : null,
      "entryTypeIcon" : "/x/icon?xid=folder",
      "entryNameWithSynonyms" : "people",
      "entryAttachments" : null,
      "entryPopularity" : "",
      "entrySteward" : null,
      "allowDuplicateNames" : null,
      "entryExtendedName" : "people",
      "entryExcerpt" : "",
      "entries" : null,
      "entryName" : "people",
      "subfolders" : null,
      "tableDisplayStatus" : "<div class=\"popup statuses-container\" data-xid='6f82fb0c-0228-4a96-b3eb-6a011f5724b4'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "desc" : null,
      "entryParentLink" : "<a href='/viewentry?xid=home-folder-xid'>Home</a>"
    }
  }
}, {
  "type" : "entry",
  "data" : {
    "xid" : "f7f06523-c375-4ebb-82ba-2504f9027b06",
    "appXid" : "folder",
    "name" : "Entry Rest Folder",
    "parentXid" : "home-folder-xid",
    "version" : 1,
    "lastModifierLogin" : "superuser-admin",
    "loadCode" : null,
    "excerpt" : "",
    "completeness" : -1,
    "workflowState" : {
      "type" : "workflowstateinstance",
      "data" : {
        "xid" : "3cb9ca30-9877-4972-8ed1-90fa45cbfeac",
        "workflowId" : "default",
        "workflowStateId" : "public",
        "stateName" : "Public"
      }
    },
    "fields" : {
      "displaytype" : null,
      "lifecycleStatus" : "<div class=\"popup statuses-container\" data-xid='f7f06523-c375-4ebb-82ba-2504f9027b06'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "integrationcode" : null,
      "MainThumbnail" : null,
      "entryExtendedNameWithSynonyms" : "Entry <wbr>Rest <wbr>Folder",
      "lastModificationDate" : "04/06 23:52",
      "listofentries" : [ ],
      "entryLikeCount" : "0",
      "entryOwner" : null,
      "foldertype" : "all-fields-app",
      "isdefault" : null,
      "entryTypeIcon" : "/x/icon?xid=folder",
      "entryNameWithSynonyms" : "Entry <wbr>Rest <wbr>Folder",
      "entryAttachments" : null,
      "entryPopularity" : "",
      "entrySteward" : null,
      "allowDuplicateNames" : null,
      "entryExtendedName" : "Entry Rest Folder",
      "entryExcerpt" : "",
      "entries" : null,
      "entryName" : "Entry Rest Folder",
      "subfolders" : [ {
        "xid" : "245e3908-3939-4cfa-8448-8f70ff3836f8",
        "url" : "/rest/1/entry/245e3908-3939-4cfa-8448-8f70ff3836f8",
        "name" : "Entry Rest SUB Folder",
        "type" : "folder"
      } ],
      "tableDisplayStatus" : "<div class=\"popup statuses-container\" data-xid='f7f06523-c375-4ebb-82ba-2504f9027b06'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
      "desc" : null,
      "entryParentLink" : "<a href='/viewentry?xid=home-folder-xid'>Home</a>"
    }
  }
} ]