JSON API Guide → Reference → GET Functions → GetURLField
Gets one or more URLs from a URL field on a specified item.
Name | Type | Description |
---|---|---|
GetURLField | Function |
Returns URL field contents on a primary or auxiliary item. |
table |
|
The primary or auxiliary table identifier. |
item |
|
The item identifier. |
field |
|
The URL field identifier. |
You can optionally use the GetURLField function in an HTTP POST and include one or more of the following objects:
Name | Type | Description |
---|---|---|
fileObjFilter
(optional) |
Array of identifiers
|
Include fileObjFilter to filter the URL field entries that are returned. Otherwise, all entries are returned by default. Note that you can pass any type of identifier in the array, or a combination of them in order to return the desired URLs. |
URL:
http://AEserverName/GetURLField/1000/141/URLFIELD
Post data:
{"fileObjFilter": [ "public site", "http://intranet.acme.com" ]}
Response:
{ "fieldFileObj": { "id": 190, "uuid": "0647fcef-ac15-40e1-9329-acd244a938ff", "name": "URLField", "dbname": "URLFIELD", "fldtype": 133, "fldtypelabel": "url", "fileObjList": [{ "id": 2, "uuid": "397e95a6-be6e-458d-955a-b47f0759d62f", "name": "intranet site", "contents": "http://intranet.acme.com" }, { "id": 4, "uuid": "0282aa7d-d0b6-4ce7-833f-a09b5047e7b6", "name": "public site", "contents": "http://acme.com" } ], "fileObjCount": 2 }, "result": { "type": "OK", "msg": "" } }
Because the TS_ID is subject to change in a promotion context, you may need to update the table and item parameters with the TS_ID from the target environment after the promote is finished.
Copyright © 2007–2019 Micro Focus or one of its affiliates. All rights reserved.