{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"This API fetches the record specified by the search argument from the file.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Parameters","type":"text"}]},{"type":"rule"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"search argument","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"The value can be a ","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":" value specifying a ","type":"text"},{"text":"relative record number","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"RRN","type":"text","marks":[{"type":"code"}]},{"text":"), ","type":"text"},{"text":"key value","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"list of key values","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":" of ","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":"/","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"don't lock","type":"text","marks":[{"type":"strong"}]},{"text":" (","type":"text"},{"text":"optional","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"A ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"can be passed to avoid locking the record if the file is open for ","type":"text"},{"text":"update","type":"text","marks":[{"type":"code"}]},{"text":"/","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]},{"text":". If this parameter is set to ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" or omitted records will be locked for ","type":"text"},{"text":"update","type":"text","marks":[{"type":"code"}]},{"text":"/","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]},{"text":" files.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"record format name","type":"text","marks":[{"type":"strong"}]},{"text":" (","type":"text"},{"text":"optional","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"A ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" value specifying the ","type":"text"},{"text":"record format name","type":"text","marks":[{"type":"em"}]},{"text":" can be passed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"input data structure","type":"text","marks":[{"type":"strong"}]},{"text":" (","type":"text"},{"text":"optional","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"A Profound.js ","type":"text"},{"text":"data structure reference","type":"text","marks":[{"type":"code"}]},{"text":" can be passed. ","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" ","type":"text"},{"text":"If specified, the referenced data structure will be populated with the record data. If the data structure is not qualified, you must wrap the parameter with the ","type":"text"},{"text":"pjs.ds()","type":"text","marks":[{"type":"link","attrs":{"href":"https://profoundlogicsupport.atlassian.net/wiki/x/hgHOCQ"}}]},{"text":" API.","type":"text"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"78d0d9a5-c876-426c-931e-e67a3d484818"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"25%

Requirements

This API requires the module.

RPG Equivalent

CHAIN

Exception Handling

An Error instance will be thrown with the following properties:

message - The message text.
error - The message id.
help - The message help text.

","nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{"width":{"value":"50%"}},"macroMetadata":{"macroId":{"value":"83fbb6d8-eb19-485b-8050-d9288e88ed4c"},"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Exception Handling","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"An Error instance will be thrown with the following properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"message","type":"text","marks":[{"type":"strong"}]},{"text":" - The message text.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"error","type":"text","marks":[{"type":"strong"}]},{"text":" - The message id.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"help","type":"text","marks":[{"type":"strong"}]},{"text":" - The message help text.","type":"text"}]}]}]}]}],"version":1},"reason":"A column macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Retrieve record with first key key equal to 101","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"pjs.defineTable(\"myfile\", { keyed: true, read: true });\nmyfile.getRecord(101);\nif (myfile.found())\n doSomething();","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Video Tutorial","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"widget","parameters":{"macroParams":{"overlay":{"value":"youtube"},"_template":{"value":"com/atlassian/confluence/extra/widgetconnector/templates/youtube.vm"},"width":{"value":"640px"},"url":{"value":"https://www.youtube.com/watch?v=1Dgl8yP2b2Q"},"height":{"value":"360px"}},"macroMetadata":{"macroId":{"value":"f681a0bc-04c8-4d2f-ab62-0bf93559118a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"image","data":{"url":"/plugins/servlet/widgetconnector/placeholder?thumb=https://img.youtube.com/vi/1Dgl8yP2b2Q/mqdefault.jpg&overlay=youtube&width=640&height=360"}}],"title":"Widget Connector"}}}},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported