{"id":3950,"date":"2020-04-20T12:39:25","date_gmt":"2020-04-20T11:39:25","guid":{"rendered":"https:\/\/help.cirrus-shield.com\/docs\/developer-guide\/rest-api\/describe-all\/"},"modified":"2022-01-11T09:43:00","modified_gmt":"2022-01-11T08:43:00","slug":"describe-all","status":"publish","type":"docs","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/describe-all\/","title":{"rendered":"3. Describe All"},"content":{"rendered":"\n<ul class=\"wp-block-list\"><li><strong><u><span class=\"has-inline-color has-luminous-vivid-orange-color\">URL:<\/span><\/u><\/strong> <\/li><\/ul>\n\n\n\n<pre class=\"wp-block-code\"><code>\u00ab \/RestApi\/DescribeAll?authToken=&lt;authToken> \u00bb<\/code><\/pre>\n\n\n\n<ul class=\"wp-block-list\"><li><strong><span class=\"has-inline-color has-luminous-vivid-orange-color\"><u>Method:<\/u> <\/span><\/strong>GET<\/li><li><span class=\"has-inline-color has-luminous-vivid-orange-color\"><strong><u>URL Params:<\/u><\/strong><\/span><ul><li>authToken [string] [Required]=the authentication token<\/li><\/ul><\/li><li><strong><u><span class=\"has-inline-color has-luminous-vivid-orange-color\">Success Response:<\/span><\/u><\/strong><ul><li>Status Code=200 (OK)<\/li><li>Returned Data [in XML or JSON]=a list of all the objects of the user organization<\/li><\/ul><\/li><li><strong><u><span class=\"has-inline-color has-luminous-vivid-orange-color\">Error Response:<\/span><\/u><\/strong><ul><li>Status Code=401 (Unauthorized) (in case of a wrong authentication token)<\/li><\/ul><\/li><\/ul>\n\n\n\n<p><strong>Example of returned data (in xml format):<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n&lt;?xml version=\"1.0\"?>\n\n&lt;ArrayOfObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n&lt;APIName>Organization&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n&lt;Icon\/>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>true&lt;\/IsEditable>\n\n&lt;Label>Organization&lt;\/Label>\n\n&lt;PluralLabel>Organizations&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n&lt;APIName>UserPosition&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n\n&lt;Icon\/>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;Label>Position&lt;\/Label>\n\n&lt;PluralLabel>Positions&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n&lt;APIName>Profile&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n\n&lt;Icon\/>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;Label>Profile&lt;\/Label>\n\n&lt;PluralLabel>Profiles&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n\n&lt;APIName>License&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n\n&lt;Icon\/>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>true&lt;\/IsDeletable>\n\n&lt;IsEditable>true&lt;\/IsEditable>\n\n&lt;Label>License&lt;\/Label>\n\n&lt;PluralLabel>Licenses&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n&lt;APIName>LoginHistory&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n\n&lt;Icon\/>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;Label>Login History&lt;\/Label>\n\n&lt;PluralLabel>Login History&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;ObjectDescriptor>\n\n&lt;APIName>Account&lt;\/APIName>\n\n&lt;Fields i:nil=\"true\"\/>\n\n&lt;Icon\/>\n\n&lt;IsCustom>true&lt;\/IsCustom>\n\n&lt;IsDeletable>true&lt;\/IsDeletable>\n\n&lt;IsEditable>true&lt;\/IsEditable>\n\n&lt;Label>Account&lt;\/Label>\n\n&lt;PluralLabel>Accounts&lt;\/PluralLabel>\n\n&lt;\/ObjectDescriptor>\n\n&lt;\/ArrayOfObjectDescriptor><\/code><\/pre>\n","protected":false},"author":12,"featured_media":0,"parent":944,"menu_order":2,"comment_status":"open","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"doc_tag":[],"class_list":["post-3950","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3950","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/comments?post=3950"}],"version-history":[{"count":3,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3950\/revisions"}],"predecessor-version":[{"id":4011,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3950\/revisions\/4011"}],"up":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/944"}],"next":[{"title":"4. Query","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/query\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3952"}],"prev":[{"title":"2. Describe","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/describe\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3948"}],"wp:attachment":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/media?parent=3950"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/doc_tag?post=3950"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}