{"id":31384,"date":"2018-04-21T15:47:46","date_gmt":"2018-04-21T15:47:46","guid":{"rendered":"https:\/\/ampscript.guide\/functions-invokeretrieve\/"},"modified":"2021-04-06T01:18:21","modified_gmt":"2021-04-06T01:18:21","slug":"invokeretrieve","status":"publish","type":"post","link":"https:\/\/ampscript.guide\/invokeretrieve\/","title":{"rendered":"InvokeRetrieve"},"content":{"rendered":"

InvokeRetrieve<\/h2>\n

This function retrieves the instantiated Marketing Cloud API Object<\/a> RetrieveRequest<\/code>. It returns a status message and a RequestID<\/code> value.<\/p>\n

Arguments<\/h3>\n

InvokeRetrieve(1,2,3)<\/code><\/p>\n\n\n\n\n\n\n\n
Ordinal<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nAPI Object<\/td>\nTrue<\/td>\nThe API Object to be retrieved<\/td>\n<\/tr>\n
2<\/td>\nString<\/td>\nFalse<\/td>\nThe AMPscript variable in which the resulting status message is stored<\/td>\n<\/tr>\n
3<\/td>\nVariable<\/td>\nFalse<\/td>\nThe AMPscript variable in which the resulting RequestID is stored<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h3>\n

The following example retrieves a list of column names in the LoyaltyMembers<\/code> Data Extension.<\/p>\n

Data Extension<\/strong>: LoyaltyMembers<\/em><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nData Type<\/th>\nLength<\/th>\nPrimary Key<\/th>\nNullable<\/th>\nDefault Value<\/th>\n<\/tr>\n<\/thead>\n
EmailAddress<\/td>\nEmailAddress<\/td>\n254<\/td>\nN<\/td>\nN<\/td>\n<\/td>\n<\/tr>\n
SubscriberKey<\/td>\nText<\/td>\n254<\/td>\nY<\/td>\nN<\/td>\n<\/td>\n<\/tr>\n
FirstName<\/td>\nText<\/td>\n50<\/td>\nN<\/td>\nY<\/td>\n<\/td>\n<\/tr>\n
LastName<\/td>\nText<\/td>\n50<\/td>\nN<\/td>\nY<\/td>\n<\/td>\n<\/tr>\n
Region<\/td>\nText<\/td>\n50<\/td>\nN<\/td>\nY<\/td>\n<\/td>\n<\/tr>\n
Rank<\/td>\nNumber<\/td>\n<\/td>\nN<\/td>\nY<\/td>\n<\/td>\n<\/tr>\n
Created<\/td>\nDate<\/td>\n<\/td>\nN<\/td>\nY<\/td>\nCurrent Date<\/td>\n<\/tr>\n
Updated<\/td>\nDate<\/td>\n<\/td>\nN<\/td>\nY<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
%%[\n\nvar @rr, @ID, @Name\nset @rr = CreateObject(\"RetrieveRequest\")\nSetObjectProperty(@rr, \"ObjectType\", \"DataExtensionField\")\nAddObjectArrayItem(@rr, \"Properties\", \"Name\")\n\nset @sfp = CreateObject(\"SimpleFilterPart\")\nSetObjectProperty(@sfp, \"Property\", \"DataExtension.CustomerKey\")\nSetObjectProperty(@sfp, \"SimpleOperator\", \"equals\")\nAddObjectArrayItem(@sfp, \"Value\", \"LoyaltyMembers\")\n\nSetObjectProperty(@rr,\"Filter\", @sfp)\n\nset @dataExtensionFields = InvokeRetrieve(@rr, @rrStatus, @rrRequestID)\n\noutput(concat(\"rrStatus: \", @rrStatus))\noutput(concat(\"<br>rrRequestID: \", @rrRequestID))\n\nfor @i = 1 to RowCount(@dataExtensionFields) do\n\n  set @dataExtensionField = Row(@dataExtensionFields, @i)\n  set @Name = Field(@dataExtensionField, \"Name\")\n\n  output(concat(\"<br>Name: \", @Name))\n\nnext @i\n\n]%%<\/code><\/pre>\n
Output<\/h4>\n
rrStatus: OK\nrrRequestID: d85dedfd-0833-4fe2-bcb1-3a25ad059759\nName: Updated\nName: Created\nName: FirstName\nName: SubscriberKey\nName: Rank\nName: Region\nName: LastName\nName: EmailAddress<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
InvokeRetrieve This function retrieves the instantiated Marketing Cloud API Object RetrieveRequest. It returns a status message and a RequestID value. Arguments InvokeRetrieve(1,2,3) Ordinal Type Required Description 1 API Object True The API Object to be retrieved 2 String False The AMPscript variable in which the resulting status message is stored 3 Variable False The AMPscript […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"yoast_head":"\nThe AMPscript Guide - InvokeRetrieve<\/title>\n<meta name=\"robots\" content=\"index, follow\" \/>\n<meta name=\"googlebot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta name=\"bingbot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ampscript.guide\/invokeretrieve\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The AMPscript Guide - InvokeRetrieve\" \/>\n<meta property=\"og:description\" content=\"InvokeRetrieve This function retrieves the instantiated Marketing Cloud API Object RetrieveRequest. It returns a status message and a RequestID value. Arguments InvokeRetrieve(1,2,3) Ordinal Type Required Description 1 API Object True The API Object to be retrieved 2 String False The AMPscript variable in which the resulting status message is stored 3 Variable False The AMPscript […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ampscript.guide\/invokeretrieve\/\" \/>\n<meta property=\"og:site_name\" content=\"The AMPscript Guide\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-21T15:47:46+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-04-06T01:18:21+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ampscript.guide\/#website\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"The AMPscript Guide\",\"description\":\"The Definitive Scripting Manual for Salesforce Marketing Cloud\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/ampscript.guide\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/invokeretrieve\/#webpage\",\"url\":\"https:\/\/ampscript.guide\/invokeretrieve\/\",\"name\":\"The AMPscript Guide - InvokeRetrieve\",\"isPartOf\":{\"@id\":\"https:\/\/ampscript.guide\/#website\"},\"datePublished\":\"2018-04-21T15:47:46+00:00\",\"dateModified\":\"2021-04-06T01:18:21+00:00\",\"author\":{\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\"},\"breadcrumb\":{\"@id\":\"https:\/\/ampscript.guide\/invokeretrieve\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ampscript.guide\/invokeretrieve\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ampscript.guide\/invokeretrieve\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"position\":2,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/invokeretrieve\/\",\"url\":\"https:\/\/ampscript.guide\/invokeretrieve\/\",\"name\":\"InvokeRetrieve\"}}]},{\"@type\":[\"Person\"],\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\",\"name\":\"dev\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","_links":{"self":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31384"}],"collection":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/comments?post=31384"}],"version-history":[{"count":0,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31384\/revisions"}],"wp:attachment":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/media?parent=31384"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/categories?post=31384"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/tags?post=31384"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}