{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Use the CDAP Preferences Microservices to save, retrieve, and delete preferences in CDAP. Preferences, usage, and examples of using them, are described in ","type":"text"},{"text":"Preferences and Runtime Arguments","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Preferences and Runtime Arguments","versionAtSave":"7"},"href":"/wiki/spaces/DOCS/pages/480314690"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"All methods or endpoints described in this API have a base URL (typically ","type":"text"},{"text":"http://:11015","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"https://:10443","type":"text","marks":[{"type":"code"}]},{"text":") that precedes the resource identifier, as described in the Microservices Conventions. These methods return a status code, as listed in the Microservices Status Codes.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Set Preferences","type":"text"}]},{"type":"paragraph","content":[{"text":"To set preferences for the CDAP instance, namespace, application, or program, submit an HTTP PUT request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"PUT /v3/preferences/\nPUT /v3/namespaces//preferences\nPUT /v3/namespaces//apps//preferences\nPUT /v3/namespaces//apps////preferences","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[264.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[264.0]},"content":[{"type":"paragraph","content":[{"text":"namespace-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Namespace ID.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[264.0]},"content":[{"type":"paragraph","content":[{"text":"app-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Name of application.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[264.0]},"content":[{"type":"paragraph","content":[{"text":"program-type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"One of ","type":"text"},{"text":"mapreduce","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"spark","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"workflows","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"services","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"workers","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[264.0]},"content":[{"type":"paragraph","content":[{"text":"program-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Name of program.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Properties, as a map of string-string pairs, are passed in the JSON request body.","type":"text"}]},{"type":"paragraph","content":[{"text":"Preferences can be set only for entities that exist. For example, preferences cannot be set for a namespace that does not exist or an application that has not yet been deployed.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HTTP Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"Status Codes","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[493.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"200 OK","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[493.0]},"content":[{"type":"paragraph","content":[{"text":"The event successfully called the method, and the preferences were set/","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"400 BAD REQUEST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[493.0]},"content":[{"type":"paragraph","content":[{"text":"The JSON body has an invalid format.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"404 NOT FOUND","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[493.0]},"content":[{"type":"paragraph","content":[{"text":"The entity for which preferences are being set was not found.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Preferences","type":"text"}]},{"type":"paragraph","content":[{"text":"To retrieve the current preferences, issue an HTTP GET request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /v3/preferences/\nGET /v3/namespaces//preferences\nGET /v3/namespaces//apps//preferences\nGET /v3/namespaces//apps////preferences","type":"text"}]},{"type":"paragraph","content":[{"text":"This will return a JSON String map of the preferences:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"key1\": \"value1\", \"key2\": \"value2\"}","type":"text"}]},{"type":"paragraph","content":[{"text":"To retrieve the resolved preferences (collapsing preferences from higher levels into a single level), set the ","type":"text"},{"text":"resolved","type":"text","marks":[{"type":"code"}]},{"text":" query parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /v3/preferences?resolved=true\nGET /v3/namespaces//preferences?resolved=true\nGET /v3/namespaces//apps//preferences?resolved=true\nGET /v3/namespaces//apps////preferences?resolved=true","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"namespace-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Namespace ID.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"app-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Name of application.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"program-type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"One of ","type":"text"},{"text":"mapreduce","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"spark","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"workflows","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"services","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"workers","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"program-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Name of program.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HTTP Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[287.0]},"content":[{"type":"paragraph","content":[{"text":"Status Codes","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[287.0]},"content":[{"type":"paragraph","content":[{"text":"200 OK","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"The event successfully called the method, and the preferences were retrieved.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[287.0]},"content":[{"type":"paragraph","content":[{"text":"404 NOT FOUND","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"The entity for which preferences are being set was not found.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete Preferences","type":"text"}]},{"type":"paragraph","content":[{"text":"To delete preferences, issue an HTTP DELETE. Preferences can be deleted only at one level with each request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"DELETE /v3/preferences/\nDELETE /v3/namespaces//preferences\nDELETE /v3/namespaces//apps//preferences\nDELETE /v3/namespaces//apps////preferences","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[299.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[460.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[299.0]},"content":[{"type":"paragraph","content":[{"text":"namespace-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[460.0]},"content":[{"type":"paragraph","content":[{"text":"Namespace ID.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[299.0]},"content":[{"type":"paragraph","content":[{"text":"app-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[460.0]},"content":[{"type":"paragraph","content":[{"text":"Name of application.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[299.0]},"content":[{"type":"paragraph","content":[{"text":"program-type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[460.0]},"content":[{"type":"paragraph","content":[{"text":"One of ","type":"text"},{"text":"mapreduce","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"spark","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"workflows","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"services","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"workers","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[299.0]},"content":[{"type":"paragraph","content":[{"text":"program-id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[460.0]},"content":[{"type":"paragraph","content":[{"text":"Name of program.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HTTP Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[306.0]},"content":[{"type":"paragraph","content":[{"text":"Status Codes","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[453.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[306.0]},"content":[{"type":"paragraph","content":[{"text":"200 OK","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[453.0]},"content":[{"type":"paragraph","content":[{"text":"The event successfully called the method, and the preferences were deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[306.0]},"content":[{"type":"paragraph","content":[{"text":"404 NOT FOUND","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[453.0]},"content":[{"type":"paragraph","content":[{"text":"The entity for which preferences are being deleted was not found.","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported