{"id":3948,"date":"2020-04-20T12:38:58","date_gmt":"2020-04-20T11:38:58","guid":{"rendered":"https:\/\/help.cirrus-shield.com\/docs\/developer-guide\/rest-api\/describe\/"},"modified":"2022-01-11T09:43:00","modified_gmt":"2022-01-11T08:43:00","slug":"describe","status":"publish","type":"docs","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/describe\/","title":{"rendered":"2. Describe"},"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\/Describe\/&lt;objectName>?authToken=&lt;authToken> \u00bb<\/code><\/pre>\n\n\n\n<ul class=\"wp-block-list\"><li><strong><u><span class=\"has-inline-color has-luminous-vivid-orange-color\">Method:<\/span><\/u> <\/strong>GET<\/li><li><strong><u><span class=\"has-inline-color has-luminous-vivid-orange-color\">URL Params:<\/span><\/u><\/strong><ul><li>objectName [string] [Required]=the name of the object that the user wants to describe<\/li><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 detailed description of the object (name, label, plural label, fields, \u2026)<\/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)Or<\/li><\/ul><ul><li>Status Code=400 (BadRequest) (in case of an empty object name parameter)<\/li><\/ul><\/li><\/ul>\n\n\n\n<p>&nbsp;<strong>Example of returned data (in xml format) (objectName=\u201dAccount\u201d):<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>&lt;?xml version=\"1.0\"?>\n\n&lt;ObjectDescriptor>\n\n  &lt;APIName>Account&lt;\/APIName>\n\n  &lt;Fields>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>Text&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>true&lt;\/IsUnique>\n\n&lt;Label>Id&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n&lt;Name>Id&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName\/>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>Text&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>true&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Name&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>Name&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName\/>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>LookupRelationship&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>true&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Owner&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>OwnerId&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n &lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName>Account1&lt;\/RelationshipName>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>LookupRelationship&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Created By&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>CreatedById&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName>Account2&lt;\/RelationshipName>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>DateTime&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Creation Date&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>CreationDate&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName\/>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>LookupRelationship&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Modified By&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>ModifiedById&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName>Account3&lt;\/RelationshipName>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>DateTime&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Modification Date&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>ModificationDate&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName\/>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;FieldDescriptor>\n\n&lt;ClrValIfLkUpDel>false&lt;\/ClrValIfLkUpDel>\n\n&lt;DataType>Checkbox&lt;\/DataType>\n\n&lt;DecimalPlaces i:nil=\"true\"\/>\n\n&lt;DefaultValue\/>\n\n&lt;DisplayFormat\/>\n\n&lt;IsAlphabeticallySorted>false&lt;\/IsAlphabeticallySorted>\n\n&lt;IsCaseSensitive>false&lt;\/IsCaseSensitive>\n\n&lt;IsCustom>false&lt;\/IsCustom>\n\n&lt;IsDeletable>false&lt;\/IsDeletable>\n\n&lt;IsEditable>false&lt;\/IsEditable>\n\n&lt;IsRequired>true&lt;\/IsRequired>\n\n&lt;IsUnique>false&lt;\/IsUnique>\n\n&lt;Label>Is Deleted&lt;\/Label>\n\n&lt;Length i:nil=\"true\"\/>\n\n&lt;Name>IsDeleted&lt;\/Name>\n\n&lt;PicklistValues i:nil=\"true\"\/>\n\n&lt;Prefix\/>\n\n&lt;RelatedToObject i:nil=\"true\"\/>\n\n&lt;RelationshipName\/>\n\n&lt;StartingNumber i:nil=\"true\"\/>\n\n&lt;Suffix\/>\n\n&lt;VisibleLinesNb i:nil=\"true\"\/>\n&lt;\/FieldDescriptor>\n\n&lt;\/Fields>\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><\/code><\/pre>\n","protected":false},"author":12,"featured_media":0,"parent":944,"menu_order":1,"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-3948","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3948","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=3948"}],"version-history":[{"count":4,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3948\/revisions"}],"predecessor-version":[{"id":4010,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3948\/revisions\/4010"}],"up":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/944"}],"next":[{"title":"3. Describe All","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/describe-all\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3950"}],"prev":[{"title":"1. AuthToken","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/authtoken\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/3946"}],"wp:attachment":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/media?parent=3948"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/doc_tag?post=3948"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}