This RESTful web service request creates or updates a ReportCaster Library Access List that can be used by ReportCaster schedules when the distribution is set to the Report Library. If a schedule is defined to use a Library Access List, then Users or Groups defined in the list are granted access to view the part of the report that is stored in the Library, which they have access to based on a Burst Value. If a Burst Value is not supplied for a particular Access List entry, then the User or Group in the definition will be able to view the entire report.
HTTP Method: POST
REST URL Format:
http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/LibraryAccessListName
where:
Is the name of the system where WebFOCUS is installed.
Is the port number used by WebFOCUS.
Is the name of the folder where the ReportCaster Library Access List is stored. If the folder that is used to store the Library Access List exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.
Is the name of the ReportCaster Library Access List to add or update, which must have a .acl extension.
Body Format:
IBIRS_action=put&IBIRS_object=Object&IBIRS_replace=ReplaceAccessList&IBIRS_private=MakePrivate
where:
Is the XML object that defines the ReportCaster Library Access List.
<rootObject _jt="IBFSCasterObject" description="AccessListDescription" type="CasterAccessList"><casterObject _jt="CasterLibraryAccessBook" burstValue="burstValueFlag" description="AccessListDescription" owner="Owner"><accessElementList _jt="array" itemsClass="CasterLibAccessElement" size="numberOfItems"> <item _jt="CasterLibAccessElement" burstValue="burstValue" index="indexValue" memberName="member" MemberType="memberType"/> </accessElementList></casterObject></rootObject>
where:
Is the title for the Library Access List.
Specify one of the following:
Is the owner of the Library Access List.
Is the number of members that will be added to the Library Access List.
Is the value used in bursting a report.
Is a value that starts at 0 and increments by 1 for every member that is added to the Library Access List.
Is the user name or group that will be added as a member of the Library Access List.
Specify U for user or G for group.
Specify one of the following:
To update a Library Access List, the existing Library Access List must be retrieved. The retrieved XML object would then be modified and then used as input.
The following REST URL retrieves an existing Library Access List:
http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/LibraryAccessListName?IBIRS_action=get
Determines whether to make a Library Access List private. Specify true or false.
Example 1:
In this example:
POST Request URL:
http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/ Car_Reports/RESTAccessList.acl
Body:
IBIRS_action=put&IBIRS_object=<rootObject _jt="IBFSCasterObject" description="REST Access List" type="CasterAccessList"><casterObject _jt="CasterLibraryAccessBook" burstValue="true" description="REST Access List" owner="admin"><accessElementList _jt="array" itemsClass="CasterLibAccessElement" size="4"><item _jt="CasterLibAccessElement" burstValue="FRANCE" index="0" memberName="daniel" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="JAPAN" index="1" memberName="david" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ENGLAND" index="2" memberName="efrem" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ITALY" index="3" memberName="gerry" memberType="U"/></accessElementList></casterObject></rootObject>&IBIRS_re place=false&IBIRS_private=true
Response:
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> <ibfsrpc _jt="IBFSResponseObject" language="EN" name="put" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple"> <ibfsparams size="5"> <entry key="IBIRS_replace" value="false"/> <entry key="IBIRS_private" value="true"/> <entry key="IBIRS_object" value="<rootObject _jt="IBFSCasterObject" description="REST Access List" type="CasterAccessList"><casterObject _jt="CasterLibraryAccessBook" burstValue="true" description="REST Access List" owner="admin"><accessElementList _jt="array" itemsClass="CasterLibAccessElement" size="4"><item _jt="CasterLibAccessElement" burstValue="FRANCE" index="0" memberName="daniel" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="JAPAN" index="1" memberName="david"
memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ENGLAND" index="2" memberName="efrem" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ITALY" index="3" memberName="gerry" memberType="U"/></accessElementList>< /casterObject></rootObject>"/> <entry key="IBIRS_args" value="__null"/> <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/ RESTAccessList.acl"/> </ibfsparams> <rootObject _jt="IBFSCasterObject" defaultLng="en_US" description="REST Access List" dummy="false" extension="acl" externalId="C34ea5140c31c0c4f68c8534ca97cd4538363" fullPath="/WFC/Repository/RESTful_Web_Services/Car_Reports/RESTAccessList.acl" handle="5ca19e73I55f0I4c4cI9cd1I48340f7da5d5" length="0" name="RESTAccessList.acl" policy="////D///9+f/////f/////////8AAAA=" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/ Car_Reports/RESTAccessList.acl" type="CasterAccessList"> <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12"> <entry> <key _jt="string" value="en_US"/> <value _jt="ArrayList" size="1"> <item _jt="string" index="0" value="REST Access List"/> </value> </entry> </nlsValues> <properties size="2"> <entry key="id" value="C34ea5140c31c0c4f68c8534ca97cd4538363"/> <entry key="tool" value="accesslist"/> </properties> <casterObject _jt="CasterLibraryAccessBook" burstValue="true" description="REST Access List" ibfsId="5ca19e73I55f0I4c4cI9cd1I48340f7da5d5" ibfsPath="" id="C34ea5140c31c0c4f68c8534ca97cd4538363" name="" owner="admin" policy="open,delete,rename,|,security;makeRules;viewRules" summary=""> <accessElementList _jt="array" itemsClass="CasterLibAccessElement" size="4"> <item _jt="CasterLibAccessElement" burstValue="FRANCE" index="0" memberName="daniel" memberType="U"/>
<item _jt="CasterLibAccessElement" burstValue="JAPAN" index="1" memberName="david" memberType="U"/> <item _jt="CasterLibAccessElement" burstValue="ENGLAND" index="2" memberName="efrem" memberType="U"/> <item _jt="CasterLibAccessElement" burstValue="ITALY" index="3" memberName="gerry" memberType="U"/> </accessElementList> </casterObject> </rootObject> </ibfsrpc>
If the value for the returncode attribute in the XML reponse is 10000, then the Library Access List was added successfully.
Example 2:
In this example:
The following REST URL retrieves an existing Library Access List:
http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/ Car_Reports/RESTAccessList.acl?IBIRS_action=get
POST Request URL:
http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/ Car_Reports/RESTAccessList.acl
Body:
IBIRS_action=put&IBIRS_object=<rootObject _jt="IBFSCasterObject" binary="false" createdOn="1349797553600" defaultLng="en_US" description="REST Access List - Updated" dummy="false" effectiveRSName="EDASERVE" extension="acl" externalId="C34ea5140c31c0c4f68c8534ca97cd4538363" fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/RESTAcces sList.acl" handle="5ca19e73I55f0I4c4cI9cd1I48340f7da5d5" lastModified="1349797553600" lastaccessBy="admin" lastaccessOn="1349797663457" length="0" name="RESTAccessList.acl" ownerId="10001" ownerName="admin" ownerType="U" policy="//3/D///9+f/////f/////////8AAAA=" returnedLng="en_US" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/Car_Reports /RESTAccessList.acl" type="CasterAccessList"><nlsValues _jt="HashMap" loadFactor="0.75" threshold="12"><entry><key _jt="string" value="en_US"/><value _jt="ArrayList" size="2"><item _jt="string" index="0" value="REST Access List - Updated"/></value></entry></nlsValues><properties size="2"><entry key="id" value="C34ea5140c31c0c4f68c8534ca97cd4538363"/><entry key="tool" value="accesslist"/></properties><casterObject _jt="CasterLibraryAccessBook" burstValue="true" description="REST Access List - Updated" ibfsId="5ca19e73I55f0I4c4cI9cd1I48340f7da5d5" ibfsPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports" id="C34ea5140c31c0c4f68c8534ca97cd4538363" name="RESTAccessList.acl" owner="admin" policy="open,delete,rename,|,security;makeRules;viewRules"><accessElement List _jt="array" itemsClass="CasterLibAccessElement" size="4"><item _jt="CasterLibAccessElement" burstValue="FRANCE" index="0" memberName="daniel" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="JAPAN" index="1" memberName="david" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ENGLAND" index="2" memberName="efrem" memberType="U"/><item _jt="CasterLibAccessElement" burstValue="ITALY" index="3" memberName="gerry" memberType="U"/></accessElementList></casterObject></rootObject>&IBIRS_re place=true&IBIRS_private=true
Response:
If the value for the returncode attribute in the XML response is 10000, then the Library Access List was updated successfully.
WebFOCUS |