cdocutils.nodes document q)q}q(U nametypesq}q(X CNView.viewqXread apiqNXCNCore.getFormatqXCNIdentity.createGroupq XCNRead.getChecksumq X"CNReplication.setReplicationStatusq XCNRead.getSystemMetadataq XCNIdentity.listSubjectsq XCNRegister.registerqXCNIdentity.removeMapIdentityqXCNCore.generateIdentifierqXCNIdentity.denyMapIdentityqXCNCore.getCapabilitiesqXCNIdentity.confirmMapIdentityqX CNRead.getqX xmlstarletqX!CNRegister.updateNodeCapabilitiesqXCNCore.setObsoletedByqX CNRead.getQueryEngineDescriptionqXCNCore.registerSystemMetadataqXCNAuthorization.isAuthorizedqX)CNReplication.setDefaultReplicationPolicyqXCNCore.listNodesqXCNRead.describeqX'CNReplication.updateReplicationMetadataqXCNIdentity.verifyAccountqXCNCore.getLogRecordsq Xview apiq!NX CNCore.deleteq"XCNAuthorization.setRightsHolderq#XCNIdentity.updateAccountq$XCNCore.listFormatsq%Xdiagnostic apiq&NXCNView.listViewsq'Xcore apiq(NX CNIdentity.getPendingMapIdentityq)X"CNReplication.getReplicationPolicyq*X CNRead.searchq+XCNAuthorization.setAccessPolicyq,XCNIdentity.getSubjectInfoq-XCNIdentity.registerAccountq.X'CNReplication.deleteReplicationMetadataq/XCNRead.listQueryEnginesq0XCNDiagnostic.echoIndexedObjectq1X identity apiq2NXCNDiagnostic.echoCredentialsq3XCNCore.updateSystemMetadataq4X CNRead.queryq5XCNRead.listObjectsq6XCNCore.archiveq7XCNRead.resolveq8XCNCore.hasReservationq9XCNReplication.replicateMetadataq:X CNCore.createq;X CNCore.pingqXCNIdentity.requestMapIdentityq?XCNDiagnostic.echoSystemMetadataq@XCNRead.synchronizeqAXd1_client_bashqBXCNIdentity.updateGroupqCXCNReplication.isNodeAuthorizedqDXCNCore.reserveIdentifierqEXauthorization apiqFNXreplication apiqGNXcoordinating node apisqHNXCNRegister.getNodeCapabilitiesqIX!CNReplication.isReplicationNeededqJX register apiqKNXCNIdentity.mapIdentityqLX"CNReplication.setReplicationPolicyqMuUsubstitution_defsqN}qOUparse_messagesqP]qQUcurrent_sourceqRNU decorationqSNUautofootnote_startqTKUnameidsqU}qV(hhhUread-apiqWhhh h h h h h h h h h hhhhhhhhhhhhhhhU xmlstarletqXhhhhhhhhhhhhhhhhhhhhh h h!Uview-apiqYh"h"h#h#h$h$h%h%h&Udiagnostic-apiqZh'h'h(Ucore-apiq[h)h)h*h*h+h+h,h,h-h-h.h.h/h/h0h0h1h1h2U identity-apiq\h3h3h4h4h5h5h6h6h7h7h8h8h9h9h:h:h;h;hh>h?h?h@h@hAhAhBUd1-client-bashq]hChChDhDhEhEhFUauthorization-apiq^hGUreplication-apiq_hHUcoordinating-node-apisq`hIhIhJhJhKU register-apiqahLhLhMhMuUchildrenqb]qccdocutils.nodes section qd)qe}qf(U rawsourceqgUUparentqhhUsourceqiXa/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/apis/CN_APIs.txtqjUtagnameqkUsectionqlU attributesqm}qn(Udupnamesqo]Uclassesqp]Ubackrefsqq]Uidsqr]qsh`aUnamesqt]quhHauUlineqvKUdocumentqwhhb]qx(cdocutils.nodes title qy)qz}q{(hgXCoordinating Node APIsq|hhhehihjhkUtitleq}hm}q~(ho]hp]hq]hr]ht]uhvKhwhhb]qcdocutils.nodes Text qXCoordinating Node APIsqq}q(hgh|hhhzubaubcdocutils.nodes paragraph q)q}q(hgXThe service interfaces described here are exposed through the Coordinating Node REST interface to support interactions with Member Nodes and DataONE clients.qhhhehihjhkU paragraphqhm}q(ho]hp]hq]hr]ht]uhvKhwhhb]qhXThe service interfaces described here are exposed through the Coordinating Node REST interface to support interactions with Member Nodes and DataONE clients.qq}q(hghhhhubaubh)q}q(hgXQThe following table provides a list of API methods exposed by Coordinating Nodes.qhhhehihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhwhhb]qhXQThe following table provides a list of API methods exposed by Coordinating Nodes.qq}q(hghhhhubaubcdocutils.nodes field_list q)q}q(hgUhhhehihjhkU field_listqhm}q(ho]hp]hq]hr]ht]uhvK hwhhb]q(cdocutils.nodes field q)q}q(hgUhhhhihjhkUfieldqhm}q(ho]hp]hq]hr]ht]uhvK hwhhb]q(cdocutils.nodes field_name q)q}q(hgXTierqhhhhihjhkU field_nameqhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXTierqq}q(hghhhhubaubcdocutils.nodes field_body q)q}q(hgX'The tier in which a method is grouped. hm}q(ho]hp]hq]hr]ht]uhhhhb]qh)q}q(hgX&The tier in which a method is grouped.qhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvK hb]qhX&The tier in which a method is grouped.qq}q(hghhhhubaubahkU field_bodyqubeubh)q}q(hgUhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhwhhb]q(h)q}q(hgXVersionqhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXVersionqÅq}q(hghhhhubaubh)q}q(hgXVersion of API method is available. The lowest version number indicates when the method was added. A version number in parentheses indicates the method is available in that version and is unchanged from the previous version. If more than one version number is present, then the method signature or functionality has changed between API versions. e.g. "1.0, 2.0" indicates that the method was first introduced in Version 1.0 and has been modified in Version 2.0. hm}q(ho]hp]hq]hr]ht]uhhhhb]qh)q}q(hgXVersion of API method is available. The lowest version number indicates when the method was added. A version number in parentheses indicates the method is available in that version and is unchanged from the previous version. If more than one version number is present, then the method signature or functionality has changed between API versions. e.g. "1.0, 2.0" indicates that the method was first introduced in Version 1.0 and has been modified in Version 2.0.qhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXVersion of API method is available. The lowest version number indicates when the method was added. A version number in parentheses indicates the method is available in that version and is unchanged from the previous version. If more than one version number is present, then the method signature or functionality has changed between API versions. e.g. "1.0, 2.0" indicates that the method was first introduced in Version 1.0 and has been modified in Version 2.0.qυq}q(hghhhhubaubahkhubeubh)q}q(hgUhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhwhhb]q(h)q}q(hgXRESTqhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXRESTqۅq}q(hghhhhubaubh)q}q(hgXThe HTTP method and path relative to the Base URL. Parameters specified in the URL are indicatd by braces. Note that parameters included in a path MUST be properly path encoded, and parameters included as key, value pairs MUST also be properly encoded. hm}q(ho]hp]hq]hr]ht]uhhhhb]qh)q}q(hgXThe HTTP method and path relative to the Base URL. Parameters specified in the URL are indicatd by braces. Note that parameters included in a path MUST be properly path encoded, and parameters included as key, value pairs MUST also be properly encoded.qhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXThe HTTP method and path relative to the Base URL. Parameters specified in the URL are indicatd by braces. Note that parameters included in a path MUST be properly path encoded, and parameters included as key, value pairs MUST also be properly encoded.q煁q}q(hghhhhubaubahkhubeubh)q}q(hgUhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhwhhb]q(h)q}q(hgXFunctionqhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvKhb]qhXFunctionqq}q(hghhhhubaubh)q}q(hgX4The function name, associated with an API grouping. hm}q(ho]hp]hq]hr]ht]uhhhhb]qh)q}q(hgX3The function name, associated with an API grouping.qhhhhihjhkhhm}q(ho]hp]hq]hr]ht]uhvK!hb]qhX3The function name, associated with an API grouping.qr}r(hghhhhubaubahkhubeubh)r}r(hgUhhhhihjhkhhm}r(ho]hp]hq]hr]ht]uhvK#hwhhb]r(h)r}r(hgX Parametersrhhjhihjhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX Parametersr r }r (hgjhhjubaubh)r}r(hgXjIndicates the parameters used when calling the method (sent in the message payload) and the return type. hm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXhIndicates the parameters used when calling the method (sent in the message payload) and the return type.rhhjhihjhkhhm}r(ho]hp]hq]hr]ht]uhvK%hb]rhXhIndicates the parameters used when calling the method (sent in the message payload) and the return type.rr}r(hgjhhjubaubahkhubeubeubcdocutils.nodes comment r)r}r(hgXBWarning: this file is automatically generated. Edits will be losthhhehicdocutils.nodes reprunicode rX5source/apis/generated/generated_CN_function_table.txtrr}r bhkUcommentr!hm}r"(U xml:spacer#Upreserver$hr]hq]ho]hp]ht]uhvKhwhhb]r%hXBWarning: this file is automatically generated. Edits will be lostr&r'}r((hgUhhjubaubcdocutils.nodes table r))r*}r+(hgUhhhehiNhkUtabler,hm}r-(ho]hp]hq]hr]r.Uid1r/aht]uhvNhwhhb]r0(hy)r1}r2(hgXMethods for CN componentr3hm}r4(ho]hp]hq]hr]ht]uhhj*hb]r5hXMethods for CN componentr6r7}r8(hgj3hhj1ubahkh}ubcdocutils.nodes tgroup r9)r:}r;(hgUhm}r<(hr]hq]ho]hp]ht]UcolsKuhhj*hb]r=(cdocutils.nodes colspec r>)r?}r@(hgUhm}rA(hr]hq]ho]hp]ht]UcolwidthKuhhj:hb]hkUcolspecrBubj>)rC}rD(hgUhm}rE(hr]hq]ho]hp]ht]UcolwidthKuhhj:hb]hkjBubj>)rF}rG(hgUhm}rH(hr]hq]ho]hp]ht]UcolwidthK uhhj:hb]hkjBubj>)rI}rJ(hgUhm}rK(hr]hq]ho]hp]ht]UcolwidthK uhhj:hb]hkjBubj>)rL}rM(hgUhm}rN(hr]hq]ho]hp]ht]UcolwidthKuhhj:hb]hkjBubcdocutils.nodes thead rO)rP}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhj:hb]rScdocutils.nodes row rT)rU}rV(hgUhm}rW(ho]hp]hq]hr]ht]uhhjPhb]rX(cdocutils.nodes entry rY)rZ}r[(hgUhm}r\(ho]hp]hq]hr]ht]uhhjUhb]r]h)r^}r_(hgXTierr`hhjZhijhkhhm}ra(ho]hp]hq]hr]ht]uhvK hb]rbhXTierrcrd}re(hgj`hhj^ubaubahkUentryrfubjY)rg}rh(hgUhm}ri(ho]hp]hq]hr]ht]uhhjUhb]rjh)rk}rl(hgXVersionrmhhjghijhkhhm}rn(ho]hp]hq]hr]ht]uhvK hb]rohXVersionrprq}rr(hgjmhhjkubaubahkjfubjY)rs}rt(hgUhm}ru(ho]hp]hq]hr]ht]uhhjUhb]rvh)rw}rx(hgXRESTryhhjshijhkhhm}rz(ho]hp]hq]hr]ht]uhvK hb]r{hXRESTr|r}}r~(hgjyhhjwubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjUhb]rh)r}r(hgXFunctionrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXFunctionrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjUhb]rh)r}r(hgX Parametersrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhX Parametersrr}r(hgjhhjubaubahkjfubehkUrowrubahkUtheadrubcdocutils.nodes tbody r)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj:hb]r(jT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``GET /monitor/ping``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rcdocutils.nodes literal r)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /monitor/pingrr}r(hgUhhjubahkUliteralrubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.ping`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rcsphinx.addnodes pending_xref r)r}r(hgjhhjhijhkU pending_xrefrhm}r(UreftypeXfuncUrefwarnrU reftargetrX CNCore.pingU refdomainXpyrhr]hq]U refexplicitho]hp]ht]UrefdocrX apis/CN_APIsrUpy:classrNU py:modulerNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(UxrefrjXpy-funcrehq]hr]ht]uhhjhb]rhX CNCore.ping()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX() ``->`` nullhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX() rr}r(hgX() hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX nullrr}r(hgX nullhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r (hgXTier 1r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hXTier 1rr}r(hgj hhj ubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r h)r!}r"(hgX``POST /object``r#hhjhijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r%j)r&}r'(hgj#hm}r((ho]hp]hq]hr]ht]uhhj!hb]r)hX POST /objectr*r+}r,(hgUhhj&ubahkjubaubahkjfubjY)r-}r.(hgUhm}r/(ho]hp]hq]hr]ht]uhhjhb]r0h)r1}r2(hgX:func:`CNCore.create`r3hhj-hijhkhhm}r4(ho]hp]hq]hr]ht]uhvKhb]r5j)r6}r7(hgj3hhj1hijhkjhm}r8(UreftypeXfuncjjX CNCore.createU refdomainXpyr9hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r:j)r;}r<(hgj3hm}r=(ho]hp]r>(jj9Xpy-funcr?ehq]hr]ht]uhhj6hb]r@hXCNCore.create()rArB}rC(hgUhhj;ubahkjubaubaubahkjfubjY)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhjhb]rGh)rH}rI(hgX(:class:`session`, :class:`pid`, ``object``, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hhjDhijhkhhm}rJ(ho]hp]hq]hr]ht]uhvKhb]rK(hX(rL}rM(hgX(hhjHubj)rN}rO(hgX:class:`session`rPhhjHhijhkjhm}rQ(UreftypeXclassjjX Types.SessionU refdomainXpyrRhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rSj)rT}rU(hgjPhm}rV(ho]hp]rW(jjRXpy-classrXehq]hr]ht]uhhjNhb]rYhXsessionrZr[}r\(hgUhhjTubahkjubaubhX, r]r^}r_(hgX, hhjHubj)r`}ra(hgX:class:`pid`rbhhjHhijhkjhm}rc(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrdhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rej)rf}rg(hgjbhm}rh(ho]hp]ri(jjdXpy-classrjehq]hr]ht]uhhj`hb]rkhXpidrlrm}rn(hgUhhjfubahkjubaubhX, rorp}rq(hgX, hhjHubj)rr}rs(hgX ``object``hm}rt(ho]hp]hq]hr]ht]uhhjHhb]ruhXobjectrvrw}rx(hgUhhjrubahkjubhX, ryrz}r{(hgX, hhjHubj)r|}r}(hgX&:class:`sysmeta`r~hhjHhijhkjhm}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgj~hm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhj|hb]rhXsysmetarr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjHubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjHhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjHubj)r}r(hgX:class:`Types.Identifier`rhhjHhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``GET /formats``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX GET /formatsrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.listFormats`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.listFormatsU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.listFormats()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX)() ``->`` :class:`Types.ObjectFormatList`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX() rr}r(hgX() hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.ObjectFormatList`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.ObjectFormatListU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.ObjectFormatListr r }r (hgUhhjubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r }r!(hgX1.0, 2.0r"hhjhijhkhhm}r#(ho]hp]hq]hr]ht]uhvKhb]r$hX1.0, 2.0r%r&}r'(hgj"hhj ubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhj hb]r+h)r,}r-(hgX``GET /formats/{formatId}``r.hhj(hijhkhhm}r/(ho]hp]hq]hr]ht]uhvKhb]r0j)r1}r2(hgj.hm}r3(ho]hp]hq]hr]ht]uhhj,hb]r4hXGET /formats/{formatId}r5r6}r7(hgUhhj1ubahkjubaubahkjfubjY)r8}r9(hgUhm}r:(ho]hp]hq]hr]ht]uhhj hb]r;h)r<}r=(hgX:func:`CNCore.getFormat`r>hhj8hijhkhhm}r?(ho]hp]hq]hr]ht]uhvK hb]r@j)rA}rB(hgj>hhj<hijhkjhm}rC(UreftypeXfuncjjXCNCore.getFormatU refdomainXpyrDhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK hb]rEj)rF}rG(hgj>hm}rH(ho]hp]rI(jjDXpy-funcrJehq]hr]ht]uhhjAhb]rKhXCNCore.getFormat()rLrM}rN(hgUhhjFubahkjubaubaubahkjfubjY)rO}rP(hgUhm}rQ(ho]hp]hq]hr]ht]uhhj hb]rRh)rS}rT(hgXT(:class:`formatId`) ``->`` :class:`Types.ObjectFormat`hhjOhijhkhhm}rU(ho]hp]hq]hr]ht]uhvK!hb]rV(hX(rW}rX(hgX(hhjSubj)rY}rZ(hgX/:class:`formatId`r[hhjShijhkjhm}r\(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyr]hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK!hb]r^j)r_}r`(hgj[hm}ra(ho]hp]rb(jj]Xpy-classrcehq]hr]ht]uhhjYhb]rdhXformatIdrerf}rg(hgUhhj_ubahkjubaubhX) rhri}rj(hgX) hhjSubj)rk}rl(hgX``->``hm}rm(ho]hp]hq]hr]ht]uhhjShb]rnhX->rorp}rq(hgUhhjkubahkjubhX rr}rs(hgX hhjSubj)rt}ru(hgX:class:`Types.ObjectFormat`rvhhjShijhkjhm}rw(UreftypeXclassjjXTypes.ObjectFormatU refdomainXpyrxhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK!hb]ryj)rz}r{(hgjvhm}r|(ho]hp]r}(jjxXpy-classr~ehq]hr]ht]uhhjthb]rhXTypes.ObjectFormatrr}r(hgUhhjzubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK"hb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK#hb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK$hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.getLogRecords`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK%hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.getLogRecordsU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK%hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.getLogRecords()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[event]`, ``[idFilter]``, ``[start]``, ``[count]``) ``->`` :class:`Types.Log`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK&hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX#:class:`[fromDate]`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX [fromDate]rr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX!:class:`[toDate]`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX[toDate]rr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX%:class:`[event]`rhhjhijhkjhm}r (UreftypeXclassjjXTypes.Event, stringU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK&hb]r j)r }r (hgjhm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhjhb]rhX[event]rr}r(hgUhhj ubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX``[idFilter]``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX [idFilter]rr}r(hgUhhjubahkjubhX, rr }r!(hgX, hhjubj)r"}r#(hgX ``[start]``hm}r$(ho]hp]hq]hr]ht]uhhjhb]r%hX[start]r&r'}r((hgUhhj"ubahkjubhX, r)r*}r+(hgX, hhjubj)r,}r-(hgX ``[count]``hm}r.(ho]hp]hq]hr]ht]uhhjhb]r/hX[count]r0r1}r2(hgUhhj,ubahkjubhX) r3r4}r5(hgX) hhjubj)r6}r7(hgX``->``hm}r8(ho]hp]hq]hr]ht]uhhjhb]r9hX->r:r;}r<(hgUhhj6ubahkjubhX r=}r>(hgX hhjubj)r?}r@(hgX:class:`Types.Log`rAhhjhijhkjhm}rB(UreftypeXclassjjX Types.LogU refdomainXpyrChr]hq]U refexplicitho]hp]ht]jjjNjNuhvK&hb]rDj)rE}rF(hgjAhm}rG(ho]hp]rH(jjCXpy-classrIehq]hr]ht]uhhj?hb]rJhX Types.LogrKrL}rM(hgUhhjEubahkjubaubeubahkjfubehkjubjT)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhjhb]rQ(jY)rR}rS(hgUhm}rT(ho]hp]hq]hr]ht]uhhjNhb]rUh)rV}rW(hgXTier 1rXhhjRhijhkhhm}rY(ho]hp]hq]hr]ht]uhvK'hb]rZhXTier 1r[r\}r](hgjXhhjVubaubahkjfubjY)r^}r_(hgUhm}r`(ho]hp]hq]hr]ht]uhhjNhb]rah)rb}rc(hgX1.0, 2.0rdhhj^hijhkhhm}re(ho]hp]hq]hr]ht]uhvK(hb]rfhX1.0, 2.0rgrh}ri(hgjdhhjbubaubahkjfubjY)rj}rk(hgUhm}rl(ho]hp]hq]hr]ht]uhhjNhb]rmh)rn}ro(hgX``POST /reserve``rphhjjhijhkhhm}rq(ho]hp]hq]hr]ht]uhvK)hb]rrj)rs}rt(hgjphm}ru(ho]hp]hq]hr]ht]uhhjnhb]rvhX POST /reserverwrx}ry(hgUhhjsubahkjubaubahkjfubjY)rz}r{(hgUhm}r|(ho]hp]hq]hr]ht]uhhjNhb]r}h)r~}r(hgX :func:`CNCore.reserveIdentifier`rhhjzhijhkhhm}r(ho]hp]hq]hr]ht]uhvK*hb]rj)r}r(hgjhhj~hijhkjhm}r(UreftypeXfuncjjXCNCore.reserveIdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK*hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.reserveIdentifier()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjNhb]rh)r}r(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK+hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK+hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`id`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK+hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.Identifier`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK+hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK,hb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK-hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /generate``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK.hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /generaterr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX!:func:`CNCore.generateIdentifier`r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvK/hb]r j)r }r (hgj hhjhijhkjhm}r(UreftypeXfuncjjXCNCore.generateIdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK/hb]rj)r}r(hgj hm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhj hb]rhXCNCore.generateIdentifier()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX^(:class:`session`, ``scheme``, ``[fragment]``) ``->`` :class:`Types.Identifier`hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvK0hb]r!(hX(r"}r#(hgX(hhjubj)r$}r%(hgX:class:`session`r&hhjhijhkjhm}r'(UreftypeXclassjjX Types.SessionU refdomainXpyr(hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK0hb]r)j)r*}r+(hgj&hm}r,(ho]hp]r-(jj(Xpy-classr.ehq]hr]ht]uhhj$hb]r/hXsessionr0r1}r2(hgUhhj*ubahkjubaubhX, r3r4}r5(hgX, hhjubj)r6}r7(hgX ``scheme``hm}r8(ho]hp]hq]hr]ht]uhhjhb]r9hXschemer:r;}r<(hgUhhj6ubahkjubhX, r=r>}r?(hgX, hhjubj)r@}rA(hgX``[fragment]``hm}rB(ho]hp]hq]hr]ht]uhhjhb]rChX [fragment]rDrE}rF(hgUhhj@ubahkjubhX) rGrH}rI(hgX) hhjubj)rJ}rK(hgX``->``hm}rL(ho]hp]hq]hr]ht]uhhjhb]rMhX->rNrO}rP(hgUhhjJubahkjubhX rQ}rR(hgX hhjubj)rS}rT(hgX:class:`Types.Identifier`rUhhjhijhkjhm}rV(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK0hb]rXj)rY}rZ(hgjUhm}r[(ho]hp]r\(jjWXpy-classr]ehq]hr]ht]uhhjShb]r^hXTypes.Identifierr_r`}ra(hgUhhjYubahkjubaubeubahkjfubehkjubjT)rb}rc(hgUhm}rd(ho]hp]hq]hr]ht]uhhjhb]re(jY)rf}rg(hgUhm}rh(ho]hp]hq]hr]ht]uhhjbhb]rih)rj}rk(hgXTier 1rlhhjfhijhkhhm}rm(ho]hp]hq]hr]ht]uhvK1hb]rnhXTier 1rorp}rq(hgjlhhjjubaubahkjfubjY)rr}rs(hgUhm}rt(ho]hp]hq]hr]ht]uhhjbhb]ruh)rv}rw(hgX 1.0, (2.0)rxhhjrhijhkhhm}ry(ho]hp]hq]hr]ht]uhvK2hb]rzhX 1.0, (2.0)r{r|}r}(hgjxhhjvubaubahkjfubjY)r~}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjbhb]rh)r}r(hgX``GET /checksum``rhhj~hijhkhhm}r(ho]hp]hq]hr]ht]uhvK3hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX GET /checksumrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjbhb]rh)r}r(hgX%:func:`CNCore.listChecksumAlgorithms`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK4hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.listChecksumAlgorithmsU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK4hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.listChecksumAlgorithms()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjbhb]rh)r}r(hgX.() ``->`` :class:`Types.ChecksumAlgorithmList`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK5hb]r(hX() rr}r(hgX() hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX$:class:`Types.ChecksumAlgorithmList`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.ChecksumAlgorithmListU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK5hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.ChecksumAlgorithmListrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]hkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK7hb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /obsoletedBy/{pid}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK8hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /obsoletedBy/{pid}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.setObsoletedBy`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK9hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.setObsoletedByU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK9hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.setObsoletedBy()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`pid`, :class:`obsoletedByPid`, ``serialVersion``) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK:hb]r (hX(r }r (hgX(hhjubj)r }r (hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK:hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhj hb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`r hhjhijhkjhm}r!(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr"hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK:hb]r#j)r$}r%(hgj hm}r&(ho]hp]r'(jj"Xpy-classr(ehq]hr]ht]uhhjhb]r)hXpidr*r+}r,(hgUhhj$ubahkjubaubhX, r-r.}r/(hgX, hhjubj)r0}r1(hgX):class:`obsoletedByPid`r2hhjhijhkjhm}r3(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr4hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK:hb]r5j)r6}r7(hgj2hm}r8(ho]hp]r9(jj4Xpy-classr:ehq]hr]ht]uhhj0hb]r;hXobsoletedByPidr<r=}r>(hgUhhj6ubahkjubaubhX, r?r@}rA(hgX, hhjubj)rB}rC(hgX``serialVersion``hm}rD(ho]hp]hq]hr]ht]uhhjhb]rEhX serialVersionrFrG}rH(hgUhhjBubahkjubhX) rIrJ}rK(hgX) hhjubj)rL}rM(hgX``->``hm}rN(ho]hp]hq]hr]ht]uhhjhb]rOhX->rPrQ}rR(hgUhhjLubahkjubhX booleanrSrT}rU(hgX booleanhhjubeubahkjfubehkjubjT)rV}rW(hgUhm}rX(ho]hp]hq]hr]ht]uhhjhb]rY(jY)rZ}r[(hgUhm}r\(ho]hp]hq]hr]ht]uhhjVhb]r]h)r^}r_(hgXTier 3r`hhjZhijhkhhm}ra(ho]hp]hq]hr]ht]uhvK;hb]rbhXTier 3rcrd}re(hgj`hhj^ubaubahkjfubjY)rf}rg(hgUhm}rh(ho]hp]hq]hr]ht]uhhjVhb]rih)rj}rk(hgX 1.0, (2.0)rlhhjfhijhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX CNCore.deleteU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK>hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.delete()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjVhb]rh)r}r(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK?hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK?hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`id`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK?hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.Identifier`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvK?hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 3rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK@hb]rhXTier 3rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKAhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /archive/{id}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKBhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /archive/{id}rr }r (hgUhhjubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.archive`rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKChb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.archiveU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKChb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.archive()rr }r!(hgUhhjubahkjubaubaubahkjfubjY)r"}r#(hgUhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%h)r&}r'(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhj"hijhkhhm}r((ho]hp]hq]hr]ht]uhvKDhb]r)(hX(r*}r+(hgX(hhj&ubj)r,}r-(hgX:class:`session`r.hhj&hijhkjhm}r/(UreftypeXclassjjX Types.SessionU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKDhb]r1j)r2}r3(hgj.hm}r4(ho]hp]r5(jj0Xpy-classr6ehq]hr]ht]uhhj,hb]r7hXsessionr8r9}r:(hgUhhj2ubahkjubaubhX, r;r<}r=(hgX, hhj&ubj)r>}r?(hgX:class:`id`r@hhj&hijhkjhm}rA(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrBhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKDhb]rCj)rD}rE(hgj@hm}rF(ho]hp]rG(jjBXpy-classrHehq]hr]ht]uhhj>hb]rIhXidrJrK}rL(hgUhhjDubahkjubaubhX) rMrN}rO(hgX) hhj&ubj)rP}rQ(hgX``->``hm}rR(ho]hp]hq]hr]ht]uhhj&hb]rShX->rTrU}rV(hgUhhjPubahkjubhX rW}rX(hgX hhj&ubj)rY}rZ(hgX:class:`Types.Identifier`r[hhj&hijhkjhm}r\(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr]hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKDhb]r^j)r_}r`(hgj[hm}ra(ho]hp]rb(jj]Xpy-classrcehq]hr]ht]uhhjYhb]rdhXTypes.Identifierrerf}rg(hgUhhj_ubahkjubaubeubahkjfubehkjubjT)rh}ri(hgUhm}rj(ho]hp]hq]hr]ht]uhhjhb]rk(jY)rl}rm(hgUhm}rn(ho]hp]hq]hr]ht]uhhjhhb]roh)rp}rq(hgXTier 1rrhhjlhijhkhhm}rs(ho]hp]hq]hr]ht]uhvKEhb]rthXTier 1rurv}rw(hgjrhhjpubaubahkjfubjY)rx}ry(hgUhm}rz(ho]hp]hq]hr]ht]uhhjhhb]r{h)r|}r}(hgX1.0, 2.0r~hhjxhijhkhhm}r(ho]hp]hq]hr]ht]uhvKFhb]rhX1.0, 2.0rr}r(hgj~hhj|ubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]rh)r}r(hgX ``GET /node``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKGhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX GET /noderr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]rh)r}r(hgX:func:`CNCore.listNodes`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKHhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.listNodesU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKHhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNCore.listNodes()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]rh)r}r(hgX!() ``->`` :class:`Types.NodeList`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKIhb]r(hX() rr}r(hgX() hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.NodeList`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeListU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKIhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.NodeListrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKJhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX ``GET /``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKLhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNCore.getCapabilities`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKMhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNCore.getCapabilitiesU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKMhb]rj)r}r (hgjhm}r (ho]hp]r (jjXpy-funcr ehq]hr]ht]uhhjhb]r hXCNCore.getCapabilities()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX() ``->`` :class:`Types.Node`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKNhb]r(hX() rr}r(hgX() hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->r r!}r"(hgUhhjubahkjubhX r#}r$(hgX hhjubj)r%}r&(hgX:class:`Types.Node`r'hhjhijhkjhm}r((UreftypeXclassjjX Types.NodeU refdomainXpyr)hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKNhb]r*j)r+}r,(hgj'hm}r-(ho]hp]r.(jj)Xpy-classr/ehq]hr]ht]uhhj%hb]r0hX Types.Noder1r2}r3(hgUhhj+ubahkjubaubeubahkjfubehkjubjT)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7(jY)r8}r9(hgUhm}r:(ho]hp]hq]hr]ht]uhhj4hb]r;h)r<}r=(hgXTier 1r>hhj8hijhkhhm}r?(ho]hp]hq]hr]ht]uhvKOhb]r@hXTier 1rArB}rC(hgj>hhj<ubaubahkjfubjY)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhj4hb]rGh)rH}rI(hgX1.0, 2.0rJhhjDhijhkhhm}rK(ho]hp]hq]hr]ht]uhvKPhb]rLhX1.0, 2.0rMrN}rO(hgjJhhjHubaubahkjfubjY)rP}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhj4hb]rSh)rT}rU(hgX``POST /meta``rVhhjPhijhkhhm}rW(ho]hp]hq]hr]ht]uhvKQhb]rXj)rY}rZ(hgjVhm}r[(ho]hp]hq]hr]ht]uhhjThb]r\hX POST /metar]r^}r_(hgUhhjYubahkjubaubahkjfubjY)r`}ra(hgUhm}rb(ho]hp]hq]hr]ht]uhhj4hb]rch)rd}re(hgX%:func:`CNCore.registerSystemMetadata`rfhhj`hijhkhhm}rg(ho]hp]hq]hr]ht]uhvKRhb]rhj)ri}rj(hgjfhhjdhijhkjhm}rk(UreftypeXfuncjjXCNCore.registerSystemMetadataU refdomainXpyrlhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKRhb]rmj)rn}ro(hgjfhm}rp(ho]hp]rq(jjlXpy-funcrrehq]hr]ht]uhhjihb]rshXCNCore.registerSystemMetadata()rtru}rv(hgUhhjnubahkjubaubaubahkjfubjY)rw}rx(hgUhm}ry(ho]hp]hq]hr]ht]uhhj4hb]rzh)r{}r|(hgX(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hhjwhijhkhhm}r}(ho]hp]hq]hr]ht]uhvKShb]r~(hX(r}r(hgX(hhj{ubj)r}r(hgX:class:`session`rhhj{hijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKShb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhj{ubj)r}r(hgX:class:`pid`rhhj{hijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKShb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhj{ubj)r}r(hgX&:class:`sysmeta`rhhj{hijhkjhm}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKShb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsysmetarr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhj{ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj{hb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhj{ubj)r}r(hgX:class:`Types.Identifier`rhhj{hijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKShb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKThb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKUhb]rhX2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX ``PUT /meta``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKVhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX PUT /metarr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r (hgX#:func:`CNCore.updateSystemMetadata`r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKWhb]r j)r }r (hgj hhjhijhkjhm}r (UreftypeXfuncjjXCNCore.updateSystemMetadataU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKWhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNCore.updateSystemMetadata()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgXx(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` booleanhhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKXhb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKXhb]r! j)r" }r# (hgj hm}r$ (ho]hp]r% (jj Xpy-classr& ehq]hr]ht]uhhj hb]r' hXsessionr( r) }r* (hgUhhj" ubahkjubaubhX, r+ r, }r- (hgX, hhj ubj)r. }r/ (hgX:class:`pid`r0 hhj hijhkjhm}r1 (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr2 hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKXhb]r3 j)r4 }r5 (hgj0 hm}r6 (ho]hp]r7 (jj2 Xpy-classr8 ehq]hr]ht]uhhj. hb]r9 hXpidr: r; }r< (hgUhhj4 ubahkjubaubhX, r= r> }r? (hgX, hhj ubj)r@ }rA (hgX&:class:`sysmeta`rB hhj hijhkjhm}rC (UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrD hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKXhb]rE j)rF }rG (hgjB hm}rH (ho]hp]rI (jjD Xpy-classrJ ehq]hr]ht]uhhj@ hb]rK hXsysmetarL rM }rN (hgUhhjF ubahkjubaubhX) rO rP }rQ (hgX) hhj ubj)rR }rS (hgX``->``hm}rT (ho]hp]hq]hr]ht]uhhj hb]rU hX->rV rW }rX (hgUhhjR ubahkjubhX booleanrY rZ }r[ (hgX booleanhhj ubeubahkjfubehkjubjT)r\ }r] (hgUhm}r^ (ho]hp]hq]hr]ht]uhhjhb]r_ (jY)r` }ra (hgUhm}rb (ho]hp]hq]hr]ht]uhhj\ hb]hkjfubjY)rc }rd (hgUhm}re (ho]hp]hq]hr]ht]uhhj\ hb]rf h)rg }rh (hgX1.0, 2.0ri hhjc hijhkhhm}rj (ho]hp]hq]hr]ht]uhvKZhb]rk hX1.0, 2.0rl rm }rn (hgji hhjg ubaubahkjfubjY)ro }rp (hgUhm}rq (ho]hp]hq]hr]ht]uhhj\ hb]rr h)rs }rt (hgX'``GET /reserve/{id}?subject={subject}``ru hhjo hijhkhhm}rv (ho]hp]hq]hr]ht]uhvK[hb]rw j)rx }ry (hgju hm}rz (ho]hp]hq]hr]ht]uhhjs hb]r{ hX#GET /reserve/{id}?subject={subject}r| r} }r~ (hgUhhjx ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj\ hb]r h)r }r (hgX:func:`CNCore.hasReservation`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK\hb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjXCNCore.hasReservationU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK\hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNCore.hasReservation()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj\ hb]r h)r }r (hgXp(:class:`session`, :class:`subject`, :class:`id`) ``->`` booleanhhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK]hb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK]hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX:class:`subject`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SubjectU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK]hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsubjectr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX:class:`id`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK]hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXidr r }r (hgUhhj ubahkjubaubhX) r r }r (hgX) hhj ubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX->r r }r (hgUhhj ubahkjubhX booleanr r }r (hgX booleanhhj ubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK_hb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX1.0, 2.0r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK`hb]r hX1.0, 2.0r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX``GET /object/{id}``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKahb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXGET /object/{id}r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX:func:`CNRead.get`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKbhb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjX CNRead.getU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKbhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hX CNRead.get()r r! }r" (hgUhhj ubahkjubaubaubahkjfubjY)r# }r$ (hgUhm}r% (ho]hp]hq]hr]ht]uhhj hb]r& h)r' }r( (hgXb(:class:`session`, :class:`id`) ``->`` :class:`Types.OctetStream`hhj# hijhkhhm}r) (ho]hp]hq]hr]ht]uhvKchb]r* (hX(r+ }r, (hgX(hhj' ubj)r- }r. (hgX:class:`session`r/ hhj' hijhkjhm}r0 (UreftypeXclassjjX Types.SessionU refdomainXpyr1 hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKchb]r2 j)r3 }r4 (hgj/ hm}r5 (ho]hp]r6 (jj1 Xpy-classr7 ehq]hr]ht]uhhj- hb]r8 hXsessionr9 r: }r; (hgUhhj3 ubahkjubaubhX, r< r= }r> (hgX, hhj' ubj)r? }r@ (hgX:class:`id`rA hhj' hijhkjhm}rB (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrC hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKchb]rD j)rE }rF (hgjA hm}rG (ho]hp]rH (jjC Xpy-classrI ehq]hr]ht]uhhj? hb]rJ hXidrK rL }rM (hgUhhjE ubahkjubaubhX) rN rO }rP (hgX) hhj' ubj)rQ }rR (hgX``->``hm}rS (ho]hp]hq]hr]ht]uhhj' hb]rT hX->rU rV }rW (hgUhhjQ ubahkjubhX rX }rY (hgX hhj' ubj)rZ }r[ (hgX:class:`Types.OctetStream`r\ hhj' hijhkjhm}r] (UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr^ hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKchb]r_ j)r` }ra (hgj\ hm}rb (ho]hp]rc (jj^ Xpy-classrd ehq]hr]ht]uhhjZ hb]re hXTypes.OctetStreamrf rg }rh (hgUhhj` ubahkjubaubeubahkjfubehkjubjT)ri }rj (hgUhm}rk (ho]hp]hq]hr]ht]uhhjhb]rl (jY)rm }rn (hgUhm}ro (ho]hp]hq]hr]ht]uhhji hb]rp h)rq }rr (hgXTier 1rs hhjm hijhkhhm}rt (ho]hp]hq]hr]ht]uhvKdhb]ru hXTier 1rv rw }rx (hgjs hhjq ubaubahkjfubjY)ry }rz (hgUhm}r{ (ho]hp]hq]hr]ht]uhhji hb]r| h)r} }r~ (hgX1.0, 2.0r hhjy hijhkhhm}r (ho]hp]hq]hr]ht]uhvKehb]r hX1.0, 2.0r r }r (hgj hhj} ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhji hb]r h)r }r (hgX``GET /meta/{id}``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKfhb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXGET /meta/{id}r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhji hb]r h)r }r (hgX :func:`CNRead.getSystemMetadata`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKghb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjXCNRead.getSystemMetadataU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKghb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNRead.getSystemMetadata()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhji hb]r h)r }r (hgXe(:class:`session`, :class:`id`) ``->`` :class:`Types.SystemMetadata`hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhhb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX:class:`id`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXidr r }r (hgUhhj ubahkjubaubhX) r r }r (hgX) hhj ubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX->r r }r (hgUhhj ubahkjubhX r }r (hgX hhj ubj)r }r (hgX:class:`Types.SystemMetadata`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXTypes.SystemMetadatar r }r (hgUhhj ubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKihb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX1.0, 2.0r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKjhb]r hX1.0, 2.0r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX``HEAD /object/{id}``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKkhb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXHEAD /object/{id}r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r! h)r" }r# (hgX:func:`CNRead.describe`r$ hhj hijhkhhm}r% (ho]hp]hq]hr]ht]uhvKlhb]r& j)r' }r( (hgj$ hhj" hijhkjhm}r) (UreftypeXfuncjjXCNRead.describeU refdomainXpyr* hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKlhb]r+ j)r, }r- (hgj$ hm}r. (ho]hp]r/ (jj* Xpy-funcr0 ehq]hr]ht]uhhj' hb]r1 hXCNRead.describe()r2 r3 }r4 (hgUhhj, ubahkjubaubaubahkjfubjY)r5 }r6 (hgUhm}r7 (ho]hp]hq]hr]ht]uhhj hb]r8 h)r9 }r: (hgXg(:class:`session`, :class:`id`) ``->`` :class:`Types.DescribeResponse`hhj5 hijhkhhm}r; (ho]hp]hq]hr]ht]uhvKmhb]r< (hX(r= }r> (hgX(hhj9 ubj)r? }r@ (hgX:class:`session`rA hhj9 hijhkjhm}rB (UreftypeXclassjjX Types.SessionU refdomainXpyrC hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKmhb]rD j)rE }rF (hgjA hm}rG (ho]hp]rH (jjC Xpy-classrI ehq]hr]ht]uhhj? hb]rJ hXsessionrK rL }rM (hgUhhjE ubahkjubaubhX, rN rO }rP (hgX, hhj9 ubj)rQ }rR (hgX:class:`id`rS hhj9 hijhkjhm}rT (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrU hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKmhb]rV j)rW }rX (hgjS hm}rY (ho]hp]rZ (jjU Xpy-classr[ ehq]hr]ht]uhhjQ hb]r\ hXidr] r^ }r_ (hgUhhjW ubahkjubaubhX) r` ra }rb (hgX) hhj9 ubj)rc }rd (hgX``->``hm}re (ho]hp]hq]hr]ht]uhhj9 hb]rf hX->rg rh }ri (hgUhhjc ubahkjubhX rj }rk (hgX hhj9 ubj)rl }rm (hgX:class:`Types.DescribeResponse`rn hhj9 hijhkjhm}ro (UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyrp hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKmhb]rq j)rr }rs (hgjn hm}rt (ho]hp]ru (jjp Xpy-classrv ehq]hr]ht]uhhjl hb]rw hXTypes.DescribeResponserx ry }rz (hgUhhjr ubahkjubaubeubahkjfubehkjubjT)r{ }r| (hgUhm}r} (ho]hp]hq]hr]ht]uhhjhb]r~ (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj{ hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKnhb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj{ hb]r h)r }r (hgX1.0, 2.0r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKohb]r hX1.0, 2.0r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj{ hb]r h)r }r (hgX``GET /resolve/{id}``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKphb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXGET /resolve/{id}r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj{ hb]r h)r }r (hgX:func:`CNRead.resolve`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKqhb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjXCNRead.resolveU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKqhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNRead.resolve()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj{ hb]r h)r }r (hgXi(:class:`session`, :class:`id`) ``->`` :class:`Types.ObjectLocationList`hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKrhb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKrhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX:class:`id`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKrhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXidr r }r (hgUhhj ubahkjubaubhX) r r }r (hgX) hhj ubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX->r r }r (hgUhhj ubahkjubhX r }r (hgX hhj ubj)r }r (hgX!:class:`Types.ObjectLocationList`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.ObjectLocationListU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKrhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXTypes.ObjectLocationListr r }r (hgUhhj ubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKshb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX 1.0, (2.0)r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKthb]r hX 1.0, (2.0)r r }r (hgj hhj ubaubahkjfubjY)r }r! (hgUhm}r" (ho]hp]hq]hr]ht]uhhj hb]r# h)r$ }r% (hgX``GET /checksum/{pid}``r& hhj hijhkhhm}r' (ho]hp]hq]hr]ht]uhvKuhb]r( j)r) }r* (hgj& hm}r+ (ho]hp]hq]hr]ht]uhhj$ hb]r, hXGET /checksum/{pid}r- r. }r/ (hgUhhj) ubahkjubaubahkjfubjY)r0 }r1 (hgUhm}r2 (ho]hp]hq]hr]ht]uhhj hb]r3 h)r4 }r5 (hgX:func:`CNRead.getChecksum`r6 hhj0 hijhkhhm}r7 (ho]hp]hq]hr]ht]uhvKvhb]r8 j)r9 }r: (hgj6 hhj4 hijhkjhm}r; (UreftypeXfuncjjXCNRead.getChecksumU refdomainXpyr< hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKvhb]r= j)r> }r? (hgj6 hm}r@ (ho]hp]rA (jj< Xpy-funcrB ehq]hr]ht]uhhj9 hb]rC hXCNRead.getChecksum()rD rE }rF (hgUhhj> ubahkjubaubaubahkjfubjY)rG }rH (hgUhm}rI (ho]hp]hq]hr]ht]uhhj hb]rJ h)rK }rL (hgX`(:class:`session`, :class:`pid`) ``->`` :class:`Types.Checksum`hhjG hijhkhhm}rM (ho]hp]hq]hr]ht]uhvKwhb]rN (hX(rO }rP (hgX(hhjK ubj)rQ }rR (hgX:class:`session`rS hhjK hijhkjhm}rT (UreftypeXclassjjX Types.SessionU refdomainXpyrU hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKwhb]rV j)rW }rX (hgjS hm}rY (ho]hp]rZ (jjU Xpy-classr[ ehq]hr]ht]uhhjQ hb]r\ hXsessionr] r^ }r_ (hgUhhjW ubahkjubaubhX, r` ra }rb (hgX, hhjK ubj)rc }rd (hgX:class:`pid`re hhjK hijhkjhm}rf (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrg hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKwhb]rh j)ri }rj (hgje hm}rk (ho]hp]rl (jjg Xpy-classrm ehq]hr]ht]uhhjc hb]rn hXpidro rp }rq (hgUhhji ubahkjubaubhX) rr rs }rt (hgX) hhjK ubj)ru }rv (hgX``->``hm}rw (ho]hp]hq]hr]ht]uhhjK hb]rx hX->ry rz }r{ (hgUhhju ubahkjubhX r| }r} (hgX hhjK ubj)r~ }r (hgX:class:`Types.Checksum`r hhjK hijhkjhm}r (UreftypeXclassjjXTypes.ChecksumU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKwhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj~ hb]r hXTypes.Checksumr r }r (hgUhhj ubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKxhb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX 1.0, (2.0)r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKyhb]r hX 1.0, (2.0)r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKzhb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX:func:`CNRead.listObjects`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK{hb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjXCNRead.listObjectsU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK{hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNRead.listObjects()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX/(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[formatId]`, :class:`[identifier]`, ``[start=0]``, ``[count=1000]``, :class:`[nodeId]`) ``->`` :class:`Types.ObjectList`hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK|hb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX#:class:`[fromDate]`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.DateTimeU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hX [fromDate]r r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX!:class:`[toDate]`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.DateTimeU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hX[toDate]r r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX1:class:`[formatId]`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hX [formatId]r r }r (hgUhhj ubahkjubaubhX, r r }r! (hgX, hhj ubj)r" }r# (hgX':class:`[identifier]`r$ hhj hijhkjhm}r% (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr& hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]r' j)r( }r) (hgj$ hm}r* (ho]hp]r+ (jj& Xpy-classr, ehq]hr]ht]uhhj" hb]r- hX [identifier]r. r/ }r0 (hgUhhj( ubahkjubaubhX, r1 r2 }r3 (hgX, hhj ubj)r4 }r5 (hgX ``[start=0]``hm}r6 (ho]hp]hq]hr]ht]uhhj hb]r7 hX [start=0]r8 r9 }r: (hgUhhj4 ubahkjubhX, r; r< }r= (hgX, hhj ubj)r> }r? (hgX``[count=1000]``hm}r@ (ho]hp]hq]hr]ht]uhhj hb]rA hX [count=1000]rB rC }rD (hgUhhj> ubahkjubhX, rE rF }rG (hgX, hhj ubj)rH }rI (hgX&:class:`[nodeId]`rJ hhj hijhkjhm}rK (UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrL hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]rM j)rN }rO (hgjJ hm}rP (ho]hp]rQ (jjL Xpy-classrR ehq]hr]ht]uhhjH hb]rS hX[nodeId]rT rU }rV (hgUhhjN ubahkjubaubhX) rW rX }rY (hgX) hhj ubj)rZ }r[ (hgX``->``hm}r\ (ho]hp]hq]hr]ht]uhhj hb]r] hX->r^ r_ }r` (hgUhhjZ ubahkjubhX ra }rb (hgX hhj ubj)rc }rd (hgX:class:`Types.ObjectList`re hhj hijhkjhm}rf (UreftypeXclassjjXTypes.ObjectListU refdomainXpyrg hr]hq]U refexplicitho]hp]ht]jjjNjNuhvK|hb]rh j)ri }rj (hgje hm}rk (ho]hp]rl (jjg Xpy-classrm ehq]hr]ht]uhhjc hb]rn hXTypes.ObjectListro rp }rq (hgUhhji ubahkjubaubeubahkjfubehkjubjT)rr }rs (hgUhm}rt (ho]hp]hq]hr]ht]uhhjhb]ru (jY)rv }rw (hgUhm}rx (ho]hp]hq]hr]ht]uhhjr hb]ry h)rz }r{ (hgXTier 1r| hhjv hijhkhhm}r} (ho]hp]hq]hr]ht]uhvK}hb]r~ hXTier 1r r }r (hgj| hhjz ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjr hb]r h)r }r (hgX 1.0, (2.0)r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvK~hb]r hX 1.0, (2.0)r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjr hb]r h)r }r (hgX#``GET /search/{queryType}/{query}``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXGET /search/{queryType}/{query}r r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjr hb]r h)r }r (hgX:func:`CNRead.search`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjX CNRead.searchU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXCNRead.search()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjr hb]r h)r }r (hgX\(:class:`session`, ``queryType``, ``query``) ``->`` :class:`Types.ObjectList`hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX, r r }r (hgX, hhj ubj)r }r (hgX ``queryType``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX queryTyper r }r (hgUhhj ubahkjubhX, r r }r (hgX, hhj ubj)r }r (hgX ``query``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXqueryr r }r (hgUhhj ubahkjubhX) r r }r (hgX) hhj ubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX->r r }r (hgUhhj ubahkjubhX r }r (hgX hhj ubj)r }r (hgX:class:`Types.ObjectList`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.ObjectListU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXTypes.ObjectListr r }r (hgUhhj ubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r hXTier 1r r }r (hgjhhjubaubahkjfubjY)r }r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgX 1.1, (2.0)rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.1, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgX$``GET /query/{queryEngine}/{query}``rhhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r!j)r"}r#(hgjhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%hX GET /query/{queryEngine}/{query}r&r'}r((hgUhhj"ubahkjubaubahkjfubjY)r)}r*(hgUhm}r+(ho]hp]hq]hr]ht]uhhj hb]r,h)r-}r.(hgX:func:`CNRead.query`r/hhj)hijhkhhm}r0(ho]hp]hq]hr]ht]uhvKhb]r1j)r2}r3(hgj/hhj-hijhkjhm}r4(UreftypeXfuncjjX CNRead.queryU refdomainXpyr5hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r6j)r7}r8(hgj/hm}r9(ho]hp]r:(jj5Xpy-funcr;ehq]hr]ht]uhhj2hb]r<hXCNRead.query()r=r>}r?(hgUhhj7ubahkjubaubaubahkjfubjY)r@}rA(hgUhm}rB(ho]hp]hq]hr]ht]uhhj hb]rCh)rD}rE(hgX_(:class:`session`, ``queryEngine``, ``query``) ``->`` :class:`Types.OctetStream`hhj@hijhkhhm}rF(ho]hp]hq]hr]ht]uhvKhb]rG(hX(rH}rI(hgX(hhjDubj)rJ}rK(hgX:class:`session`rLhhjDhijhkjhm}rM(UreftypeXclassjjX Types.SessionU refdomainXpyrNhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rOj)rP}rQ(hgjLhm}rR(ho]hp]rS(jjNXpy-classrTehq]hr]ht]uhhjJhb]rUhXsessionrVrW}rX(hgUhhjPubahkjubaubhX, rYrZ}r[(hgX, hhjDubj)r\}r](hgX``queryEngine``hm}r^(ho]hp]hq]hr]ht]uhhjDhb]r_hX queryEnginer`ra}rb(hgUhhj\ubahkjubhX, rcrd}re(hgX, hhjDubj)rf}rg(hgX ``query``hm}rh(ho]hp]hq]hr]ht]uhhjDhb]rihXqueryrjrk}rl(hgUhhjfubahkjubhX) rmrn}ro(hgX) hhjDubj)rp}rq(hgX``->``hm}rr(ho]hp]hq]hr]ht]uhhjDhb]rshX->rtru}rv(hgUhhjpubahkjubhX rw}rx(hgX hhjDubj)ry}rz(hgX:class:`Types.OctetStream`r{hhjDhijhkjhm}r|(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr}hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r~j)r}r(hgj{hm}r(ho]hp]r(jj}Xpy-classrehq]hr]ht]uhhjyhb]rhXTypes.OctetStreamrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.1, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.1, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``GET /query/{queryType}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /query/{queryType}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:func:`CNRead.getQueryEngineDescription`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX CNRead.getQueryEngineDescriptionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX"CNRead.getQueryEngineDescription()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX_(:class:`session`, ``queryEngine``) ``->`` :class:`Types.QueryEngineDescription`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX``queryEngine``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX queryEnginerr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX%:class:`Types.QueryEngineDescription`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.QueryEngineDescriptionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.QueryEngineDescriptionrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r (jY)r }r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgXTier 1rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgX 1.1, (2.0)rhhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r!hX 1.1, (2.0)r"r#}r$(hgjhhjubaubahkjfubjY)r%}r&(hgUhm}r'(ho]hp]hq]hr]ht]uhhj hb]r(h)r)}r*(hgX``GET /query``r+hhj%hijhkhhm}r,(ho]hp]hq]hr]ht]uhvKhb]r-j)r.}r/(hgj+hm}r0(ho]hp]hq]hr]ht]uhhj)hb]r1hX GET /queryr2r3}r4(hgUhhj.ubahkjubaubahkjfubjY)r5}r6(hgUhm}r7(ho]hp]hq]hr]ht]uhhj hb]r8h)r9}r:(hgX:func:`CNRead.listQueryEngines`r;hhj5hijhkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r=j)r>}r?(hgj;hhj9hijhkjhm}r@(UreftypeXfuncjjXCNRead.listQueryEnginesU refdomainXpyrAhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rBj)rC}rD(hgj;hm}rE(ho]hp]rF(jjAXpy-funcrGehq]hr]ht]uhhj>hb]rHhXCNRead.listQueryEngines()rIrJ}rK(hgUhhjCubahkjubaubaubahkjfubjY)rL}rM(hgUhm}rN(ho]hp]hq]hr]ht]uhhj hb]rOh)rP}rQ(hgXG(:class:`session`) ``->`` :class:`Types.QueryEngineList`hhjLhijhkhhm}rR(ho]hp]hq]hr]ht]uhvKhb]rS(hX(rT}rU(hgX(hhjPubj)rV}rW(hgX:class:`session`rXhhjPhijhkjhm}rY(UreftypeXclassjjX Types.SessionU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r[j)r\}r](hgjXhm}r^(ho]hp]r_(jjZXpy-classr`ehq]hr]ht]uhhjVhb]rahXsessionrbrc}rd(hgUhhj\ubahkjubaubhX) rerf}rg(hgX) hhjPubj)rh}ri(hgX``->``hm}rj(ho]hp]hq]hr]ht]uhhjPhb]rkhX->rlrm}rn(hgUhhjhubahkjubhX ro}rp(hgX hhjPubj)rq}rr(hgX:class:`Types.QueryEngineList`rshhjPhijhkjhm}rt(UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyruhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rvj)rw}rx(hgjshm}ry(ho]hp]rz(jjuXpy-classr{ehq]hr]ht]uhhjqhb]r|hXTypes.QueryEngineListr}r~}r(hgUhhjwubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /synchronize``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /synchronizerr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNRead.synchronize`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNRead.synchronizeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNRead.synchronize()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXP(:class:`session`, :class:`pid`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr }r (hgjhhjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /owner/{id}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r }r!(hgjhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#hXPUT /owner/{id}r$r%}r&(hgUhhj ubahkjubaubahkjfubjY)r'}r((hgUhm}r)(ho]hp]hq]hr]ht]uhhjhb]r*h)r+}r,(hgX':func:`CNAuthorization.setRightsHolder`r-hhj'hijhkhhm}r.(ho]hp]hq]hr]ht]uhvKhb]r/j)r0}r1(hgj-hhj+hijhkjhm}r2(UreftypeXfuncjjXCNAuthorization.setRightsHolderU refdomainXpyr3hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r4j)r5}r6(hgj-hm}r7(ho]hp]r8(jj3Xpy-funcr9ehq]hr]ht]uhhj0hb]r:hX!CNAuthorization.setRightsHolder()r;r<}r=(hgUhhj5ubahkjubaubaubahkjfubjY)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhjhb]rAh)rB}rC(hgX(:class:`session`, :class:`id`, :class:`userId`, ``serialVersion``) ``->`` :class:`Types.Identifier`hhj>hijhkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rE(hX(rF}rG(hgX(hhjBubj)rH}rI(hgX:class:`session`rJhhjBhijhkjhm}rK(UreftypeXclassjjX Types.SessionU refdomainXpyrLhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rMj)rN}rO(hgjJhm}rP(ho]hp]rQ(jjLXpy-classrRehq]hr]ht]uhhjHhb]rShXsessionrTrU}rV(hgUhhjNubahkjubaubhX, rWrX}rY(hgX, hhjBubj)rZ}r[(hgX:class:`id`r\hhjBhijhkjhm}r](UreftypeXclassjjXTypes.IdentifierU refdomainXpyr^hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r_j)r`}ra(hgj\hm}rb(ho]hp]rc(jj^Xpy-classrdehq]hr]ht]uhhjZhb]rehXidrfrg}rh(hgUhhj`ubahkjubaubhX, rirj}rk(hgX, hhjBubj)rl}rm(hgX:class:`userId`rnhhjBhijhkjhm}ro(UreftypeXclassjjX Types.SubjectU refdomainXpyrphr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rqj)rr}rs(hgjnhm}rt(ho]hp]ru(jjpXpy-classrvehq]hr]ht]uhhjlhb]rwhXuserIdrxry}rz(hgUhhjrubahkjubaubhX, r{r|}r}(hgX, hhjBubj)r~}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhjBhb]rhX serialVersionrr}r(hgUhhj~ubahkjubhX) rr}r(hgX) hhjBubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjBhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjBubj)r}r(hgX:class:`Types.Identifier`rhhjBhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX*``GET /isAuthorized/{id}?action={action}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX&GET /isAuthorized/{id}?action={action}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX$:func:`CNAuthorization.isAuthorized`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNAuthorization.isAuthorizedU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNAuthorization.isAuthorized()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXr(:class:`session`, :class:`id`, :class:`action`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`id`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classr ehq]hr]ht]uhhjhb]r hXidr r }r (hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX!:class:`action`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.PermissionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXactionrr}r(hgUhhjubahkjubaubhX) r r!}r"(hgX) hhjubj)r#}r$(hgX``->``hm}r%(ho]hp]hq]hr]ht]uhhjhb]r&hX->r'r(}r)(hgUhhj#ubahkjubhX booleanr*r+}r,(hgX booleanhhjubeubahkjfubehkjubjT)r-}r.(hgUhm}r/(ho]hp]hq]hr]ht]uhhjhb]r0(jY)r1}r2(hgUhm}r3(ho]hp]hq]hr]ht]uhhj-hb]r4h)r5}r6(hgXTier 2r7hhj1hijhkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r9hXTier 2r:r;}r<(hgj7hhj5ubaubahkjfubjY)r=}r>(hgUhm}r?(ho]hp]hq]hr]ht]uhhj-hb]r@h)rA}rB(hgX1.0, 2.0rChhj=hijhkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rEhX1.0, 2.0rFrG}rH(hgjChhjAubaubahkjfubjY)rI}rJ(hgUhm}rK(ho]hp]hq]hr]ht]uhhj-hb]rLh)rM}rN(hgX``PUT /accessRules/{id}``rOhhjIhijhkhhm}rP(ho]hp]hq]hr]ht]uhvKhb]rQj)rR}rS(hgjOhm}rT(ho]hp]hq]hr]ht]uhhjMhb]rUhXPUT /accessRules/{id}rVrW}rX(hgUhhjRubahkjubaubahkjfubjY)rY}rZ(hgUhm}r[(ho]hp]hq]hr]ht]uhhj-hb]r\h)r]}r^(hgX':func:`CNAuthorization.setAccessPolicy`r_hhjYhijhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]raj)rb}rc(hgj_hhj]hijhkjhm}rd(UreftypeXfuncjjXCNAuthorization.setAccessPolicyU refdomainXpyrehr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rfj)rg}rh(hgj_hm}ri(ho]hp]rj(jjeXpy-funcrkehq]hr]ht]uhhjbhb]rlhX!CNAuthorization.setAccessPolicy()rmrn}ro(hgUhhjgubahkjubaubaubahkjfubjY)rp}rq(hgUhm}rr(ho]hp]hq]hr]ht]uhhj-hb]rsh)rt}ru(hgX(:class:`session`, :class:`id`, :class:`accessPolicy`, ``serialVersion``) ``->`` booleanhhjphijhkhhm}rv(ho]hp]hq]hr]ht]uhvKhb]rw(hX(rx}ry(hgX(hhjtubj)rz}r{(hgX:class:`session`r|hhjthijhkjhm}r}(UreftypeXclassjjX Types.SessionU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgj|hm}r(ho]hp]r(jj~Xpy-classrehq]hr]ht]uhhjzhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjtubj)r}r(hgX:class:`id`rhhjthijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjtubj)r}r(hgX):class:`accessPolicy`rhhjthijhkjhm}r(UreftypeXclassjjXTypes.AccessPolicyU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX accessPolicyrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjtubj)r}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhjthb]rhX serialVersionrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjtubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjthb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjtubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /accounts``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /accountsrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX":func:`CNIdentity.registerAccount`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.registerAccountU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.registerAccount()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgX^(:class:`session`, :class:`person`) ``->`` :class:`Types.Subject`hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhj ubj)r}r(hgX:class:`session`rhhj hijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, r r!}r"(hgX, hhj ubj)r#}r$(hgX:class:`person`r%hhj hijhkjhm}r&(UreftypeXclassjjX Types.PersonU refdomainXpyr'hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r(j)r)}r*(hgj%hm}r+(ho]hp]r,(jj'Xpy-classr-ehq]hr]ht]uhhj#hb]r.hXpersonr/r0}r1(hgUhhj)ubahkjubaubhX) r2r3}r4(hgX) hhj ubj)r5}r6(hgX``->``hm}r7(ho]hp]hq]hr]ht]uhhj hb]r8hX->r9r:}r;(hgUhhj5ubahkjubhX r<}r=(hgX hhj ubj)r>}r?(hgX:class:`Types.Subject`r@hhj hijhkjhm}rA(UreftypeXclassjjX Types.SubjectU refdomainXpyrBhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rCj)rD}rE(hgj@hm}rF(ho]hp]rG(jjBXpy-classrHehq]hr]ht]uhhj>hb]rIhX Types.SubjectrJrK}rL(hgUhhjDubahkjubaubeubahkjfubehkjubjT)rM}rN(hgUhm}rO(ho]hp]hq]hr]ht]uhhjhb]rP(jY)rQ}rR(hgUhm}rS(ho]hp]hq]hr]ht]uhhjMhb]rTh)rU}rV(hgXTier 2rWhhjQhijhkhhm}rX(ho]hp]hq]hr]ht]uhvKhb]rYhXTier 2rZr[}r\(hgjWhhjUubaubahkjfubjY)r]}r^(hgUhm}r_(ho]hp]hq]hr]ht]uhhjMhb]r`h)ra}rb(hgX 1.0, (2.0)rchhj]hijhkhhm}rd(ho]hp]hq]hr]ht]uhvKhb]rehX 1.0, (2.0)rfrg}rh(hgjchhjaubaubahkjfubjY)ri}rj(hgUhm}rk(ho]hp]hq]hr]ht]uhhjMhb]rlh)rm}rn(hgX``PUT /accounts/{subject}``rohhjihijhkhhm}rp(ho]hp]hq]hr]ht]uhvKhb]rqj)rr}rs(hgjohm}rt(ho]hp]hq]hr]ht]uhhjmhb]ruhXPUT /accounts/{subject}rvrw}rx(hgUhhjrubahkjubaubahkjfubjY)ry}rz(hgUhm}r{(ho]hp]hq]hr]ht]uhhjMhb]r|h)r}}r~(hgX :func:`CNIdentity.updateAccount`rhhjyhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhj}hijhkjhm}r(UreftypeXfuncjjXCNIdentity.updateAccountU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.updateAccount()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjMhb]rh)r}r(hgX(:class:`session`, :class:`subject`, :class:`person`) ``->`` :class:`Types.Subject`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`person`rhhjhijhkjhm}r(UreftypeXclassjjX Types.PersonU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpersonrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.Subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r (hgX(``PUT /accounts/verification/{subject}``r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r }r(hgj hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX$PUT /accounts/verification/{subject}rr}r(hgUhhj ubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX :func:`CNIdentity.verifyAccount`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.verifyAccountU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r!j)r"}r#(hgjhm}r$(ho]hp]r%(jj Xpy-funcr&ehq]hr]ht]uhhjhb]r'hXCNIdentity.verifyAccount()r(r)}r*(hgUhhj"ubahkjubaubaubahkjfubjY)r+}r,(hgUhm}r-(ho]hp]hq]hr]ht]uhhjhb]r.h)r/}r0(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhj+hijhkhhm}r1(ho]hp]hq]hr]ht]uhvKhb]r2(hX(r3}r4(hgX(hhj/ubj)r5}r6(hgX:class:`session`r7hhj/hijhkjhm}r8(UreftypeXclassjjX Types.SessionU refdomainXpyr9hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r:j)r;}r<(hgj7hm}r=(ho]hp]r>(jj9Xpy-classr?ehq]hr]ht]uhhj5hb]r@hXsessionrArB}rC(hgUhhj;ubahkjubaubhX, rDrE}rF(hgX, hhj/ubj)rG}rH(hgX:class:`subject`rIhhj/hijhkjhm}rJ(UreftypeXclassjjX Types.SubjectU refdomainXpyrKhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rLj)rM}rN(hgjIhm}rO(ho]hp]rP(jjKXpy-classrQehq]hr]ht]uhhjGhb]rRhXsubjectrSrT}rU(hgUhhjMubahkjubaubhX) rVrW}rX(hgX) hhj/ubj)rY}rZ(hgX``->``hm}r[(ho]hp]hq]hr]ht]uhhj/hb]r\hX->r]r^}r_(hgUhhjYubahkjubhX booleanr`ra}rb(hgX booleanhhj/ubeubahkjfubehkjubjT)rc}rd(hgUhm}re(ho]hp]hq]hr]ht]uhhjhb]rf(jY)rg}rh(hgUhm}ri(ho]hp]hq]hr]ht]uhhjchb]rjh)rk}rl(hgXTier 2rmhhjghijhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rohXTier 2rprq}rr(hgjmhhjkubaubahkjfubjY)rs}rt(hgUhm}ru(ho]hp]hq]hr]ht]uhhjchb]rvh)rw}rx(hgX 1.0, (2.0)ryhhjshijhkhhm}rz(ho]hp]hq]hr]ht]uhvKhb]r{hX 1.0, (2.0)r|r}}r~(hgjyhhjwubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjchb]rh)r}r(hgX``GET /accounts/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /accounts/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjchb]rh)r}r(hgX!:func:`CNIdentity.getSubjectInfo`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.getSubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.getSubjectInfo()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjchb]rh)r}r(hgXd(:class:`session`, :class:`subject`) ``->`` :class:`Types.SubjectInfo`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.SubjectInfo`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.SubjectInforr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgXM``GET /accounts?query={query}[&status={status}&start={start}&count={count}]``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhj hb]rhXIGET /accounts?query={query}[&status={status}&start={start}&count={count}]rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNIdentity.listSubjects`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r j)r!}r"(hgjhhjhijhkjhm}r#(UreftypeXfuncjjXCNIdentity.listSubjectsU refdomainXpyr$hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r%j)r&}r'(hgjhm}r((ho]hp]r)(jj$Xpy-funcr*ehq]hr]ht]uhhj!hb]r+hXCNIdentity.listSubjects()r,r-}r.(hgUhhj&ubahkjubaubaubahkjfubjY)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhjhb]r2h)r3}r4(hgXp(:class:`session`, ``query``, ``status``, ``start``, ``count``) ``->`` :class:`Types.SubjectInfo`hhj/hijhkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r6(hX(r7}r8(hgX(hhj3ubj)r9}r:(hgX:class:`session`r;hhj3hijhkjhm}r<(UreftypeXclassjjX Types.SessionU refdomainXpyr=hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r>j)r?}r@(hgj;hm}rA(ho]hp]rB(jj=Xpy-classrCehq]hr]ht]uhhj9hb]rDhXsessionrErF}rG(hgUhhj?ubahkjubaubhX, rHrI}rJ(hgX, hhj3ubj)rK}rL(hgX ``query``hm}rM(ho]hp]hq]hr]ht]uhhj3hb]rNhXqueryrOrP}rQ(hgUhhjKubahkjubhX, rRrS}rT(hgX, hhj3ubj)rU}rV(hgX ``status``hm}rW(ho]hp]hq]hr]ht]uhhj3hb]rXhXstatusrYrZ}r[(hgUhhjUubahkjubhX, r\r]}r^(hgX, hhj3ubj)r_}r`(hgX ``start``hm}ra(ho]hp]hq]hr]ht]uhhj3hb]rbhXstartrcrd}re(hgUhhj_ubahkjubhX, rfrg}rh(hgX, hhj3ubj)ri}rj(hgX ``count``hm}rk(ho]hp]hq]hr]ht]uhhj3hb]rlhXcountrmrn}ro(hgUhhjiubahkjubhX) rprq}rr(hgX) hhj3ubj)rs}rt(hgX``->``hm}ru(ho]hp]hq]hr]ht]uhhj3hb]rvhX->rwrx}ry(hgUhhjsubahkjubhX rz}r{(hgX hhj3ubj)r|}r}(hgX:class:`Types.SubjectInfo`r~hhj3hijhkjhm}r(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgj~hm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhj|hb]rhXTypes.SubjectInforr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /accounts/map``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /accounts/maprr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNIdentity.mapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.mapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.mapIdentity()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`primarySubject`, :class:`secondarySubject`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX&:class:`primarySubject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXprimarySubjectrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX(:class:`secondarySubject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsecondarySubjectrr }r (hgUhhjubahkjubaubhX) r r }r (hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r!(hgXTier 2r"hhjhijhkhhm}r#(ho]hp]hq]hr]ht]uhvKhb]r$hXTier 2r%r&}r'(hgj"hhj ubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX 1.0, (2.0)r.hhj(hijhkhhm}r/(ho]hp]hq]hr]ht]uhvKhb]r0hX 1.0, (2.0)r1r2}r3(hgj.hhj,ubaubahkjfubjY)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7h)r8}r9(hgX"``DELETE /accounts/map/{subject}``r:hhj4hijhkhhm}r;(ho]hp]hq]hr]ht]uhvKhb]r<j)r=}r>(hgj:hm}r?(ho]hp]hq]hr]ht]uhhj8hb]r@hXDELETE /accounts/map/{subject}rArB}rC(hgUhhj=ubahkjubaubahkjfubjY)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhjhb]rGh)rH}rI(hgX$:func:`CNIdentity.removeMapIdentity`rJhhjDhijhkhhm}rK(ho]hp]hq]hr]ht]uhvKhb]rLj)rM}rN(hgjJhhjHhijhkjhm}rO(UreftypeXfuncjjXCNIdentity.removeMapIdentityU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rQj)rR}rS(hgjJhm}rT(ho]hp]rU(jjPXpy-funcrVehq]hr]ht]uhhjMhb]rWhXCNIdentity.removeMapIdentity()rXrY}rZ(hgUhhjRubahkjubaubaubahkjfubjY)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjhb]r^h)r_}r`(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhj[hijhkhhm}ra(ho]hp]hq]hr]ht]uhvKhb]rb(hX(rc}rd(hgX(hhj_ubj)re}rf(hgX:class:`session`rghhj_hijhkjhm}rh(UreftypeXclassjjX Types.SessionU refdomainXpyrihr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rjj)rk}rl(hgjghm}rm(ho]hp]rn(jjiXpy-classroehq]hr]ht]uhhjehb]rphXsessionrqrr}rs(hgUhhjkubahkjubaubhX, rtru}rv(hgX, hhj_ubj)rw}rx(hgX:class:`subject`ryhhj_hijhkjhm}rz(UreftypeXclassjjX Types.SubjectU refdomainXpyr{hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r|j)r}}r~(hgjyhm}r(ho]hp]r(jj{Xpy-classrehq]hr]ht]uhhjwhb]rhXsubjectrr}r(hgUhhj}ubahkjubaubhX) rr}r(hgX) hhj_ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj_hb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhj_ubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /accounts/pendingmap``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /accounts/pendingmaprr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX%:func:`CNIdentity.requestMapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.requestMapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.requestMapIdentity()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr }r (hgUhhjubahkjubhX booleanr r }r (hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r!h)r"}r#(hgX 1.0, (2.0)r$hhjhijhkhhm}r%(ho]hp]hq]hr]ht]uhvKhb]r&hX 1.0, (2.0)r'r(}r)(hgj$hhj"ubaubahkjfubjY)r*}r+(hgUhm}r,(ho]hp]hq]hr]ht]uhhjhb]r-h)r.}r/(hgX&``PUT /accounts/pendingmap/{subject}``r0hhj*hijhkhhm}r1(ho]hp]hq]hr]ht]uhvKhb]r2j)r3}r4(hgj0hm}r5(ho]hp]hq]hr]ht]uhhj.hb]r6hX"PUT /accounts/pendingmap/{subject}r7r8}r9(hgUhhj3ubahkjubaubahkjfubjY)r:}r;(hgUhm}r<(ho]hp]hq]hr]ht]uhhjhb]r=h)r>}r?(hgX%:func:`CNIdentity.confirmMapIdentity`r@hhj:hijhkhhm}rA(ho]hp]hq]hr]ht]uhvKhb]rBj)rC}rD(hgj@hhj>hijhkjhm}rE(UreftypeXfuncjjXCNIdentity.confirmMapIdentityU refdomainXpyrFhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rGj)rH}rI(hgj@hm}rJ(ho]hp]rK(jjFXpy-funcrLehq]hr]ht]uhhjChb]rMhXCNIdentity.confirmMapIdentity()rNrO}rP(hgUhhjHubahkjubaubaubahkjfubjY)rQ}rR(hgUhm}rS(ho]hp]hq]hr]ht]uhhjhb]rTh)rU}rV(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjQhijhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rX(hX(rY}rZ(hgX(hhjUubj)r[}r\(hgX:class:`session`r]hhjUhijhkjhm}r^(UreftypeXclassjjX Types.SessionU refdomainXpyr_hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r`j)ra}rb(hgj]hm}rc(ho]hp]rd(jj_Xpy-classreehq]hr]ht]uhhj[hb]rfhXsessionrgrh}ri(hgUhhjaubahkjubaubhX, rjrk}rl(hgX, hhjUubj)rm}rn(hgX:class:`subject`rohhjUhijhkjhm}rp(UreftypeXclassjjX Types.SubjectU refdomainXpyrqhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rrj)rs}rt(hgjohm}ru(ho]hp]rv(jjqXpy-classrwehq]hr]ht]uhhjmhb]rxhXsubjectryrz}r{(hgUhhjsubahkjubaubhX) r|r}}r~(hgX) hhjUubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjUhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjUubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX&``GET /accounts/pendingmap/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX"GET /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:func:`CNIdentity.getPendingMapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX CNIdentity.getPendingMapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX"CNIdentity.getPendingMapIdentity()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXd(:class:`session`, :class:`subject`) ``->`` :class:`Types.SubjectInfo`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.SubjectInfo`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r }r (hgjhm}r (ho]hp]r (jjXpy-classr ehq]hr]ht]uhhjhb]rhXTypes.SubjectInforr}r(hgUhhj ubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr }r!(hgjhhjubaubahkjfubjY)r"}r#(hgUhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%h)r&}r'(hgX 1.0, (2.0)r(hhj"hijhkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r*hX 1.0, (2.0)r+r,}r-(hgj(hhj&ubaubahkjfubjY)r.}r/(hgUhm}r0(ho]hp]hq]hr]ht]uhhjhb]r1h)r2}r3(hgX)``DELETE /accounts/pendingmap/{subject}``r4hhj.hijhkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r6j)r7}r8(hgj4hm}r9(ho]hp]hq]hr]ht]uhhj2hb]r:hX%DELETE /accounts/pendingmap/{subject}r;r<}r=(hgUhhj7ubahkjubaubahkjfubjY)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhjhb]rAh)rB}rC(hgX":func:`CNIdentity.denyMapIdentity`rDhhj>hijhkhhm}rE(ho]hp]hq]hr]ht]uhvKhb]rFj)rG}rH(hgjDhhjBhijhkjhm}rI(UreftypeXfuncjjXCNIdentity.denyMapIdentityU refdomainXpyrJhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rKj)rL}rM(hgjDhm}rN(ho]hp]rO(jjJXpy-funcrPehq]hr]ht]uhhjGhb]rQhXCNIdentity.denyMapIdentity()rRrS}rT(hgUhhjLubahkjubaubaubahkjfubjY)rU}rV(hgUhm}rW(ho]hp]hq]hr]ht]uhhjhb]rXh)rY}rZ(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjUhijhkhhm}r[(ho]hp]hq]hr]ht]uhvKhb]r\(hX(r]}r^(hgX(hhjYubj)r_}r`(hgX:class:`session`rahhjYhijhkjhm}rb(UreftypeXclassjjX Types.SessionU refdomainXpyrchr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rdj)re}rf(hgjahm}rg(ho]hp]rh(jjcXpy-classriehq]hr]ht]uhhj_hb]rjhXsessionrkrl}rm(hgUhhjeubahkjubaubhX, rnro}rp(hgX, hhjYubj)rq}rr(hgX:class:`subject`rshhjYhijhkjhm}rt(UreftypeXclassjjX Types.SubjectU refdomainXpyruhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rvj)rw}rx(hgjshm}ry(ho]hp]rz(jjuXpy-classr{ehq]hr]ht]uhhjqhb]r|hXsubjectr}r~}r(hgUhhjwubahkjubaubhX) rr}r(hgX) hhjYubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjYhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjYubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /groups``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX POST /groupsrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNIdentity.createGroup`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNIdentity.createGroupU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNIdentity.createGroup()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX\(:class:`session`, :class:`group`) ``->`` :class:`Types.Subject`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`group`rhhjhijhkjhm}r(UreftypeXclassjjX Types.GroupU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXgrouprr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.Subject`r hhjhijhkjhm}r (UreftypeXclassjjX Types.SubjectU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r j)r }r(hgj hm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhj ubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2r hhjhijhkhhm}r!(ho]hp]hq]hr]ht]uhvKhb]r"hXTier 2r#r$}r%(hgj hhjubaubahkjfubjY)r&}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhjhb]r)h)r*}r+(hgX 1.0, (2.0)r,hhj&hijhkhhm}r-(ho]hp]hq]hr]ht]uhvKhb]r.hX 1.0, (2.0)r/r0}r1(hgj,hhj*ubaubahkjfubjY)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhjhb]r5h)r6}r7(hgX``PUT /groups``r8hhj2hijhkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r:j)r;}r<(hgj8hm}r=(ho]hp]hq]hr]ht]uhhj6hb]r>hX PUT /groupsr?r@}rA(hgUhhj;ubahkjubaubahkjfubjY)rB}rC(hgUhm}rD(ho]hp]hq]hr]ht]uhhjhb]rEh)rF}rG(hgX:func:`CNIdentity.updateGroup`rHhhjBhijhkhhm}rI(ho]hp]hq]hr]ht]uhvKhb]rJj)rK}rL(hgjHhhjFhijhkjhm}rM(UreftypeXfuncjjXCNIdentity.updateGroupU refdomainXpyrNhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rOj)rP}rQ(hgjHhm}rR(ho]hp]rS(jjNXpy-funcrTehq]hr]ht]uhhjKhb]rUhXCNIdentity.updateGroup()rVrW}rX(hgUhhjPubahkjubaubaubahkjfubjY)rY}rZ(hgUhm}r[(ho]hp]hq]hr]ht]uhhjhb]r\h)r]}r^(hgXM(:class:`session`, :class:`group`) ``->`` booleanhhjYhijhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r`(hX(ra}rb(hgX(hhj]ubj)rc}rd(hgX:class:`session`rehhj]hijhkjhm}rf(UreftypeXclassjjX Types.SessionU refdomainXpyrghr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rhj)ri}rj(hgjehm}rk(ho]hp]rl(jjgXpy-classrmehq]hr]ht]uhhjchb]rnhXsessionrorp}rq(hgUhhjiubahkjubaubhX, rrrs}rt(hgX, hhj]ubj)ru}rv(hgX:class:`group`rwhhj]hijhkjhm}rx(UreftypeXclassjjX Types.GroupU refdomainXpyryhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rzj)r{}r|(hgjwhm}r}(ho]hp]r~(jjyXpy-classrehq]hr]ht]uhhjuhb]rhXgrouprr}r(hgUhhj{ubahkjubaubhX) rr}r(hgX) hhj]ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj]hb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhj]ubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 4rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 4rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX#``PUT /replicaNotifications/{pid}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /replicaNotifications/{pid}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX*:func:`CNReplication.setReplicationStatus`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX"CNReplication.setReplicationStatusU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX$CNReplication.setReplicationStatus()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`pid`, :class:`nodeRef`, :class:`status`, :class:`failure`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX%:class:`nodeRef`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r (hgjhm}r (ho]hp]r (jjXpy-classr ehq]hr]ht]uhhjhb]r hXnodeRefrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX(:class:`status`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.ReplicationStatusU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXstatusr r!}r"(hgUhhjubahkjubaubhX, r#r$}r%(hgX, hhjubj)r&}r'(hgX%:class:`failure`r(hhjhijhkjhm}r)(UreftypeXclassjjXTypes.BaseExceptionU refdomainXpyr*hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r+j)r,}r-(hgj(hm}r.(ho]hp]r/(jj*Xpy-classr0ehq]hr]ht]uhhj&hb]r1hXfailurer2r3}r4(hgUhhj,ubahkjubaubhX) r5r6}r7(hgX) hhjubj)r8}r9(hgX``->``hm}r:(ho]hp]hq]hr]ht]uhhjhb]r;hX->r<r=}r>(hgUhhj8ubahkjubhX booleanr?r@}rA(hgX booleanhhjubeubahkjfubehkjubjT)rB}rC(hgUhm}rD(ho]hp]hq]hr]ht]uhhjhb]rE(jY)rF}rG(hgUhm}rH(ho]hp]hq]hr]ht]uhhjBhb]rIh)rJ}rK(hgXTier 4rLhhjFhijhkhhm}rM(ho]hp]hq]hr]ht]uhvKhb]rNhXTier 4rOrP}rQ(hgjLhhjJubaubahkjfubjY)rR}rS(hgUhm}rT(ho]hp]hq]hr]ht]uhhjBhb]rUh)rV}rW(hgX 1.0, (2.0)rXhhjRhijhkhhm}rY(ho]hp]hq]hr]ht]uhvKhb]rZhX 1.0, (2.0)r[r\}r](hgjXhhjVubaubahkjfubjY)r^}r_(hgUhm}r`(ho]hp]hq]hr]ht]uhhjBhb]rah)rb}rc(hgX``PUT /replicaMetadata/{pid}``rdhhj^hijhkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rfj)rg}rh(hgjdhm}ri(ho]hp]hq]hr]ht]uhhjbhb]rjhXPUT /replicaMetadata/{pid}rkrl}rm(hgUhhjgubahkjubaubahkjfubjY)rn}ro(hgUhm}rp(ho]hp]hq]hr]ht]uhhjBhb]rqh)rr}rs(hgX/:func:`CNReplication.updateReplicationMetadata`rthhjnhijhkhhm}ru(ho]hp]hq]hr]ht]uhvKhb]rvj)rw}rx(hgjthhjrhijhkjhm}ry(UreftypeXfuncjjX'CNReplication.updateReplicationMetadataU refdomainXpyrzhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r{j)r|}r}(hgjthm}r~(ho]hp]r(jjzXpy-funcrehq]hr]ht]uhhjwhb]rhX)CNReplication.updateReplicationMetadata()rr}r(hgUhhj|ubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjBhb]rh)r}r(hgX(:class:`session`, :class:`pid`, :class:`replicaMetadata`, ``serialVersion``) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX':class:`replicaMetadata`rhhjhijhkjhm}r(UreftypeXclassjjX Types.ReplicaU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXreplicaMetadatarr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 4rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 4rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /replicaPolicies/{id}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /replicaPolicies/{id}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r (hgX*:func:`CNReplication.setReplicationPolicy`r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r}r(hgj hhj hijhkjhm}r(UreftypeXfuncjjX"CNReplication.setReplicationPolicyU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgj hm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX$CNReplication.setReplicationPolicy()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r!(hgX(:class:`session`, :class:`id`, :class:`policy`, ``serialVersion``) ``->`` booleanhhjhijhkhhm}r"(ho]hp]hq]hr]ht]uhvKhb]r#(hX(r$}r%(hgX(hhj ubj)r&}r'(hgX:class:`session`r(hhj hijhkjhm}r)(UreftypeXclassjjX Types.SessionU refdomainXpyr*hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r+j)r,}r-(hgj(hm}r.(ho]hp]r/(jj*Xpy-classr0ehq]hr]ht]uhhj&hb]r1hXsessionr2r3}r4(hgUhhj,ubahkjubaubhX, r5r6}r7(hgX, hhj ubj)r8}r9(hgX:class:`id`r:hhj hijhkjhm}r;(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr<hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r=j)r>}r?(hgj:hm}r@(ho]hp]rA(jj<Xpy-classrBehq]hr]ht]uhhj8hb]rChXidrDrE}rF(hgUhhj>ubahkjubaubhX, rGrH}rI(hgX, hhj ubj)rJ}rK(hgX(:class:`policy`rLhhj hijhkjhm}rM(UreftypeXclassjjXTypes.ReplicationPolicyU refdomainXpyrNhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rOj)rP}rQ(hgjLhm}rR(ho]hp]rS(jjNXpy-classrTehq]hr]ht]uhhjJhb]rUhXpolicyrVrW}rX(hgUhhjPubahkjubaubhX, rYrZ}r[(hgX, hhj ubj)r\}r](hgX``serialVersion``hm}r^(ho]hp]hq]hr]ht]uhhj hb]r_hX serialVersionr`ra}rb(hgUhhj\ubahkjubhX) rcrd}re(hgX) hhj ubj)rf}rg(hgX``->``hm}rh(ho]hp]hq]hr]ht]uhhj hb]rihX->rjrk}rl(hgUhhjfubahkjubhX booleanrmrn}ro(hgX booleanhhj ubeubahkjfubehkjubjT)rp}rq(hgUhm}rr(ho]hp]hq]hr]ht]uhhjhb]rs(jY)rt}ru(hgUhm}rv(ho]hp]hq]hr]ht]uhhjphb]rwh)rx}ry(hgXTier 4rzhhjthijhkhhm}r{(ho]hp]hq]hr]ht]uhvKhb]r|hXTier 4r}r~}r(hgjzhhjxubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgXJ``GET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXFGET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgX&:func:`CNReplication.isNodeAuthorized`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNReplication.isNodeAuthorizedU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX CNReplication.isNodeAuthorized()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgX{(:class:`session`, :class:`targetNodeSubject`, :class:`pid`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX):class:`targetNodeSubject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXtargetNodeSubjectrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]hkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r (hgX 1.0, (2.0)r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX 1.0, (2.0)r r}r(hgj hhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX$``PUT /removeReplicaMetadata/{pid}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX PUT /removeReplicaMetadata/{pid}rr}r(hgUhhjubahkjubaubahkjfubjY)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#h)r$}r%(hgX/:func:`CNReplication.deleteReplicationMetadata`r&hhj hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r(j)r)}r*(hgj&hhj$hijhkjhm}r+(UreftypeXfuncjjX'CNReplication.deleteReplicationMetadataU refdomainXpyr,hr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]r-j)r.}r/(hgj&hm}r0(ho]hp]r1(jj,Xpy-funcr2ehq]hr]ht]uhhj)hb]r3hX)CNReplication.deleteReplicationMetadata()r4r5}r6(hgUhhj.ubahkjubaubaubahkjfubjY)r7}r8(hgUhm}r9(ho]hp]hq]hr]ht]uhhjhb]r:h)r;}r<(hgX(:class:`session`, :class:`pid`, :class:`nodeId`, ``serialVersion``) ``->`` booleanhhj7hijhkhhm}r=(ho]hp]hq]hr]ht]uhvKhb]r>(hX(r?}r@(hgX(hhj;ubj)rA}rB(hgX:class:`session`rChhj;hijhkjhm}rD(UreftypeXclassjjX Types.SessionU refdomainXpyrEhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rFj)rG}rH(hgjChm}rI(ho]hp]rJ(jjEXpy-classrKehq]hr]ht]uhhjAhb]rLhXsessionrMrN}rO(hgUhhjGubahkjubaubhX, rPrQ}rR(hgX, hhj;ubj)rS}rT(hgX:class:`pid`rUhhj;hijhkjhm}rV(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rXj)rY}rZ(hgjUhm}r[(ho]hp]r\(jjWXpy-classr]ehq]hr]ht]uhhjShb]r^hXpidr_r`}ra(hgUhhjYubahkjubaubhX, rbrc}rd(hgX, hhj;ubj)re}rf(hgX$:class:`nodeId`rghhj;hijhkjhm}rh(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrihr]hq]U refexplicitho]hp]ht]jjjNjNuhvKhb]rjj)rk}rl(hgjghm}rm(ho]hp]rn(jjiXpy-classroehq]hr]ht]uhhjehb]rphXnodeIdrqrr}rs(hgUhhjkubahkjubaubhX, rtru}rv(hgX, hhj;ubj)rw}rx(hgX``serialVersion``hm}ry(ho]hp]hq]hr]ht]uhhj;hb]rzhX serialVersionr{r|}r}(hgUhhjwubahkjubhX) r~r}r(hgX) hhj;ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj;hb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhj;ubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /node/{nodeid}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /node/{nodeid}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX):func:`CNRegister.updateNodeCapabilities`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX!CNRegister.updateNodeCapabilitiesU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX#CNRegister.updateNodeCapabilities()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXq(:class:`session`, :class:`nodeid`, :class:`node`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX$:class:`nodeid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnodeidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnoderr }r (hgUhhjubahkjubaubhX) r r }r (hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r!(hgXTier 2r"hhjhijhkhhm}r#(ho]hp]hq]hr]ht]uhvMhb]r$hXTier 2r%r&}r'(hgj"hhj ubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX1.0, 2.0r.hhj(hijhkhhm}r/(ho]hp]hq]hr]ht]uhvMhb]r0hX1.0, 2.0r1r2}r3(hgj.hhj,ubaubahkjfubjY)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7h)r8}r9(hgX``GET /node/{nodeid}``r:hhj4hijhkhhm}r;(ho]hp]hq]hr]ht]uhvMhb]r<j)r=}r>(hgj:hm}r?(ho]hp]hq]hr]ht]uhhj8hb]r@hXGET /node/{nodeid}rArB}rC(hgUhhj=ubahkjubaubahkjfubjY)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhjhb]rGh)rH}rI(hgX&:func:`CNRegister.getNodeCapabilities`rJhhjDhijhkhhm}rK(ho]hp]hq]hr]ht]uhvMhb]rLj)rM}rN(hgjJhhjHhijhkjhm}rO(UreftypeXfuncjjXCNRegister.getNodeCapabilitiesU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rQj)rR}rS(hgjJhm}rT(ho]hp]rU(jjPXpy-funcrVehq]hr]ht]uhhjMhb]rWhX CNRegister.getNodeCapabilities()rXrY}rZ(hgUhhjRubahkjubaubaubahkjfubjY)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjhb]r^h)r_}r`(hgXA(:class:`nodeid`) ``->`` :class:`Types.Node`hhj[hijhkhhm}ra(ho]hp]hq]hr]ht]uhvMhb]rb(hX(rc}rd(hgX(hhj_ubj)re}rf(hgX$:class:`nodeid`rghhj_hijhkjhm}rh(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrihr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rjj)rk}rl(hgjghm}rm(ho]hp]rn(jjiXpy-classroehq]hr]ht]uhhjehb]rphXnodeidrqrr}rs(hgUhhjkubahkjubaubhX) rtru}rv(hgX) hhj_ubj)rw}rx(hgX``->``hm}ry(ho]hp]hq]hr]ht]uhhj_hb]rzhX->r{r|}r}(hgUhhjwubahkjubhX r~}r(hgX hhj_ubj)r}r(hgX:class:`Types.Node`rhhj_hijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Noderr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /node``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX POST /noderr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNRegister.register`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNRegister.registerU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNRegister.register()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX`(:class:`session`, :class:`node`) ``->`` :class:`Types.NodeReference`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnoderr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r }r (hgX:class:`Types.NodeReference`r hhjhijhkjhm}r (UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjNuhvM hb]rj)r}r(hgj hm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhj hb]rhXTypes.NodeReferencerr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r!(hgXTier 1r"hhjhijhkhhm}r#(ho]hp]hq]hr]ht]uhvMhb]r$hXTier 1r%r&}r'(hgj"hhj ubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX2.0r.hhj(hijhkhhm}r/(ho]hp]hq]hr]ht]uhvMhb]r0hX2.0r1r2}r3(hgj.hhj,ubaubahkjfubjY)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7h)r8}r9(hgX``GET /views/{theme}/{id}``r:hhj4hijhkhhm}r;(ho]hp]hq]hr]ht]uhvMhb]r<j)r=}r>(hgj:hm}r?(ho]hp]hq]hr]ht]uhhj8hb]r@hXGET /views/{theme}/{id}rArB}rC(hgUhhj=ubahkjubaubahkjfubjY)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhjhb]rGh)rH}rI(hgX:func:`CNView.view`rJhhjDhijhkhhm}rK(ho]hp]hq]hr]ht]uhvMhb]rLj)rM}rN(hgjJhhjHhijhkjhm}rO(UreftypeXfuncjjX CNView.viewU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rQj)rR}rS(hgjJhm}rT(ho]hp]rU(jjPXpy-funcrVehq]hr]ht]uhhjMhb]rWhX CNView.view()rXrY}rZ(hgUhhjRubahkjubaubaubahkjfubjY)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjhb]r^h)r_}r`(hgXm(:class:`session`, ``theme``, :class:`id`) ``->`` :class:`Types.OctetStream`hhj[hijhkhhm}ra(ho]hp]hq]hr]ht]uhvMhb]rb(hX(rc}rd(hgX(hhj_ubj)re}rf(hgX:class:`session`rghhj_hijhkjhm}rh(UreftypeXclassjjX Types.SessionU refdomainXpyrihr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rjj)rk}rl(hgjghm}rm(ho]hp]rn(jjiXpy-classroehq]hr]ht]uhhjehb]rphXsessionrqrr}rs(hgUhhjkubahkjubaubhX, rtru}rv(hgX, hhj_ubj)rw}rx(hgX ``theme``hm}ry(ho]hp]hq]hr]ht]uhhj_hb]rzhXthemer{r|}r}(hgUhhjwubahkjubhX, r~r}r(hgX, hhj_ubj)r}r(hgX:class:`id`rhhj_hijhkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhj_ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj_hb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhj_ubj)r}r(hgX:class:`Types.OctetStream`rhhj_hijhkjhm}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.OctetStreamrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``GET /views``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX GET /viewsrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`CNView.listViews`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNView.listViewsU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXCNView.listViews()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXB(:class:`session`) ``->`` :class:`Types.OptionList`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX) rr}r (hgX) hhjubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX->rr}r(hgUhhj ubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.OptionList`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.OptionListU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.OptionListrr }r!(hgUhhjubahkjubaubeubahkjfubehkjubjT)r"}r#(hgUhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%(jY)r&}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhj"hb]r)h)r*}r+(hgXTier 2r,hhj&hijhkhhm}r-(ho]hp]hq]hr]ht]uhvMhb]r.hXTier 2r/r0}r1(hgj,hhj*ubaubahkjfubjY)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhj"hb]r5h)r6}r7(hgX2.0r8hhj2hijhkhhm}r9(ho]hp]hq]hr]ht]uhvMhb]r:hX2.0r;r<}r=(hgj8hhj6ubaubahkjfubjY)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhj"hb]rAh)rB}rC(hgX``GET /diag/subject``rDhhj>hijhkhhm}rE(ho]hp]hq]hr]ht]uhvMhb]rFj)rG}rH(hgjDhm}rI(ho]hp]hq]hr]ht]uhhjBhb]rJhXGET /diag/subjectrKrL}rM(hgUhhjGubahkjubaubahkjfubjY)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhj"hb]rQh)rR}rS(hgX$:func:`CNDiagnostic.echoCredentials`rThhjNhijhkhhm}rU(ho]hp]hq]hr]ht]uhvMhb]rVj)rW}rX(hgjThhjRhijhkjhm}rY(UreftypeXfuncjjXCNDiagnostic.echoCredentialsU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]r[j)r\}r](hgjThm}r^(ho]hp]r_(jjZXpy-funcr`ehq]hr]ht]uhhjWhb]rahXCNDiagnostic.echoCredentials()rbrc}rd(hgUhhj\ubahkjubaubaubahkjfubjY)re}rf(hgUhm}rg(ho]hp]hq]hr]ht]uhhj"hb]rhh)ri}rj(hgXC(:class:`session`) ``->`` :class:`Types.SubjectInfo`hhjehijhkhhm}rk(ho]hp]hq]hr]ht]uhvMhb]rl(hX(rm}rn(hgX(hhjiubj)ro}rp(hgX:class:`session`rqhhjihijhkjhm}rr(UreftypeXclassjjX Types.SessionU refdomainXpyrshr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rtj)ru}rv(hgjqhm}rw(ho]hp]rx(jjsXpy-classryehq]hr]ht]uhhjohb]rzhXsessionr{r|}r}(hgUhhjuubahkjubaubhX) r~r}r(hgX) hhjiubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjihb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjiubj)r}r(hgX:class:`Types.SubjectInfo`rhhjihijhkjhm}r(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.SubjectInforr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 1rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXTier 1rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX2.0rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /diag/sysmeta``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /diag/sysmetarr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX':func:`CNDiagnostic.echoSystemMetadata`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXCNDiagnostic.echoSystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhX!CNDiagnostic.echoSystemMetadata()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXn(:class:`session`, :class:`sysmeta`) ``->`` :class:`Types.SystemMetadata`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM!hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM!hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX&:class:`sysmeta`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM!hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsysmetarr}r(hgUhhjubahkjubaubhX) rr}r (hgX) hhjubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX->rr}r(hgUhhj ubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.SystemMetadata`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM!hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.SystemMetadatarr }r!(hgUhhjubahkjubaubeubahkjfubehkjubjT)r"}r#(hgUhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%(jY)r&}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhj"hb]r)h)r*}r+(hgXTier 1r,hhj&hijhkhhm}r-(ho]hp]hq]hr]ht]uhvM"hb]r.hXTier 1r/r0}r1(hgj,hhj*ubaubahkjfubjY)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhj"hb]r5h)r6}r7(hgX2.0r8hhj2hijhkhhm}r9(ho]hp]hq]hr]ht]uhvM#hb]r:hX2.0r;r<}r=(hgj8hhj6ubaubahkjfubjY)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhj"hb]rAh)rB}rC(hgX``POST /diag/object``rDhhj>hijhkhhm}rE(ho]hp]hq]hr]ht]uhvM$hb]rFj)rG}rH(hgjDhm}rI(ho]hp]hq]hr]ht]uhhjBhb]rJhXPOST /diag/objectrKrL}rM(hgUhhjGubahkjubaubahkjfubjY)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhj"hb]rQh)rR}rS(hgX&:func:`CNDiagnostic.echoIndexedObject`rThhjNhijhkhhm}rU(ho]hp]hq]hr]ht]uhvM%hb]rVj)rW}rX(hgjThhjRhijhkjhm}rY(UreftypeXfuncjjXCNDiagnostic.echoIndexedObjectU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM%hb]r[j)r\}r](hgjThm}r^(ho]hp]r_(jjZXpy-funcr`ehq]hr]ht]uhhjWhb]rahX CNDiagnostic.echoIndexedObject()rbrc}rd(hgUhhj\ubahkjubaubaubahkjfubjY)re}rf(hgUhm}rg(ho]hp]hq]hr]ht]uhhj"hb]rhh)ri}rj(hgX(:class:`session`, ``queryEngine``, :class:`sysmeta`, ``object``) ``->`` :class:`Types.OctetStream`hhjehijhkhhm}rk(ho]hp]hq]hr]ht]uhvM&hb]rl(hX(rm}rn(hgX(hhjiubj)ro}rp(hgX:class:`session`rqhhjihijhkjhm}rr(UreftypeXclassjjX Types.SessionU refdomainXpyrshr]hq]U refexplicitho]hp]ht]jjjNjNuhvM&hb]rtj)ru}rv(hgjqhm}rw(ho]hp]rx(jjsXpy-classryehq]hr]ht]uhhjohb]rzhXsessionr{r|}r}(hgUhhjuubahkjubaubhX, r~r}r(hgX, hhjiubj)r}r(hgX``queryEngine``hm}r(ho]hp]hq]hr]ht]uhhjihb]rhX queryEnginerr}r(hgUhhjubahkjubhX, rr}r(hgX, hhjiubj)r}r(hgX&:class:`sysmeta`rhhjihijhkjhm}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsysmetarr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjiubj)r}r(hgX ``object``hm}r(ho]hp]hq]hr]ht]uhhjihb]rhXobjectrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjiubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjihb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjiubj)r}r(hgX:class:`Types.OctetStream`rhhjihijhkjhm}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjNuhvM&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.OctetStreamrr}r(hgUhhjubahkjubaubeubahkjfubehkjubehkUtbodyrubehkUtgrouprubeubhd)r}r(hgUhhhehihjhkhlhm}r(ho]hp]hq]hr]r(Xmodule-CNDiagnosticrhZeht]rh&auhvK-hwhhb]r(hy)r}r(hgXDiagnostic APIrhhjhihjhkh}hm}r(ho]hp]hq]hr]ht]uhvK-hwhhb]rhXDiagnostic APIrr}r(hgjhhjubaubcsphinx.addnodes index r)r}r(hgUhhjhihjhkUindexrhm}r(hr]hq]ho]hp]ht]Uentries]r(UsinglerXCNDiagnostic (module)Xmodule-CNDiagnosticUNtrauhvNhwhhb]ubj)r}r(hgXBWarning: this file is automatically generated. Edits will be losthhjhijX0source/apis/generated/generated_CNDiagnostic.txtrr}rbhkj!hm}r(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]rhXBWarning: this file is automatically generated. Edits will be lostrr}r(hgUhhjubaubj))r}r(hgUhhjhiNhkj,hm}r(ho]hp]hq]hr]rUid2raht]uhvNhwhhb]r(hy)r}r(hgX(Functions defined in :mod:`CNDiagnostic`hm}r(ho]hp]hq]hr]ht]uhhjhb]r(hXFunctions defined in rr}r(hgXFunctions defined in hhjubj)r}r(hgX:mod:`CNDiagnostic`rhhjhijhkjhm}r(UreftypeXmodjjX CNDiagnosticU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjX CNDiagnosticruhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-modrehq]hr]ht]uhhjhb]rhX CNDiagnosticrr}r(hgUhhjubahkjubaubehkh}ubj9)r}r (hgUhm}r (hr]hq]ho]hp]ht]UcolsKuhhjhb]r (j>)r }r (hgUhm}r (hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubj>)r }r (hgUhm}r (hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubj>)r }r (hgUhm}r (hr]hq]ho]hp]ht]UcolwidthK uhhjhb]hkjBubj>)r }r (hgUhm}r (hr]hq]ho]hp]ht]UcolwidthK uhhjhb]hkjBubj>)r }r (hgUhm}r (hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubjO)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r jT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTierr hhj hijhkhhm}r! (ho]hp]hq]hr]ht]uhvK hb]r" hXTierr# r$ }r% (hgj hhj ubaubahkjfubjY)r& }r' (hgUhm}r( (ho]hp]hq]hr]ht]uhhj hb]r) h)r* }r+ (hgXVersionr, hhj& hijhkhhm}r- (ho]hp]hq]hr]ht]uhvK hb]r. hXVersionr/ r0 }r1 (hgj, hhj* ubaubahkjfubjY)r2 }r3 (hgUhm}r4 (ho]hp]hq]hr]ht]uhhj hb]r5 h)r6 }r7 (hgXRESTr8 hhj2 hijhkhhm}r9 (ho]hp]hq]hr]ht]uhvK hb]r: hXRESTr; r< }r= (hgj8 hhj6 ubaubahkjfubjY)r> }r? (hgUhm}r@ (ho]hp]hq]hr]ht]uhhj hb]rA h)rB }rC (hgXFunctionrD hhj> hijhkhhm}rE (ho]hp]hq]hr]ht]uhvK hb]rF hXFunctionrG rH }rI (hgjD hhjB ubaubahkjfubjY)rJ }rK (hgUhm}rL (ho]hp]hq]hr]ht]uhhj hb]rM h)rN }rO (hgX ParametersrP hhjJ hijhkhhm}rQ (ho]hp]hq]hr]ht]uhvK hb]rR hX ParametersrS rT }rU (hgjP hhjN ubaubahkjfubehkjubahkjubj)rV }rW (hgUhm}rX (ho]hp]hq]hr]ht]uhhjhb]rY (jT)rZ }r[ (hgUhm}r\ (ho]hp]hq]hr]ht]uhhjV hb]r] (jY)r^ }r_ (hgUhm}r` (ho]hp]hq]hr]ht]uhhjZ hb]ra h)rb }rc (hgXTier 2rd hhj^ hijhkhhm}re (ho]hp]hq]hr]ht]uhvKhb]rf hXTier 2rg rh }ri (hgjd hhjb ubaubahkjfubjY)rj }rk (hgUhm}rl (ho]hp]hq]hr]ht]uhhjZ hb]rm h)rn }ro (hgX2.0rp hhjj hijhkhhm}rq (ho]hp]hq]hr]ht]uhvKhb]rr hX2.0rs rt }ru (hgjp hhjn ubaubahkjfubjY)rv }rw (hgUhm}rx (ho]hp]hq]hr]ht]uhhjZ hb]ry h)rz }r{ (hgX``GET /diag/subject``r| hhjv hijhkhhm}r} (ho]hp]hq]hr]ht]uhvKhb]r~ j)r }r (hgj| hm}r (ho]hp]hq]hr]ht]uhhjz hb]r hXGET /diag/subjectr r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjZ hb]r h)r }r (hgX:func:`echoCredentials`r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r }r (hgj hhj hijhkjhm}r (UreftypeXfuncjjXechoCredentialsU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-funcr ehq]hr]ht]uhhj hb]r hXechoCredentials()r r }r (hgUhhj ubahkjubaubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjZ hb]r h)r }r (hgXC(:class:`session`) ``->`` :class:`Types.SubjectInfo`hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r (hX(r }r (hgX(hhj ubj)r }r (hgX:class:`session`r hhj hijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXsessionr r }r (hgUhhj ubahkjubaubhX) r r }r (hgX) hhj ubj)r }r (hgX``->``hm}r (ho]hp]hq]hr]ht]uhhj hb]r hX->r r }r (hgUhhj ubahkjubhX r }r (hgX hhj ubj)r }r (hgX:class:`Types.SubjectInfo`r hhj hijhkjhm}r (UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r j)r }r (hgj hm}r (ho]hp]r (jj Xpy-classr ehq]hr]ht]uhhj hb]r hXTypes.SubjectInfor r }r (hgUhhj ubahkjubaubeubahkjfubehkjubjT)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjV hb]r (jY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgXTier 1r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hXTier 1r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX2.0r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX2.0r r }r (hgj hhj ubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r h)r }r (hgX``POST /diag/sysmeta``r hhj hijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r j)r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhj hb]r hXPOST /diag/sysmetar r }r (hgUhhj ubahkjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhj hb]r!h)r!}r!(hgX:func:`echoSystemMetadata`r!hhj hijhkhhm}r!(ho]hp]hq]hr]ht]uhvKhb]r!j)r!}r!(hgj!hhj!hijhkjhm}r!(UreftypeXfuncjjXechoSystemMetadataU refdomainXpyr !hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r !j)r !}r !(hgj!hm}r !(ho]hp]r!(jj !Xpy-funcr!ehq]hr]ht]uhhj!hb]r!hXechoSystemMetadata()r!r!}r!(hgUhhj !ubahkjubaubaubahkjfubjY)r!}r!(hgUhm}r!(ho]hp]hq]hr]ht]uhhj hb]r!h)r!}r!(hgXn(:class:`session`, :class:`sysmeta`) ``->`` :class:`Types.SystemMetadata`hhj!hijhkhhm}r!(ho]hp]hq]hr]ht]uhvKhb]r!(hX(r!}r!(hgX(hhj!ubj)r!}r!(hgX:class:`session`r !hhj!hijhkjhm}r!!(UreftypeXclassjjX Types.SessionU refdomainXpyr"!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r#!j)r$!}r%!(hgj !hm}r&!(ho]hp]r'!(jj"!Xpy-classr(!ehq]hr]ht]uhhj!hb]r)!hXsessionr*!r+!}r,!(hgUhhj$!ubahkjubaubhX, r-!r.!}r/!(hgX, hhj!ubj)r0!}r1!(hgX&:class:`sysmeta`r2!hhj!hijhkjhm}r3!(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr4!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r5!j)r6!}r7!(hgj2!hm}r8!(ho]hp]r9!(jj4!Xpy-classr:!ehq]hr]ht]uhhj0!hb]r;!hXsysmetar!(hgUhhj6!ubahkjubaubhX) r?!r@!}rA!(hgX) hhj!ubj)rB!}rC!(hgX``->``hm}rD!(ho]hp]hq]hr]ht]uhhj!hb]rE!hX->rF!rG!}rH!(hgUhhjB!ubahkjubhX rI!}rJ!(hgX hhj!ubj)rK!}rL!(hgX:class:`Types.SystemMetadata`rM!hhj!hijhkjhm}rN!(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrO!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]rP!j)rQ!}rR!(hgjM!hm}rS!(ho]hp]rT!(jjO!Xpy-classrU!ehq]hr]ht]uhhjK!hb]rV!hXTypes.SystemMetadatarW!rX!}rY!(hgUhhjQ!ubahkjubaubeubahkjfubehkjubjT)rZ!}r[!(hgUhm}r\!(ho]hp]hq]hr]ht]uhhjV hb]r]!(jY)r^!}r_!(hgUhm}r`!(ho]hp]hq]hr]ht]uhhjZ!hb]ra!h)rb!}rc!(hgXTier 1rd!hhj^!hijhkhhm}re!(ho]hp]hq]hr]ht]uhvKhb]rf!hXTier 1rg!rh!}ri!(hgjd!hhjb!ubaubahkjfubjY)rj!}rk!(hgUhm}rl!(ho]hp]hq]hr]ht]uhhjZ!hb]rm!h)rn!}ro!(hgX2.0rp!hhjj!hijhkhhm}rq!(ho]hp]hq]hr]ht]uhvKhb]rr!hX2.0rs!rt!}ru!(hgjp!hhjn!ubaubahkjfubjY)rv!}rw!(hgUhm}rx!(ho]hp]hq]hr]ht]uhhjZ!hb]ry!h)rz!}r{!(hgX``POST /diag/object``r|!hhjv!hijhkhhm}r}!(ho]hp]hq]hr]ht]uhvKhb]r~!j)r!}r!(hgj|!hm}r!(ho]hp]hq]hr]ht]uhhjz!hb]r!hXPOST /diag/objectr!r!}r!(hgUhhj!ubahkjubaubahkjfubjY)r!}r!(hgUhm}r!(ho]hp]hq]hr]ht]uhhjZ!hb]r!h)r!}r!(hgX:func:`echoIndexedObject`r!hhj!hijhkhhm}r!(ho]hp]hq]hr]ht]uhvKhb]r!j)r!}r!(hgj!hhj!hijhkjhm}r!(UreftypeXfuncjjXechoIndexedObjectU refdomainXpyr!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r!j)r!}r!(hgj!hm}r!(ho]hp]r!(jj!Xpy-funcr!ehq]hr]ht]uhhj!hb]r!hXechoIndexedObject()r!r!}r!(hgUhhj!ubahkjubaubaubahkjfubjY)r!}r!(hgUhm}r!(ho]hp]hq]hr]ht]uhhjZ!hb]r!h)r!}r!(hgX(:class:`session`, ``queryEngine``, :class:`sysmeta`, ``object``) ``->`` :class:`Types.OctetStream`hhj!hijhkhhm}r!(ho]hp]hq]hr]ht]uhvKhb]r!(hX(r!}r!(hgX(hhj!ubj)r!}r!(hgX:class:`session`r!hhj!hijhkjhm}r!(UreftypeXclassjjX Types.SessionU refdomainXpyr!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r!j)r!}r!(hgj!hm}r!(ho]hp]r!(jj!Xpy-classr!ehq]hr]ht]uhhj!hb]r!hXsessionr!r!}r!(hgUhhj!ubahkjubaubhX, r!r!}r!(hgX, hhj!ubj)r!}r!(hgX``queryEngine``hm}r!(ho]hp]hq]hr]ht]uhhj!hb]r!hX queryEnginer!r!}r!(hgUhhj!ubahkjubhX, r!r!}r!(hgX, hhj!ubj)r!}r!(hgX&:class:`sysmeta`r!hhj!hijhkjhm}r!(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r!j)r!}r!(hgj!hm}r!(ho]hp]r!(jj!Xpy-classr!ehq]hr]ht]uhhj!hb]r!hXsysmetar!r!}r!(hgUhhj!ubahkjubaubhX, r!r!}r!(hgX, hhj!ubj)r!}r!(hgX ``object``hm}r!(ho]hp]hq]hr]ht]uhhj!hb]r!hXobjectr!r!}r!(hgUhhj!ubahkjubhX) r!r!}r!(hgX) hhj!ubj)r!}r!(hgX``->``hm}r!(ho]hp]hq]hr]ht]uhhj!hb]r!hX->r!r!}r!(hgUhhj!ubahkjubhX r!}r!(hgX hhj!ubj)r!}r!(hgX:class:`Types.OctetStream`r!hhj!hijhkjhm}r!(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr!hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKhb]r!j)r!}r!(hgj!hm}r!(ho]hp]r!(jj!Xpy-classr!ehq]hr]ht]uhhj!hb]r!hXTypes.OctetStreamr!r!}r!(hgUhhj!ubahkjubaubeubahkjfubehkjubehkjubehkjubeubj)r!}r!(hgUhhjhiNhkjhm}r!(hr]hq]ho]hp]ht]Uentries]r!(jX*echoCredentials() (in module CNDiagnostic)h3UNtr!auhvNhwhhb]ubcsphinx.addnodes desc r!)r!}r!(hgUhhjhiNhkUdescr!hm}r"(Unoindexr"Udomainr"Xpyr"hr]hq]ho]hp]ht]Uobjtyper"Xfunctionr"Udesctyper"j"uhvNhwhhb]r"(csphinx.addnodes desc_signature r")r "}r "(hgX'echoCredentials(session) -> SubjectInfohhj!hijhkUdesc_signaturer "hm}r "(hr]r "h3aUmoduler"jhq]ho]hp]ht]r"h3aUfullnamer"XechoCredentialsr"Uclassr"UUfirstr"uhvK=hwhhb]r"(csphinx.addnodes desc_addname r")r"}r"(hgX CNDiagnostic.hhj "hijhkU desc_addnamer"hm}r"(ho]hp]hq]hr]ht]uhvK=hwhhb]r"hX CNDiagnostic.r"r"}r"(hgUhhj"ubaubcsphinx.addnodes desc_name r")r"}r "(hgj"hhj "hijhkU desc_namer!"hm}r""(ho]hp]hq]hr]ht]uhvK=hwhhb]r#"hXechoCredentialsr$"r%"}r&"(hgUhhj"ubaubcsphinx.addnodes desc_parameterlist r'")r("}r)"(hgXsessionhhj "hijhkUdesc_parameterlistr*"hm}r+"(ho]hp]hq]hr]ht]uhvK=hwhhb]r,"csphinx.addnodes desc_parameter r-")r."}r/"(hgXsessionhm}r0"(ho]hp]hq]hr]ht]uhhj("hb]r1"hXsessionr2"r3"}r4"(hgUhhj."ubahkUdesc_parameterr5"ubaubcsphinx.addnodes desc_returns r6")r7"}r8"(hgX SubjectInfohhj "hijhkU desc_returnsr9"hm}r:"(ho]hp]hq]hr]ht]uhvK=hwhhb]r;"hX SubjectInfor<"r="}r>"(hgUhhj7"ubaubeubcsphinx.addnodes desc_content r?")r@"}rA"(hgUhhj!hijhkU desc_contentrB"hm}rC"(ho]hp]hq]hr]ht]uhvK=hwhhb]rD"(h)rE"}rF"(hgXEcho the credentials used to make the call. This method can be used to verify the client certificate is valid and contains the expected information.rG"hhj@"hijhkhhm}rH"(ho]hp]hq]hr]ht]uhvK#hwhhb]rI"hXEcho the credentials used to make the call. This method can be used to verify the client certificate is valid and contains the expected information.rJ"rK"}rL"(hgjG"hhjE"ubaubh)rM"}rN"(hgX3v2.0: This method was added to the Version 2.0 API.rO"hhj@"hijhkhhm}rP"(ho]hp]hq]hr]ht]uhvK%hwhhb]rQ"hX3v2.0: This method was added to the Version 2.0 API.rR"rS"}rT"(hgjO"hhjM"ubaubh)rU"}rV"(hgUhhj@"hiNhkhhm}rW"(ho]hp]hq]hr]ht]uhvNhwhhb]rX"(h)rY"}rZ"(hgUhhjU"hijhkhhm}r["(ho]hp]hq]hr]ht]uhvK'hwhhb]r\"(h)r]"}r^"(hgXVersionhhjY"hijhkhhm}r_"(ho]hp]hq]hr]ht]uhvKhb]r`"hXVersionra"rb"}rc"(hgUhhj]"ubaubh)rd"}re"(hgX2.0rf"hm}rg"(ho]hp]hq]hr]ht]uhhjY"hb]rh"h)ri"}rj"(hgjf"hhjd"hijhkhhm}rk"(ho]hp]hq]hr]ht]uhvK'hb]rl"hX2.0rm"rn"}ro"(hgjf"hhji"ubaubahkhubeubh)rp"}rq"(hgUhhjU"hijhkhhm}rr"(ho]hp]hq]hr]ht]uhvK(hwhhb]rs"(h)rt"}ru"(hgXREST URLhhjp"hijhkhhm}rv"(ho]hp]hq]hr]ht]uhvKhb]rw"hXREST URLrx"ry"}rz"(hgUhhjt"ubaubh)r{"}r|"(hgX``GET /diag/subject``r}"hm}r~"(ho]hp]hq]hr]ht]uhhjp"hb]r"h)r"}r"(hgj}"hhj{"hijhkhhm}r"(ho]hp]hq]hr]ht]uhvK(hb]r"j)r"}r"(hgj}"hm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"hXGET /diag/subjectr"r"}r"(hgUhhj"ubahkjubaubahkhubeubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhjU"hb]r"(h)r"}r"(hgX Parametershhj"hijhkhhm}r"(ho]hp]hq]hr]ht]uhvKhb]r"hX Parametersr"r"}r"(hgUhhj"ubaubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"h)r"}r"(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate. Transmitted as part of the SSL handshake process.hm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"(csphinx.addnodes literal_strong r")r"}r"(hgXsessionhm}r"(hr]hq]U refspecificr"ho]hp]ht]uhhj"hb]r"hXsessionr"r"}r"(hgUhhj"ubahkUliteral_strongr"ubhX (r"r"}r"(hgUhhj"ubj)r"}r"(hgX:class:`Types.Session`r"hhj"hijhkjhm}r"(UreftypeXclassjjX Types.SessionU refdomainXpyr"hr]hq]U refexplicitho]hp]ht]jjjNjjuhvK*hb]r"j)r"}r"(hgj"hm}r"(ho]hp]r"(jj"Xpy-classr"ehq]hr]ht]uhhj"hb]r"hX Types.Sessionr"r"}r"(hgUhhj"ubahkjubaubhX)r"}r"(hgUhhj"ubhX -- r"r"}r"(hgUhhj"ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate. Transmitted as part of the SSL handshake process.r"r"}r"(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate. Transmitted as part of the SSL handshake process.hhj"ubehkhubahkhubehkhubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhjU"hb]r"(h)r"}r"(hgXReturnshhj"hijhkhhm}r"(ho]hp]hq]hr]ht]uhvKhb]r"hXReturnsr"r"}r"(hgUhhj"ubaubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"h)r"}r"(hgXEThe subjects and groups parsed from the supplied session information.hm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"hXEThe subjects and groups parsed from the supplied session information.r"r"}r"(hgXEThe subjects and groups parsed from the supplied session information.hhj"ubahkhubahkhubehkhubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhjU"hb]r"(h)r"}r"(hgX Return typehhj"hijhkhhm}r"(ho]hp]hq]hr]ht]uhvKhb]r"hX Return typer"r"}r"(hgUhhj"ubaubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"h)r"}r"(hgXTypes.SubjectInfohm}r"(ho]hp]hq]hr]ht]uhhj"hb]r"j)r"}r"(hgX:class:`Types.SubjectInfo`r"hhj"hijhkjhm}r"(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyr"hr]hq]U refexplicitho]hp]ht]jjjNjjuhvK-hb]r"j)r"}r"(hgj"hm}r"(ho]hp]r"(jj"Xpy-classr"ehq]hr]ht]uhhj"hb]r"hXTypes.SubjectInfor"r"}r"(hgUhhj"ubahkjubaubahkhubahkhubehkhubh)r"}r"(hgUhm}r"(ho]hp]hq]hr]ht]uhhjU"hb]r"(h)r"}r"(hgXRaiseshhj"hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKhb]r#hXRaisesr#r#}r#(hgUhhj"ubaubh)r#}r#(hgUhm}r#(ho]hp]hq]hr]ht]uhhj"hb]r#cdocutils.nodes bullet_list r #)r #}r #(hgUhm}r #(ho]hp]hq]hr]ht]uhhj#hb]r #(cdocutils.nodes list_item r#)r#}r#(hgUhm}r#(ho]hp]hq]hr]ht]uhhj #hb]r#h)r#}r#(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4965)The service is not implemented.hm}r#(ho]hp]hq]hr]ht]uhhj#hb]r#(j)r#}r#(hgUhm}r#(UreftypeUexcr#j"U reftargetXExceptions.NotImplementedr#U refdomainj"hr]hq]U refexplicitho]hp]ht]uhhj#hb]r#j")r#}r#(hgj#hm}r#(ho]hp]hq]hr]ht]uhhj#hb]r #hXExceptions.NotImplementedr!#r"#}r##(hgUhhj#ubahkj"ubahkjubhX -- r$#r%#}r&#(hgUhhj#ubh)r'#}r(#(hgX$``(errorCode=501, detailCode=4965)``r)#hhj#hijhkhhm}r*#(ho]hp]hq]hr]ht]uhvK/hb]r+#j)r,#}r-#(hgj)#hm}r.#(ho]hp]hq]hr]ht]uhhj'#hb]r/#hX (errorCode=501, detailCode=4965)r0#r1#}r2#(hgUhhj,#ubahkjubaubh)r3#}r4#(hgXThe service is not implemented.r5#hhj#hijhkhhm}r6#(ho]hp]hq]hr]ht]uhvK1hb]r7#hXThe service is not implemented.r8#r9#}r:#(hgj5#hhj3#ubaubehkhubahkU list_itemr;#ubj#)r<#}r=#(hgUhm}r>#(ho]hp]hq]hr]ht]uhhj #hb]r?#h)r@#}rA#(hgXqExceptions.ServiceFailure -- (errorCode=500, detailCode=4966)An internal failure prevented a successful response.hm}rB#(ho]hp]hq]hr]ht]uhhj<#hb]rC#(j)rD#}rE#(hgUhm}rF#(Ureftypej#j"U reftargetXExceptions.ServiceFailurerG#U refdomainj"hr]hq]U refexplicitho]hp]ht]uhhj@#hb]rH#j")rI#}rJ#(hgjG#hm}rK#(ho]hp]hq]hr]ht]uhhjD#hb]rL#hXExceptions.ServiceFailurerM#rN#}rO#(hgUhhjI#ubahkj"ubahkjubhX -- rP#rQ#}rR#(hgUhhj@#ubh)rS#}rT#(hgX$``(errorCode=500, detailCode=4966)``rU#hhj@#hijhkhhm}rV#(ho]hp]hq]hr]ht]uhvK3hb]rW#j)rX#}rY#(hgjU#hm}rZ#(ho]hp]hq]hr]ht]uhhjS#hb]r[#hX (errorCode=500, detailCode=4966)r\#r]#}r^#(hgUhhjX#ubahkjubaubh)r_#}r`#(hgX4An internal failure prevented a successful response.ra#hhj@#hijhkhhm}rb#(ho]hp]hq]hr]ht]uhvK5hb]rc#hX4An internal failure prevented a successful response.rd#re#}rf#(hgja#hhj_#ubaubehkhubahkj;#ubj#)rg#}rh#(hgUhm}ri#(ho]hp]hq]hr]ht]uhhj #hb]rj#h)rk#}rl#(hgXpExceptions.InvalidToken -- (errorCode=401, detailCode=4967)The supplied session information could not be parsed.hm}rm#(ho]hp]hq]hr]ht]uhhjg#hb]rn#(j)ro#}rp#(hgUhm}rq#(Ureftypej#j"U reftargetXExceptions.InvalidTokenrr#U refdomainj"hr]hq]U refexplicitho]hp]ht]uhhjk#hb]rs#j")rt#}ru#(hgjr#hm}rv#(ho]hp]hq]hr]ht]uhhjo#hb]rw#hXExceptions.InvalidTokenrx#ry#}rz#(hgUhhjt#ubahkj"ubahkjubhX -- r{#r|#}r}#(hgUhhjk#ubh)r~#}r#(hgX$``(errorCode=401, detailCode=4967)``r#hhjk#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvK7hb]r#j)r#}r#(hgj#hm}r#(ho]hp]hq]hr]ht]uhhj~#hb]r#hX (errorCode=401, detailCode=4967)r#r#}r#(hgUhhj#ubahkjubaubh)r#}r#(hgX5The supplied session information could not be parsed.r#hhjk#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvK9hb]r#hX5The supplied session information could not be parsed.r#r#}r#(hgj#hhj#ubaubehkhubahkj;#ubehkU bullet_listr#ubahkhubehkhubeubeubeubj)r#}r#(hgUhhjhiNhkjhm}r#(hr]hq]ho]hp]ht]Uentries]r#(jX-echoSystemMetadata() (in module CNDiagnostic)h@UNtr#auhvNhwhhb]ubj!)r#}r#(hgUhhjhiNhkj!hm}r#(j"j"Xpyr#hr]hq]ho]hp]ht]j"Xfunctionr#j"j#uhvNhwhhb]r#(j")r#}r#(hgX5echoSystemMetadata(session,sysmeta) -> SystemMetadatahhj#hijhkj "hm}r#(hr]r#h@aj"jhq]ho]hp]ht]r#h@aj"XechoSystemMetadatar#j"Uj"uhvKahwhhb]r#(j")r#}r#(hgX CNDiagnostic.hhj#hijhkj"hm}r#(ho]hp]hq]hr]ht]uhvKahwhhb]r#hX CNDiagnostic.r#r#}r#(hgUhhj#ubaubj")r#}r#(hgj#hhj#hijhkj!"hm}r#(ho]hp]hq]hr]ht]uhvKahwhhb]r#hXechoSystemMetadatar#r#}r#(hgUhhj#ubaubj'")r#}r#(hgXsession, sysmetahhj#hijhkj*"hm}r#(ho]hp]hq]hr]ht]uhvKahwhhb]r#(j-")r#}r#(hgXsessionhm}r#(ho]hp]hq]hr]ht]uhhj#hb]r#hXsessionr#r#}r#(hgUhhj#ubahkj5"ubj-")r#}r#(hgXsysmetahm}r#(ho]hp]hq]hr]ht]uhhj#hb]r#hXsysmetar#r#}r#(hgUhhj#ubahkj5"ubeubj6")r#}r#(hgXSystemMetadatahhj#hijhkj9"hm}r#(ho]hp]hq]hr]ht]uhvKahwhhb]r#hXSystemMetadatar#r#}r#(hgUhhj#ubaubeubj?")r#}r#(hgUhhj#hijhkjB"hm}r#(ho]hp]hq]hr]ht]uhvKahwhhb]r#(h)r#}r#(hgX+Parse and echo the provided system metadatar#hhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvK@hwhhb]r#hX+Parse and echo the provided system metadatar#r#}r#(hgj#hhj#ubaubh)r#}r#(hgXOn successful parsing, a copy of the system metadata is returned, otherwise an exception is returned indicating an error condition.r#hhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKBhwhhb]r#hXOn successful parsing, a copy of the system metadata is returned, otherwise an exception is returned indicating an error condition.r#r#}r#(hgj#hhj#ubaubh)r#}r#(hgX+v2.0: This operation is new to version 2.0.r#hhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKDhwhhb]r#hX+v2.0: This operation is new to version 2.0.r#r#}r#(hgj#hhj#ubaubh)r#}r#(hgUhhj#hiNhkhhm}r#(ho]hp]hq]hr]ht]uhvNhwhhb]r#(h)r#}r#(hgUhhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKFhwhhb]r#(h)r#}r#(hgXVersionhhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKhb]r#hXVersionr#r#}r#(hgUhhj#ubaubh)r#}r#(hgX2.0r#hm}r#(ho]hp]hq]hr]ht]uhhj#hb]r#h)r#}r#(hgj#hhj#hijhkhhm}r#(ho]hp]hq]hr]ht]uhvKFhb]r#hX2.0r$r$}r$(hgj#hhj#ubaubahkhubeubh)r$}r$(hgUhhj#hijhkhhm}r$(ho]hp]hq]hr]ht]uhvKGhwhhb]r$(h)r$}r$(hgXREST URLhhj$hijhkhhm}r $(ho]hp]hq]hr]ht]uhvKhb]r $hXREST URLr $r $}r $(hgUhhj$ubaubh)r$}r$(hgX``POST /diag/sysmeta``r$hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$h)r$}r$(hgj$hhj$hijhkhhm}r$(ho]hp]hq]hr]ht]uhvKGhb]r$j)r$}r$(hgj$hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$hXPOST /diag/sysmetar$r$}r$(hgUhhj$ubahkjubaubahkhubeubh)r$}r$(hgUhm}r $(ho]hp]hq]hr]ht]uhhj#hb]r!$(h)r"$}r#$(hgX Parametershhj$hijhkhhm}r$$(ho]hp]hq]hr]ht]uhvKhb]r%$hX Parametersr&$r'$}r($(hgUhhj"$ubaubh)r)$}r*$(hgUhm}r+$(ho]hp]hq]hr]ht]uhhj$hb]r,$j #)r-$}r.$(hgUhm}r/$(ho]hp]hq]hr]ht]uhhj)$hb]r0$(j#)r1$}r2$(hgUhm}r3$(ho]hp]hq]hr]ht]uhhj-$hb]r4$h)r5$}r6$(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.hm}r7$(ho]hp]hq]hr]ht]uhhj1$hb]r8$(j")r9$}r:$(hgXsessionhm}r;$(hr]hq]j"ho]hp]ht]uhhj5$hb]r<$hXsessionr=$r>$}r?$(hgUhhj9$ubahkj"ubhX (r@$rA$}rB$(hgUhhj5$ubj)rC$}rD$(hgX:class:`Types.Session`rE$hhj5$hijhkjhm}rF$(UreftypeXclassjjX Types.SessionU refdomainXpyrG$hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKIhb]rH$j)rI$}rJ$(hgjE$hm}rK$(ho]hp]rL$(jjG$Xpy-classrM$ehq]hr]ht]uhhjC$hb]rN$hX Types.SessionrO$rP$}rQ$(hgUhhjI$ubahkjubaubhX)rR$}rS$(hgUhhj5$ubhX -- rT$rU$}rV$(hgUhhj5$ubhXSession information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.rW$rX$}rY$(hgXSession information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.hhj5$ubehkhubahkj;#ubj#)rZ$}r[$(hgUhm}r\$(ho]hp]hq]hr]ht]uhhj-$hb]r]$h)r^$}r_$(hgXsysmeta (Types.SystemMetadata) -- A SystemMetadata object to be examined. The object is parsed and error conditions reported by an exception response. On successful parsing, the SystemMetadata object is echoed back with a HTTP 200 status. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r`$(ho]hp]hq]hr]ht]uhhjZ$hb]ra$(j")rb$}rc$(hgXsysmetahm}rd$(hr]hq]j"ho]hp]ht]uhhj^$hb]re$hXsysmetarf$rg$}rh$(hgUhhjb$ubahkj"ubhX (ri$rj$}rk$(hgUhhj^$ubj)rl$}rm$(hgX:class:`Types.SystemMetadata`rn$hhj^$hijhkjhm}ro$(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrp$hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKLhb]rq$j)rr$}rs$(hgjn$hm}rt$(ho]hp]ru$(jjp$Xpy-classrv$ehq]hr]ht]uhhjl$hb]rw$hXTypes.SystemMetadatarx$ry$}rz$(hgUhhjr$ubahkjubaubhX)r{$}r|$(hgUhhj^$ubhX -- r}$r~$}r$(hgUhhj^$ubhX@A SystemMetadata object to be examined. The object is parsed and error conditions reported by an exception response. On successful parsing, the SystemMetadata object is echoed back with a HTTP 200 status. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r$r$}r$(hgX@A SystemMetadata object to be examined. The object is parsed and error conditions reported by an exception response. On successful parsing, the SystemMetadata object is echoed back with a HTTP 200 status. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhj^$ubcdocutils.nodes emphasis r$)r$}r$(hgX *File part*hm}r$(ho]hp]hq]hr]ht]uhhj^$hb]r$hX File partr$r$}r$(hgUhhj$ubahkUemphasisr$ubhX% of the MIME multipart/mixed message.r$r$}r$(hgX% of the MIME multipart/mixed message.hhj^$ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj#hb]r$(h)r$}r$(hgXReturnshhj$hijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r$hXReturnsr$r$}r$(hgUhhj$ubaubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$h)r$}r$(hgX'A copy of the supplied System Metadata.hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$hX'A copy of the supplied System Metadata.r$r$}r$(hgX'A copy of the supplied System Metadata.hhj$ubahkhubahkhubehkhubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj#hb]r$(h)r$}r$(hgX Return typehhj$hijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r$hX Return typer$r$}r$(hgUhhj$ubaubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$h)r$}r$(hgXTypes.SystemMetadatahm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$j)r$}r$(hgX:class:`Types.SystemMetadata`r$hhj$hijhkjhm}r$(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr$hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKOhb]r$j)r$}r$(hgj$hm}r$(ho]hp]r$(jj$Xpy-classr$ehq]hr]ht]uhhj$hb]r$hXTypes.SystemMetadatar$r$}r$(hgUhhj$ubahkjubaubahkhubahkhubehkhubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj#hb]r$(h)r$}r$(hgXRaiseshhj$hijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r$hXRaisesr$r$}r$(hgUhhj$ubaubh)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$j #)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$(j#)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$h)r$}r$(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4970)hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$(j)r$}r$(hgUhm}r$(Ureftypej#j"U reftargetXExceptions.NotImplementedr$U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhj$hb]r$j")r$}r$(hgj$hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$hXExceptions.NotImplementedr$r$}r$(hgUhhj$ubahkj"ubahkjubhX -- r$r$}r$(hgUhhj$ubj)r$}r$(hgX$``(errorCode=501, detailCode=4970)``hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$hX (errorCode=501, detailCode=4970)r$r$}r$(hgUhhj$ubahkjubehkhubahkj;#ubj#)r$}r$(hgUhm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$h)r$}r$(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4971)hm}r$(ho]hp]hq]hr]ht]uhhj$hb]r$(j)r%}r%(hgUhm}r%(Ureftypej#j"U reftargetXExceptions.ServiceFailurer%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhj$hb]r%j")r%}r%(hgj%hm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hXExceptions.ServiceFailurer %r %}r %(hgUhhj%ubahkj"ubahkjubhX -- r %r %}r%(hgUhhj$ubj)r%}r%(hgX$``(errorCode=500, detailCode=4971)``hm}r%(ho]hp]hq]hr]ht]uhhj$hb]r%hX (errorCode=500, detailCode=4971)r%r%}r%(hgUhhj%ubahkjubehkhubahkj;#ubj#)r%}r%(hgUhm}r%(ho]hp]hq]hr]ht]uhhj$hb]r%h)r%}r%(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4972)hm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%(j)r%}r%(hgUhm}r %(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr!%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhj%hb]r"%j")r#%}r$%(hgj!%hm}r%%(ho]hp]hq]hr]ht]uhhj%hb]r&%hXExceptions.NotAuthorizedr'%r(%}r)%(hgUhhj#%ubahkj"ubahkjubhX -- r*%r+%}r,%(hgUhhj%ubj)r-%}r.%(hgX$``(errorCode=401, detailCode=4972)``hm}r/%(ho]hp]hq]hr]ht]uhhj%hb]r0%hX (errorCode=401, detailCode=4972)r1%r2%}r3%(hgUhhj-%ubahkjubehkhubahkj;#ubj#)r4%}r5%(hgUhm}r6%(ho]hp]hq]hr]ht]uhhj$hb]r7%h)r8%}r9%(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4973)hm}r:%(ho]hp]hq]hr]ht]uhhj4%hb]r;%(j)r<%}r=%(hgUhm}r>%(Ureftypej#j"U reftargetXExceptions.InvalidTokenr?%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhj8%hb]r@%j")rA%}rB%(hgj?%hm}rC%(ho]hp]hq]hr]ht]uhhj<%hb]rD%hXExceptions.InvalidTokenrE%rF%}rG%(hgUhhjA%ubahkj"ubahkjubhX -- rH%rI%}rJ%(hgUhhj8%ubj)rK%}rL%(hgX$``(errorCode=401, detailCode=4973)``hm}rM%(ho]hp]hq]hr]ht]uhhj8%hb]rN%hX (errorCode=401, detailCode=4973)rO%rP%}rQ%(hgUhhjK%ubahkjubehkhubahkj;#ubj#)rR%}rS%(hgUhm}rT%(ho]hp]hq]hr]ht]uhhj$hb]rU%h)rV%}rW%(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4974)hm}rX%(ho]hp]hq]hr]ht]uhhjR%hb]rY%(j)rZ%}r[%(hgUhm}r\%(Ureftypej#j"U reftargetXExceptions.InvalidRequestr]%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhjV%hb]r^%j")r_%}r`%(hgj]%hm}ra%(ho]hp]hq]hr]ht]uhhjZ%hb]rb%hXExceptions.InvalidRequestrc%rd%}re%(hgUhhj_%ubahkj"ubahkjubhX -- rf%rg%}rh%(hgUhhjV%ubj)ri%}rj%(hgX$``(errorCode=400, detailCode=4974)``hm}rk%(ho]hp]hq]hr]ht]uhhjV%hb]rl%hX (errorCode=400, detailCode=4974)rm%rn%}ro%(hgUhhji%ubahkjubehkhubahkj;#ubj#)rp%}rq%(hgUhm}rr%(ho]hp]hq]hr]ht]uhhj$hb]rs%h)rt%}ru%(hgXBExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=4975)hm}rv%(ho]hp]hq]hr]ht]uhhjp%hb]rw%(j)rx%}ry%(hgUhm}rz%(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquer{%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhjt%hb]r|%j")r}%}r~%(hgj{%hm}r%(ho]hp]hq]hr]ht]uhhjx%hb]r%hXExceptions.IdentifierNotUniquer%r%}r%(hgUhhj}%ubahkj"ubahkjubhX -- r%r%}r%(hgUhhjt%ubj)r%}r%(hgX$``(errorCode=409, detailCode=4975)``hm}r%(ho]hp]hq]hr]ht]uhhjt%hb]r%hX (errorCode=409, detailCode=4975)r%r%}r%(hgUhhj%ubahkjubehkhubahkj;#ubj#)r%}r%(hgUhm}r%(ho]hp]hq]hr]ht]uhhj$hb]r%h)r%}r%(hgXDExceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=4976)hm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%(j)r%}r%(hgUhm}r%(Ureftypej#j"U reftargetX Exceptions.InvalidSystemMetadatar%U refdomainj#hr]hq]U refexplicitho]hp]ht]uhhj%hb]r%j")r%}r%(hgj%hm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hX Exceptions.InvalidSystemMetadatar%r%}r%(hgUhhj%ubahkj"ubahkjubhX -- r%r%}r%(hgUhhj%ubj)r%}r%(hgX$``(errorCode=400, detailCode=4976)``hm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hX (errorCode=400, detailCode=4976)r%r%}r%(hgUhhj%ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r%}r%(hgUhhjhiNhkjhm}r%(hr]hq]ho]hp]ht]Uentries]r%(jX,echoIndexedObject() (in module CNDiagnostic)h1UNtr%auhvNhwhhb]ubj!)r%}r%(hgUhhjhiNhkj!hm}r%(j"j"Xpyr%hr]hq]ho]hp]ht]j"Xfunctionr%j"j%uhvNhwhhb]r%(j")r%}r%(hgXDechoIndexedObject(session,queryEngine,sysmeta,object) -> OctetStreamhhj%hiXGinternal padding after source/apis/generated/generated_CNDiagnostic.txtr%hkj "hm}r%(hr]r%h1aj"jhq]ho]hp]ht]r%h1aj"XechoIndexedObjectr%j"Uj"uhvKhwhhb]r%(j")r%}r%(hgX CNDiagnostic.hhj%hij%hkj"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r%hX CNDiagnostic.r%r%}r%(hgUhhj%ubaubj")r%}r%(hgj%hhj%hij%hkj!"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r%hXechoIndexedObjectr%r%}r%(hgUhhj%ubaubj'")r%}r%(hgX%session, queryEngine, sysmeta, objecthhj%hij%hkj*"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r%(j-")r%}r%(hgXsessionhm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hXsessionr%r%}r%(hgUhhj%ubahkj5"ubj-")r%}r%(hgX queryEnginehm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hX queryEnginer%r%}r%(hgUhhj%ubahkj5"ubj-")r%}r%(hgXsysmetahm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hXsysmetar%r%}r%(hgUhhj%ubahkj5"ubj-")r%}r%(hgXobjecthm}r%(ho]hp]hq]hr]ht]uhhj%hb]r%hXobjectr%r%}r%(hgUhhj%ubahkj5"ubeubj6")r%}r%(hgX OctetStreamhhj%hij%hkj9"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r%hX OctetStreamr%r%}r%(hgUhhj%ubaubeubj?")r%}r%(hgUhhj%hij%hkjB"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r%(h)r%}r%(hgXParse and echo the provided science metadata or resource map document. The response is governed by the type of object provided in the request, and on success is one or more documents that are the result of parsing for indexing.r%hhj%hijhkhhm}r%(ho]hp]hq]hr]ht]uhvKdhwhhb]r%hXParse and echo the provided science metadata or resource map document. The response is governed by the type of object provided in the request, and on success is one or more documents that are the result of parsing for indexing.r%r%}r%(hgj%hhj%ubaubh)r&}r&(hgX{Since DataONE supports multiple types of query engine, the query engine to be used for parsing is specified in the request.r&hhj%hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKfhwhhb]r&hX{Since DataONE supports multiple types of query engine, the query engine to be used for parsing is specified in the request.r&r&}r&(hgj&hhj&ubaubh)r&}r &(hgXbThe servce may terminate the POST operation if the size of the object is beyond a reasonable size.r &hhj%hijhkhhm}r &(ho]hp]hq]hr]ht]uhvKhhwhhb]r &hXbThe servce may terminate the POST operation if the size of the object is beyond a reasonable size.r &r&}r&(hgj &hhj&ubaubh)r&}r&(hgX+v2.0: This operation is new to version 2.0.r&hhj%hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKjhwhhb]r&hX+v2.0: This operation is new to version 2.0.r&r&}r&(hgj&hhj&ubaubh)r&}r&(hgUhhj%hiNhkhhm}r&(ho]hp]hq]hr]ht]uhvNhwhhb]r&(h)r&}r&(hgUhhj&hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKlhwhhb]r&(h)r &}r!&(hgXVersionhhj&hijhkhhm}r"&(ho]hp]hq]hr]ht]uhvKhb]r#&hXVersionr$&r%&}r&&(hgUhhj &ubaubh)r'&}r(&(hgX2.0r)&hm}r*&(ho]hp]hq]hr]ht]uhhj&hb]r+&h)r,&}r-&(hgj)&hhj'&hijhkhhm}r.&(ho]hp]hq]hr]ht]uhvKlhb]r/&hX2.0r0&r1&}r2&(hgj)&hhj,&ubaubahkhubeubh)r3&}r4&(hgUhhj&hijhkhhm}r5&(ho]hp]hq]hr]ht]uhvKmhwhhb]r6&(h)r7&}r8&(hgXREST URLhhj3&hijhkhhm}r9&(ho]hp]hq]hr]ht]uhvKhb]r:&hXREST URLr;&r<&}r=&(hgUhhj7&ubaubh)r>&}r?&(hgX``POST /diag/object``r@&hm}rA&(ho]hp]hq]hr]ht]uhhj3&hb]rB&h)rC&}rD&(hgj@&hhj>&hijhkhhm}rE&(ho]hp]hq]hr]ht]uhvKmhb]rF&j)rG&}rH&(hgj@&hm}rI&(ho]hp]hq]hr]ht]uhhjC&hb]rJ&hXPOST /diag/objectrK&rL&}rM&(hgUhhjG&ubahkjubaubahkhubeubh)rN&}rO&(hgUhm}rP&(ho]hp]hq]hr]ht]uhhj&hb]rQ&(h)rR&}rS&(hgX ParametershhjN&hij%hkhhm}rT&(ho]hp]hq]hr]ht]uhvKhb]rU&hX ParametersrV&rW&}rX&(hgUhhjR&ubaubh)rY&}rZ&(hgUhm}r[&(ho]hp]hq]hr]ht]uhhjN&hb]r\&j #)r]&}r^&(hgUhm}r_&(ho]hp]hq]hr]ht]uhhjY&hb]r`&(j#)ra&}rb&(hgUhm}rc&(ho]hp]hq]hr]ht]uhhj]&hb]rd&h)re&}rf&(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.hm}rg&(ho]hp]hq]hr]ht]uhhja&hb]rh&(j")ri&}rj&(hgXsessionhm}rk&(hr]hq]j"ho]hp]ht]uhhje&hb]rl&hXsessionrm&rn&}ro&(hgUhhji&ubahkj"ubhX (rp&rq&}rr&(hgUhhje&ubj)rs&}rt&(hgX:class:`Types.Session`ru&hhje&hijhkjhm}rv&(UreftypeXclassjjX Types.SessionU refdomainXpyrw&hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKohb]rx&j)ry&}rz&(hgju&hm}r{&(ho]hp]r|&(jjw&Xpy-classr}&ehq]hr]ht]uhhjs&hb]r~&hX Types.Sessionr&r&}r&(hgUhhjy&ubahkjubaubhX)r&}r&(hgUhhje&ubhX -- r&r&}r&(hgUhhje&ubhXSession information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.r&r&}r&(hgXSession information that contains the identity of the calling user as retrieved from the x.509 certificate. The service MAY choose to limit access to only authorized users. Transmitted as part of the SSL handshake process.hhje&ubehkhubahkj;#ubj#)r&}r&(hgUhm}r&(ho]hp]hq]hr]ht]uhhj]&hb]r&h)r&}r&(hgXqueryEngine (string) -- A valid query engine name as reported by listQueryEngines() Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r&(ho]hp]hq]hr]ht]uhhj&hb]r&(j")r&}r&(hgX queryEnginehm}r&(hr]hq]j"ho]hp]ht]uhhj&hb]r&hX queryEnginer&r&}r&(hgUhhj&ubahkj"ubhX (r&r&}r&(hgUhhj&ubj)r&}r&(hgUhm}r&(UreftypeUobjr&j"U reftargetXstringr&U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj&hb]r&csphinx.addnodes literal_emphasis r&)r&}r&(hgj&hm}r&(ho]hp]hq]hr]ht]uhhj&hb]r&hXstringr&r&}r&(hgUhhj&ubahkUliteral_emphasisr&ubahkjubhX)r&}r&(hgUhhj&ubhX -- r&r&}r&(hgUhhj&ubhX)A valid query engine name as reported by r&r&}r&(hgX)A valid query engine name as reported by hhj&ubj)r&}r&(hgX:func:`listQueryEngines`r&hhj&hijhkjhm}r&(UreftypeXfuncjjXlistQueryEnginesU refdomainXpyr&hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKqhb]r&j)r&}r&(hgj&hm}r&(ho]hp]r&(jj&Xpy-funcr&ehq]hr]ht]uhhj&hb]r&hXlistQueryEngines()r&r&}r&(hgUhhj&ubahkjubaubhX$ Transmitted as a UTF-8 String as a r&r&}r&(hgX$ Transmitted as a UTF-8 String as a hhj&ubj$)r&}r&(hgX *Param part*hm}r&(ho]hp]hq]hr]ht]uhhj&hb]r&hX Param partr&r&}r&(hgUhhj&ubahkj$ubhX% of the MIME multipart/mixed message.r&r&}r&(hgX% of the MIME multipart/mixed message.hhj&ubehkhubahkj;#ubj#)r&}r&(hgUhm}r&(ho]hp]hq]hr]ht]uhhj]&hb]r&h)r&}r&(hgX sysmeta (Types.SystemMetadata) -- A SystemMetadata object that passes the echoSystemMetadata diagnostic. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r&(ho]hp]hq]hr]ht]uhhj&hb]r&(j")r&}r&(hgXsysmetahm}r&(hr]hq]j"ho]hp]ht]uhhj&hb]r&hXsysmetar&r&}r&(hgUhhj&ubahkj"ubhX (r&r&}r&(hgUhhj&ubj)r&}r&(hgX:class:`Types.SystemMetadata`r&hhj&hijhkjhm}r&(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr&hr]hq]U refexplicitho]hp]ht]jjjNjjuhvKuhb]r&j)r&}r&(hgj&hm}r&(ho]hp]r&(jj&Xpy-classr&ehq]hr]ht]uhhj&hb]r&hXTypes.SystemMetadatar&r&}r&(hgUhhj&ubahkjubaubhX)r&}r&(hgUhhj&ubhX -- r&r&}r&(hgUhhj&ubhXA SystemMetadata object that passes the echoSystemMetadata diagnostic. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r&r&}r&(hgXA SystemMetadata object that passes the echoSystemMetadata diagnostic. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhj&ubj$)r&}r&(hgX *File part*hm}r&(ho]hp]hq]hr]ht]uhhj&hb]r&hX File partr&r&}r&(hgUhhj&ubahkj$ubhX% of the MIME multipart/mixed message.r&r'}r'(hgX% of the MIME multipart/mixed message.hhj&ubehkhubahkj;#ubj#)r'}r'(hgUhm}r'(ho]hp]hq]hr]ht]uhhj]&hb]r'h)r'}r'(hgXjobject (bytes) -- A document (e.g. science metadata or resource map) that is to be evalauted for indexing.hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r '(j")r '}r '(hgXobjecthm}r '(hr]hq]j"ho]hp]ht]uhhj'hb]r 'hXobjectr'r'}r'(hgUhhj 'ubahkj"ubhX (r'r'}r'(hgUhhj'ubj)r'}r'(hgUhm}r'(Ureftypej&j"U reftargetXbytesr'U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj'hb]r'j&)r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hXbytesr'r'}r'(hgUhhj'ubahkj&ubahkjubhX)r '}r!'(hgUhhj'ubhX -- r"'r#'}r$'(hgUhhj'ubhXXA document (e.g. science metadata or resource map) that is to be evalauted for indexing.r%'r&'}r''(hgXXA document (e.g. science metadata or resource map) that is to be evalauted for indexing.hhj'ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r('}r)'(hgUhm}r*'(ho]hp]hq]hr]ht]uhhj&hb]r+'(h)r,'}r-'(hgXReturnshhj('hij%hkhhm}r.'(ho]hp]hq]hr]ht]uhvKhb]r/'hXReturnsr0'r1'}r2'(hgUhhj,'ubaubh)r3'}r4'(hgUhm}r5'(ho]hp]hq]hr]ht]uhhj('hb]r6'h)r7'}r8'(hgXA document representing the parsed object as it would be prior to being added to a search index. For the solr query engine for example, this would be the equivalent of a .. .. structure with possibly multiple documents.hm}r9'(ho]hp]hq]hr]ht]uhhj3'hb]r:'(hXA document representing the parsed object as it would be prior to being added to a search index. For the solr query engine for example, this would be the equivalent of a r;'r<'}r='(hgXA document representing the parsed object as it would be prior to being added to a search index. For the solr query engine for example, this would be the equivalent of a hhj7'ubj$)r>'}r?'(hgX * .. .. *hm}r@'(ho]hp]hq]hr]ht]uhhj7'hb]rA'hX .. .. rB'rC'}rD'(hgUhhj>'ubahkj$ubhX, structure with possibly multiple documents.rE'rF'}rG'(hgX, structure with possibly multiple documents.hhj7'ubehkhubahkhubehkhubh)rH'}rI'(hgUhm}rJ'(ho]hp]hq]hr]ht]uhhj&hb]rK'(h)rL'}rM'(hgX Return typehhjH'hij%hkhhm}rN'(ho]hp]hq]hr]ht]uhvKhb]rO'hX Return typerP'rQ'}rR'(hgUhhjL'ubaubh)rS'}rT'(hgUhm}rU'(ho]hp]hq]hr]ht]uhhjH'hb]rV'h)rW'}rX'(hgXTypes.OctetStreamhm}rY'(ho]hp]hq]hr]ht]uhhjS'hb]rZ'j)r['}r\'(hgX:class:`Types.OctetStream`r]'hhjW'hijhkjhm}r^'(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr_'hr]hq]U refexplicitho]hp]ht]jjjNjjuhvK{hb]r`'j)ra'}rb'(hgj]'hm}rc'(ho]hp]rd'(jj_'Xpy-classre'ehq]hr]ht]uhhj['hb]rf'hXTypes.OctetStreamrg'rh'}ri'(hgUhhja'ubahkjubaubahkhubahkhubehkhubh)rj'}rk'(hgUhm}rl'(ho]hp]hq]hr]ht]uhhj&hb]rm'(h)rn'}ro'(hgXRaiseshhjj'hij%hkhhm}rp'(ho]hp]hq]hr]ht]uhvKhb]rq'hXRaisesrr'rs'}rt'(hgUhhjn'ubaubh)ru'}rv'(hgUhm}rw'(ho]hp]hq]hr]ht]uhhjj'hb]rx'j #)ry'}rz'(hgUhm}r{'(ho]hp]hq]hr]ht]uhhju'hb]r|'(j#)r}'}r~'(hgUhm}r'(ho]hp]hq]hr]ht]uhhjy'hb]r'h)r'}r'(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4980)The service is not implemented.hm}r'(ho]hp]hq]hr]ht]uhhj}'hb]r'(j)r'}r'(hgUhm}r'(Ureftypej#j"U reftargetXExceptions.NotImplementedr'U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj'hb]r'j")r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hXExceptions.NotImplementedr'r'}r'(hgUhhj'ubahkj"ubahkjubhX -- r'r'}r'(hgUhhj'ubh)r'}r'(hgX$``(errorCode=501, detailCode=4980)``r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvK}hb]r'j)r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hX (errorCode=501, detailCode=4980)r'r'}r'(hgUhhj'ubahkjubaubh)r'}r'(hgXThe service is not implemented.r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r'hXThe service is not implemented.r'r'}r'(hgj'hhj'ubaubehkhubahkj;#ubj#)r'}r'(hgUhm}r'(ho]hp]hq]hr]ht]uhhjy'hb]r'h)r'}r'(hgXqExceptions.ServiceFailure -- (errorCode=500, detailCode=4981)An internal failure prevented a successful response.hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'(j)r'}r'(hgUhm}r'(Ureftypej#j"U reftargetXExceptions.ServiceFailurer'U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj'hb]r'j")r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hXExceptions.ServiceFailurer'r'}r'(hgUhhj'ubahkj"ubahkjubhX -- r'r'}r'(hgUhhj'ubh)r'}r'(hgX$``(errorCode=500, detailCode=4981)``r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r'j)r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hX (errorCode=500, detailCode=4981)r'r'}r'(hgUhhj'ubahkjubaubh)r'}r'(hgX4An internal failure prevented a successful response.r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r'hX4An internal failure prevented a successful response.r'r'}r'(hgj'hhj'ubaubehkhubahkj;#ubj#)r'}r'(hgUhm}r'(ho]hp]hq]hr]ht]uhhjy'hb]r'h)r'}r'(hgX{Exceptions.NotAuthorized -- (errorCode=401, detailCode=4982)The supplied credentials are not authorized for this operation.hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'(j)r'}r'(hgUhm}r'(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr'U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj'hb]r'j")r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hXExceptions.NotAuthorizedr'r'}r'(hgUhhj'ubahkj"ubahkjubhX -- r'r'}r'(hgUhhj'ubh)r'}r'(hgX$``(errorCode=401, detailCode=4982)``r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r'j)r'}r'(hgj'hm}r'(ho]hp]hq]hr]ht]uhhj'hb]r'hX (errorCode=401, detailCode=4982)r'r'}r'(hgUhhj'ubahkjubaubh)r'}r'(hgX?The supplied credentials are not authorized for this operation.r'hhj'hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r'hX?The supplied credentials are not authorized for this operation.r'r'}r'(hgj'hhj'ubaubehkhubahkj;#ubj#)r'}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhjy'hb]r(h)r(}r((hgXpExceptions.InvalidToken -- (errorCode=401, detailCode=4983)The supplied session information could not be parsed.hm}r((ho]hp]hq]hr]ht]uhhj'hb]r((j)r(}r((hgUhm}r((Ureftypej#j"U reftargetXExceptions.InvalidTokenr (U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj(hb]r (j")r (}r ((hgj (hm}r ((ho]hp]hq]hr]ht]uhhj(hb]r(hXExceptions.InvalidTokenr(r(}r((hgUhhj (ubahkj"ubahkjubhX -- r(r(}r((hgUhhj(ubh)r(}r((hgX$``(errorCode=401, detailCode=4983)``r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(j)r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX (errorCode=401, detailCode=4983)r(r(}r ((hgUhhj(ubahkjubaubh)r!(}r"((hgX5The supplied session information could not be parsed.r#(hhj(hijhkhhm}r$((ho]hp]hq]hr]ht]uhvKhb]r%(hX5The supplied session information could not be parsed.r&(r'(}r(((hgj#(hhj!(ubaubehkhubahkj;#ubj#)r)(}r*((hgUhm}r+((ho]hp]hq]hr]ht]uhhjy'hb]r,(h)r-(}r.((hgXeExceptions.InvalidRequest -- (errorCode=400, detailCode=4984)The structure of the request is invalid.hm}r/((ho]hp]hq]hr]ht]uhhj)(hb]r0((j)r1(}r2((hgUhm}r3((Ureftypej#j"U reftargetXExceptions.InvalidRequestr4(U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj-(hb]r5(j")r6(}r7((hgj4(hm}r8((ho]hp]hq]hr]ht]uhhj1(hb]r9(hXExceptions.InvalidRequestr:(r;(}r<((hgUhhj6(ubahkj"ubahkjubhX -- r=(r>(}r?((hgUhhj-(ubh)r@(}rA((hgX$``(errorCode=400, detailCode=4984)``rB(hhj-(hijhkhhm}rC((ho]hp]hq]hr]ht]uhvKhb]rD(j)rE(}rF((hgjB(hm}rG((ho]hp]hq]hr]ht]uhhj@(hb]rH(hX (errorCode=400, detailCode=4984)rI(rJ(}rK((hgUhhjE(ubahkjubaubh)rL(}rM((hgX(The structure of the request is invalid.rN(hhj-(hijhkhhm}rO((ho]hp]hq]hr]ht]uhvKhb]rP(hX(The structure of the request is invalid.rQ(rR(}rS((hgjN(hhjL(ubaubehkhubahkj;#ubj#)rT(}rU((hgUhm}rV((ho]hp]hq]hr]ht]uhhjy'hb]rW(h)rX(}rY((hgXlExceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=4985)The system metadata could not be parsed.hm}rZ((ho]hp]hq]hr]ht]uhhjT(hb]r[((j)r\(}r]((hgUhm}r^((Ureftypej#j"U reftargetX Exceptions.InvalidSystemMetadatar_(U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjX(hb]r`(j")ra(}rb((hgj_(hm}rc((ho]hp]hq]hr]ht]uhhj\(hb]rd(hX Exceptions.InvalidSystemMetadatare(rf(}rg((hgUhhja(ubahkj"ubahkjubhX -- rh(ri(}rj((hgUhhjX(ubh)rk(}rl((hgX$``(errorCode=400, detailCode=4985)``rm(hhjX(hijhkhhm}rn((ho]hp]hq]hr]ht]uhvKhb]ro(j)rp(}rq((hgjm(hm}rr((ho]hp]hq]hr]ht]uhhjk(hb]rs(hX (errorCode=400, detailCode=4985)rt(ru(}rv((hgUhhjp(ubahkjubaubh)rw(}rx((hgX(The system metadata could not be parsed.ry(hhjX(hijhkhhm}rz((ho]hp]hq]hr]ht]uhvKhb]r{(hX(The system metadata could not be parsed.r|(r}(}r~((hgjy(hhjw(ubaubehkhubahkj;#ubj#)r(}r((hgUhm}r((ho]hp]hq]hr]ht]uhhjy'hb]r(h)r(}r((hgXnExceptions.UnsupportedType -- (errorCode=400, detailCode=4986)The supplied object was not of a supported type.hm}r((ho]hp]hq]hr]ht]uhhj(hb]r((j)r(}r((hgUhm}r((Ureftypej#j"U reftargetXExceptions.UnsupportedTyper(U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj(hb]r(j")r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hXExceptions.UnsupportedTyper(r(}r((hgUhhj(ubahkj"ubahkjubhX -- r(r(}r((hgUhhj(ubh)r(}r((hgX$``(errorCode=400, detailCode=4986)``r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(j)r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX (errorCode=400, detailCode=4986)r(r(}r((hgUhhj(ubahkjubaubh)r(}r((hgX0The supplied object was not of a supported type.r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(hX0The supplied object was not of a supported type.r(r(}r((hgj(hhj(ubaubehkhubahkj;#ubj#)r(}r((hgUhm}r((ho]hp]hq]hr]ht]uhhjy'hb]r(h)r(}r((hgXExceptions.UnsupportedMetadataType -- (errorCode=400, detailCode=4987)The provided metadata format is not supported by the query engine.hm}r((ho]hp]hq]hr]ht]uhhj(hb]r((j)r(}r((hgUhm}r((Ureftypej#j"U reftargetX"Exceptions.UnsupportedMetadataTyper(U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj(hb]r(j")r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX"Exceptions.UnsupportedMetadataTyper(r(}r((hgUhhj(ubahkj"ubahkjubhX -- r(r(}r((hgUhhj(ubh)r(}r((hgX$``(errorCode=400, detailCode=4987)``r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(j)r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX (errorCode=400, detailCode=4987)r(r(}r((hgUhhj(ubahkjubaubh)r(}r((hgXBThe provided metadata format is not supported by the query engine.r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(hXBThe provided metadata format is not supported by the query engine.r(r(}r((hgj(hhj(ubaubehkhubahkj;#ubj#)r(}r((hgUhm}r((ho]hp]hq]hr]ht]uhhjy'hb]r(h)r(}r((hgXExceptions.InsufficientResources -- (errorCode=413, detailCode=4988)Insufficient resources could be allocated to support the request. The provided object may be too large to process.hm}r((ho]hp]hq]hr]ht]uhhj(hb]r((j)r(}r((hgUhm}r((Ureftypej#j"U reftargetX Exceptions.InsufficientResourcesr(U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj(hb]r(j")r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX Exceptions.InsufficientResourcesr(r(}r((hgUhhj(ubahkj"ubahkjubhX -- r(r(}r((hgUhhj(ubh)r(}r((hgX$``(errorCode=413, detailCode=4988)``r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(j)r(}r((hgj(hm}r((ho]hp]hq]hr]ht]uhhj(hb]r(hX (errorCode=413, detailCode=4988)r(r(}r((hgUhhj(ubahkjubaubh)r(}r((hgXrInsufficient resources could be allocated to support the request. The provided object may be too large to process.r(hhj(hijhkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r(hXrInsufficient resources could be allocated to support the request. The provided object may be too large to process.r(r(}r((hgj(hhj(ubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubeubhd)r)}r)(hgUhhhehihjhkhlhm}r)(ho]hp]hq]hr]r)(X module-CNCorer)h[eht]r)h(auhvK7hwhhb]r)(hy)r)}r)(hgXCore APIr )hhj)hihjhkh}hm}r )(ho]hp]hq]hr]ht]uhvK7hwhhb]r )hXCore APIr )r )}r)(hgj )hhj)ubaubj)r)}r)(hgUhhj)hihjhkjhm}r)(hr]hq]ho]hp]ht]Uentries]r)(jXCNCore (module)X module-CNCoreUNtr)auhvNhwhhb]ubj)r)}r)(hgXBWarning: this file is automatically generated. Edits will be losthhj)hijX*source/apis/generated/generated_CNCore.txtr)r)}r)bhkj!hm}r)(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]r)hXBWarning: this file is automatically generated. Edits will be lostr)r)}r)(hgUhhj)ubaubj))r)}r)(hgUhhj)hiNhkj,hm}r )(ho]hp]hq]hr]r!)Uid3r")aht]uhvNhwhhb]r#)(hy)r$)}r%)(hgX"Functions defined in :mod:`CNCore`hm}r&)(ho]hp]hq]hr]ht]uhhj)hb]r')(hXFunctions defined in r()r))}r*)(hgXFunctions defined in hhj$)ubj)r+)}r,)(hgX :mod:`CNCore`r-)hhj$)hij)hkjhm}r.)(UreftypeXmodjjXCNCoreU refdomainXpyr/)hr]hq]U refexplicitho]hp]ht]jjjNjXCNCorer0)uhvKhb]r1)j)r2)}r3)(hgj-)hm}r4)(ho]hp]r5)(jj/)Xpy-modr6)ehq]hr]ht]uhhj+)hb]r7)hXCNCorer8)r9)}r:)(hgUhhj2)ubahkjubaubehkh}ubj9)r;)}r<)(hgUhm}r=)(hr]hq]ho]hp]ht]UcolsKuhhj)hb]r>)(j>)r?)}r@)(hgUhm}rA)(hr]hq]ho]hp]ht]UcolwidthKuhhj;)hb]hkjBubj>)rB)}rC)(hgUhm}rD)(hr]hq]ho]hp]ht]UcolwidthKuhhj;)hb]hkjBubj>)rE)}rF)(hgUhm}rG)(hr]hq]ho]hp]ht]UcolwidthK uhhj;)hb]hkjBubj>)rH)}rI)(hgUhm}rJ)(hr]hq]ho]hp]ht]UcolwidthK uhhj;)hb]hkjBubj>)rK)}rL)(hgUhm}rM)(hr]hq]ho]hp]ht]UcolwidthKuhhj;)hb]hkjBubjO)rN)}rO)(hgUhm}rP)(ho]hp]hq]hr]ht]uhhj;)hb]rQ)jT)rR)}rS)(hgUhm}rT)(ho]hp]hq]hr]ht]uhhjN)hb]rU)(jY)rV)}rW)(hgUhm}rX)(ho]hp]hq]hr]ht]uhhjR)hb]rY)h)rZ)}r[)(hgXTierr\)hhjV)hij)hkhhm}r])(ho]hp]hq]hr]ht]uhvK hb]r^)hXTierr_)r`)}ra)(hgj\)hhjZ)ubaubahkjfubjY)rb)}rc)(hgUhm}rd)(ho]hp]hq]hr]ht]uhhjR)hb]re)h)rf)}rg)(hgXVersionrh)hhjb)hij)hkhhm}ri)(ho]hp]hq]hr]ht]uhvK hb]rj)hXVersionrk)rl)}rm)(hgjh)hhjf)ubaubahkjfubjY)rn)}ro)(hgUhm}rp)(ho]hp]hq]hr]ht]uhhjR)hb]rq)h)rr)}rs)(hgXRESTrt)hhjn)hij)hkhhm}ru)(ho]hp]hq]hr]ht]uhvK hb]rv)hXRESTrw)rx)}ry)(hgjt)hhjr)ubaubahkjfubjY)rz)}r{)(hgUhm}r|)(ho]hp]hq]hr]ht]uhhjR)hb]r})h)r~)}r)(hgXFunctionr)hhjz)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvK hb]r)hXFunctionr)r)}r)(hgj)hhj~)ubaubahkjfubjY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhjR)hb]r)h)r)}r)(hgX Parametersr)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvK hb]r)hX Parametersr)r)}r)(hgj)hhj)ubaubahkjfubehkjubahkjubj)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj;)hb]r)(jT)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)(jY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgXTier 1r)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)hXTier 1r)r)}r)(hgj)hhj)ubaubahkjfubjY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgX 1.0, (2.0)r)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)hX 1.0, (2.0)r)r)}r)(hgj)hhj)ubaubahkjfubjY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgX``GET /monitor/ping``r)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)j)r)}r)(hgj)hm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)hXGET /monitor/pingr)r)}r)(hgUhhj)ubahkjubaubahkjfubjY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgX :func:`ping`r)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)j)r)}r)(hgj)hhj)hij)hkjhm}r)(UreftypeXfuncjjXpingU refdomainXpyr)hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r)j)r)}r)(hgj)hm}r)(ho]hp]r)(jj)Xpy-funcr)ehq]hr]ht]uhhj)hb]r)hXping()r)r)}r)(hgUhhj)ubahkjubaubaubahkjfubjY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgX() ``->`` nullhhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)(hX() r)r)}r)(hgX() hhj)ubj)r)}r)(hgX``->``hm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)hX->r)r)}r)(hgUhhj)ubahkjubhX nullr)r)}r)(hgX nullhhj)ubeubahkjfubehkjubjT)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)(jY)r)}r)(hgUhm}r)(ho]hp]hq]hr]ht]uhhj)hb]r)h)r)}r)(hgXTier 1r)hhj)hij)hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r)hXTier 1r)r)}r)(hgj)hhj)ubaubahkjfubjY)r)}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhj)hb]r*h)r*}r*(hgX1.0, 2.0r*hhj)hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*hX1.0, 2.0r*r*}r *(hgj*hhj*ubaubahkjfubjY)r *}r *(hgUhm}r *(ho]hp]hq]hr]ht]uhhj)hb]r *h)r*}r*(hgX``POST /object``r*hhj *hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*j)r*}r*(hgj*hm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*hX POST /objectr*r*}r*(hgUhhj*ubahkjubaubahkjfubjY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj)hb]r*h)r*}r*(hgX:func:`create`r *hhj*hij)hkhhm}r!*(ho]hp]hq]hr]ht]uhvKhb]r"*j)r#*}r$*(hgj *hhj*hij)hkjhm}r%*(UreftypeXfuncjjXcreateU refdomainXpyr&*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r'*j)r(*}r)*(hgj *hm}r**(ho]hp]r+*(jj&*Xpy-funcr,*ehq]hr]ht]uhhj#*hb]r-*hXcreate()r.*r/*}r0*(hgUhhj(*ubahkjubaubaubahkjfubjY)r1*}r2*(hgUhm}r3*(ho]hp]hq]hr]ht]uhhj)hb]r4*h)r5*}r6*(hgX(:class:`session`, :class:`pid`, ``object``, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hhj1*hij)hkhhm}r7*(ho]hp]hq]hr]ht]uhvKhb]r8*(hX(r9*}r:*(hgX(hhj5*ubj)r;*}r<*(hgX:class:`session`r=*hhj5*hij)hkjhm}r>*(UreftypeXclassjjX Types.SessionU refdomainXpyr?*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r@*j)rA*}rB*(hgj=*hm}rC*(ho]hp]rD*(jj?*Xpy-classrE*ehq]hr]ht]uhhj;*hb]rF*hXsessionrG*rH*}rI*(hgUhhjA*ubahkjubaubhX, rJ*rK*}rL*(hgX, hhj5*ubj)rM*}rN*(hgX:class:`pid`rO*hhj5*hij)hkjhm}rP*(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrQ*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]rR*j)rS*}rT*(hgjO*hm}rU*(ho]hp]rV*(jjQ*Xpy-classrW*ehq]hr]ht]uhhjM*hb]rX*hXpidrY*rZ*}r[*(hgUhhjS*ubahkjubaubhX, r\*r]*}r^*(hgX, hhj5*ubj)r_*}r`*(hgX ``object``hm}ra*(ho]hp]hq]hr]ht]uhhj5*hb]rb*hXobjectrc*rd*}re*(hgUhhj_*ubahkjubhX, rf*rg*}rh*(hgX, hhj5*ubj)ri*}rj*(hgX&:class:`sysmeta`rk*hhj5*hij)hkjhm}rl*(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrm*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]rn*j)ro*}rp*(hgjk*hm}rq*(ho]hp]rr*(jjm*Xpy-classrs*ehq]hr]ht]uhhji*hb]rt*hXsysmetaru*rv*}rw*(hgUhhjo*ubahkjubaubhX) rx*ry*}rz*(hgX) hhj5*ubj)r{*}r|*(hgX``->``hm}r}*(ho]hp]hq]hr]ht]uhhj5*hb]r~*hX->r*r*}r*(hgUhhj{*ubahkjubhX r*}r*(hgX hhj5*ubj)r*}r*(hgX:class:`Types.Identifier`r*hhj5*hij)hkjhm}r*(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r*j)r*}r*(hgj*hm}r*(ho]hp]r*(jj*Xpy-classr*ehq]hr]ht]uhhj*hb]r*hXTypes.Identifierr*r*}r*(hgUhhj*ubahkjubaubeubahkjfubehkjubjT)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj)hb]r*(jY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*h)r*}r*(hgXTier 1r*hhj*hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*hXTier 1r*r*}r*(hgj*hhj*ubaubahkjfubjY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*h)r*}r*(hgX1.0, 2.0r*hhj*hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*hX1.0, 2.0r*r*}r*(hgj*hhj*ubaubahkjfubjY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*h)r*}r*(hgX``GET /formats``r*hhj*hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*j)r*}r*(hgj*hm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*hX GET /formatsr*r*}r*(hgUhhj*ubahkjubaubahkjfubjY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*h)r*}r*(hgX:func:`listFormats`r*hhj*hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*j)r*}r*(hgj*hhj*hij)hkjhm}r*(UreftypeXfuncjjX listFormatsU refdomainXpyr*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r*j)r*}r*(hgj*hm}r*(ho]hp]r*(jj*Xpy-funcr*ehq]hr]ht]uhhj*hb]r*hX listFormats()r*r*}r*(hgUhhj*ubahkjubaubaubahkjfubjY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*h)r*}r*(hgX)() ``->`` :class:`Types.ObjectFormatList`hhj*hij)hkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r*(hX() r*r*}r*(hgX() hhj*ubj)r*}r*(hgX``->``hm}r*(ho]hp]hq]hr]ht]uhhj*hb]r*hX->r*r*}r*(hgUhhj*ubahkjubhX r*}r*(hgX hhj*ubj)r*}r*(hgX:class:`Types.ObjectFormatList`r*hhj*hij)hkjhm}r*(UreftypeXclassjjXTypes.ObjectFormatListU refdomainXpyr*hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r*j)r*}r*(hgj*hm}r*(ho]hp]r*(jj*Xpy-classr*ehq]hr]ht]uhhj*hb]r*hXTypes.ObjectFormatListr*r*}r*(hgUhhj*ubahkjubaubeubahkjfubehkjubjT)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj)hb]r*(jY)r*}r*(hgUhm}r*(ho]hp]hq]hr]ht]uhhj*hb]r+h)r+}r+(hgXTier 1r+hhj*hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvKhb]r+hXTier 1r+r+}r+(hgj+hhj+ubaubahkjfubjY)r +}r +(hgUhm}r +(ho]hp]hq]hr]ht]uhhj*hb]r +h)r +}r+(hgX1.0, 2.0r+hhj +hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvKhb]r+hX1.0, 2.0r+r+}r+(hgj+hhj +ubaubahkjfubjY)r+}r+(hgUhm}r+(ho]hp]hq]hr]ht]uhhj*hb]r+h)r+}r+(hgX``GET /formats/{formatId}``r+hhj+hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvKhb]r+j)r+}r+(hgj+hm}r +(ho]hp]hq]hr]ht]uhhj+hb]r!+hXGET /formats/{formatId}r"+r#+}r$+(hgUhhj+ubahkjubaubahkjfubjY)r%+}r&+(hgUhm}r'+(ho]hp]hq]hr]ht]uhhj*hb]r(+h)r)+}r*+(hgX:func:`getFormat`r++hhj%+hij)hkhhm}r,+(ho]hp]hq]hr]ht]uhvK hb]r-+j)r.+}r/+(hgj++hhj)+hij)hkjhm}r0+(UreftypeXfuncjjX getFormatU refdomainXpyr1+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK hb]r2+j)r3+}r4+(hgj++hm}r5+(ho]hp]r6+(jj1+Xpy-funcr7+ehq]hr]ht]uhhj.+hb]r8+hX getFormat()r9+r:+}r;+(hgUhhj3+ubahkjubaubaubahkjfubjY)r<+}r=+(hgUhm}r>+(ho]hp]hq]hr]ht]uhhj*hb]r?+h)r@+}rA+(hgXT(:class:`formatId`) ``->`` :class:`Types.ObjectFormat`hhj<+hij)hkhhm}rB+(ho]hp]hq]hr]ht]uhvK!hb]rC+(hX(rD+}rE+(hgX(hhj@+ubj)rF+}rG+(hgX/:class:`formatId`rH+hhj@+hij)hkjhm}rI+(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrJ+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK!hb]rK+j)rL+}rM+(hgjH+hm}rN+(ho]hp]rO+(jjJ+Xpy-classrP+ehq]hr]ht]uhhjF+hb]rQ+hXformatIdrR+rS+}rT+(hgUhhjL+ubahkjubaubhX) rU+rV+}rW+(hgX) hhj@+ubj)rX+}rY+(hgX``->``hm}rZ+(ho]hp]hq]hr]ht]uhhj@+hb]r[+hX->r\+r]+}r^+(hgUhhjX+ubahkjubhX r_+}r`+(hgX hhj@+ubj)ra+}rb+(hgX:class:`Types.ObjectFormat`rc+hhj@+hij)hkjhm}rd+(UreftypeXclassjjXTypes.ObjectFormatU refdomainXpyre+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK!hb]rf+j)rg+}rh+(hgjc+hm}ri+(ho]hp]rj+(jje+Xpy-classrk+ehq]hr]ht]uhhja+hb]rl+hXTypes.ObjectFormatrm+rn+}ro+(hgUhhjg+ubahkjubaubeubahkjfubehkjubjT)rp+}rq+(hgUhm}rr+(ho]hp]hq]hr]ht]uhhj)hb]rs+(jY)rt+}ru+(hgUhm}rv+(ho]hp]hq]hr]ht]uhhjp+hb]rw+h)rx+}ry+(hgXTier 1rz+hhjt+hij)hkhhm}r{+(ho]hp]hq]hr]ht]uhvK"hb]r|+hXTier 1r}+r~+}r+(hgjz+hhjx+ubaubahkjfubjY)r+}r+(hgUhm}r+(ho]hp]hq]hr]ht]uhhjp+hb]r+h)r+}r+(hgX1.0, 2.0r+hhj+hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvK#hb]r+hX1.0, 2.0r+r+}r+(hgj+hhj+ubaubahkjfubjY)r+}r+(hgUhm}r+(ho]hp]hq]hr]ht]uhhjp+hb]r+h)r+}r+(hgXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``r+hhj+hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvK$hb]r+j)r+}r+(hgj+hm}r+(ho]hp]hq]hr]ht]uhhj+hb]r+hXvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]r+r+}r+(hgUhhj+ubahkjubaubahkjfubjY)r+}r+(hgUhm}r+(ho]hp]hq]hr]ht]uhhjp+hb]r+h)r+}r+(hgX:func:`getLogRecords`r+hhj+hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvK%hb]r+j)r+}r+(hgj+hhj+hij)hkjhm}r+(UreftypeXfuncjjX getLogRecordsU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK%hb]r+j)r+}r+(hgj+hm}r+(ho]hp]r+(jj+Xpy-funcr+ehq]hr]ht]uhhj+hb]r+hXgetLogRecords()r+r+}r+(hgUhhj+ubahkjubaubaubahkjfubjY)r+}r+(hgUhm}r+(ho]hp]hq]hr]ht]uhhjp+hb]r+h)r+}r+(hgX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[event]`, ``[idFilter]``, ``[start]``, ``[count]``) ``->`` :class:`Types.Log`hhj+hij)hkhhm}r+(ho]hp]hq]hr]ht]uhvK&hb]r+(hX(r+}r+(hgX(hhj+ubj)r+}r+(hgX:class:`session`r+hhj+hij)hkjhm}r+(UreftypeXclassjjX Types.SessionU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK&hb]r+j)r+}r+(hgj+hm}r+(ho]hp]r+(jj+Xpy-classr+ehq]hr]ht]uhhj+hb]r+hXsessionr+r+}r+(hgUhhj+ubahkjubaubhX, r+r+}r+(hgX, hhj+ubj)r+}r+(hgX#:class:`[fromDate]`r+hhj+hij)hkjhm}r+(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK&hb]r+j)r+}r+(hgj+hm}r+(ho]hp]r+(jj+Xpy-classr+ehq]hr]ht]uhhj+hb]r+hX [fromDate]r+r+}r+(hgUhhj+ubahkjubaubhX, r+r+}r+(hgX, hhj+ubj)r+}r+(hgX!:class:`[toDate]`r+hhj+hij)hkjhm}r+(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK&hb]r+j)r+}r+(hgj+hm}r+(ho]hp]r+(jj+Xpy-classr+ehq]hr]ht]uhhj+hb]r+hX[toDate]r+r+}r+(hgUhhj+ubahkjubaubhX, r+r+}r+(hgX, hhj+ubj)r+}r+(hgX%:class:`[event]`r+hhj+hij)hkjhm}r+(UreftypeXclassjjXTypes.Event, stringU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK&hb]r+j)r+}r+(hgj+hm}r+(ho]hp]r+(jj+Xpy-classr+ehq]hr]ht]uhhj+hb]r+hX[event]r+r,}r,(hgUhhj+ubahkjubaubhX, r,r,}r,(hgX, hhj+ubj)r,}r,(hgX``[idFilter]``hm}r,(ho]hp]hq]hr]ht]uhhj+hb]r,hX [idFilter]r ,r ,}r ,(hgUhhj,ubahkjubhX, r ,r ,}r,(hgX, hhj+ubj)r,}r,(hgX ``[start]``hm}r,(ho]hp]hq]hr]ht]uhhj+hb]r,hX[start]r,r,}r,(hgUhhj,ubahkjubhX, r,r,}r,(hgX, hhj+ubj)r,}r,(hgX ``[count]``hm}r,(ho]hp]hq]hr]ht]uhhj+hb]r,hX[count]r,r,}r,(hgUhhj,ubahkjubhX) r ,r!,}r",(hgX) hhj+ubj)r#,}r$,(hgX``->``hm}r%,(ho]hp]hq]hr]ht]uhhj+hb]r&,hX->r',r(,}r),(hgUhhj#,ubahkjubhX r*,}r+,(hgX hhj+ubj)r,,}r-,(hgX:class:`Types.Log`r.,hhj+hij)hkjhm}r/,(UreftypeXclassjjX Types.LogU refdomainXpyr0,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK&hb]r1,j)r2,}r3,(hgj.,hm}r4,(ho]hp]r5,(jj0,Xpy-classr6,ehq]hr]ht]uhhj,,hb]r7,hX Types.Logr8,r9,}r:,(hgUhhj2,ubahkjubaubeubahkjfubehkjubjT)r;,}r<,(hgUhm}r=,(ho]hp]hq]hr]ht]uhhj)hb]r>,(jY)r?,}r@,(hgUhm}rA,(ho]hp]hq]hr]ht]uhhj;,hb]rB,h)rC,}rD,(hgXTier 1rE,hhj?,hij)hkhhm}rF,(ho]hp]hq]hr]ht]uhvK'hb]rG,hXTier 1rH,rI,}rJ,(hgjE,hhjC,ubaubahkjfubjY)rK,}rL,(hgUhm}rM,(ho]hp]hq]hr]ht]uhhj;,hb]rN,h)rO,}rP,(hgX1.0, 2.0rQ,hhjK,hij)hkhhm}rR,(ho]hp]hq]hr]ht]uhvK(hb]rS,hX1.0, 2.0rT,rU,}rV,(hgjQ,hhjO,ubaubahkjfubjY)rW,}rX,(hgUhm}rY,(ho]hp]hq]hr]ht]uhhj;,hb]rZ,h)r[,}r\,(hgX``POST /reserve``r],hhjW,hij)hkhhm}r^,(ho]hp]hq]hr]ht]uhvK)hb]r_,j)r`,}ra,(hgj],hm}rb,(ho]hp]hq]hr]ht]uhhj[,hb]rc,hX POST /reserverd,re,}rf,(hgUhhj`,ubahkjubaubahkjfubjY)rg,}rh,(hgUhm}ri,(ho]hp]hq]hr]ht]uhhj;,hb]rj,h)rk,}rl,(hgX:func:`reserveIdentifier`rm,hhjg,hij)hkhhm}rn,(ho]hp]hq]hr]ht]uhvK*hb]ro,j)rp,}rq,(hgjm,hhjk,hij)hkjhm}rr,(UreftypeXfuncjjXreserveIdentifierU refdomainXpyrs,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK*hb]rt,j)ru,}rv,(hgjm,hm}rw,(ho]hp]rx,(jjs,Xpy-funcry,ehq]hr]ht]uhhjp,hb]rz,hXreserveIdentifier()r{,r|,}r},(hgUhhju,ubahkjubaubaubahkjfubjY)r~,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj;,hb]r,h)r,}r,(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhj~,hij)hkhhm}r,(ho]hp]hq]hr]ht]uhvK+hb]r,(hX(r,}r,(hgX(hhj,ubj)r,}r,(hgX:class:`session`r,hhj,hij)hkjhm}r,(UreftypeXclassjjX Types.SessionU refdomainXpyr,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK+hb]r,j)r,}r,(hgj,hm}r,(ho]hp]r,(jj,Xpy-classr,ehq]hr]ht]uhhj,hb]r,hXsessionr,r,}r,(hgUhhj,ubahkjubaubhX, r,r,}r,(hgX, hhj,ubj)r,}r,(hgX:class:`id`r,hhj,hij)hkjhm}r,(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK+hb]r,j)r,}r,(hgj,hm}r,(ho]hp]r,(jj,Xpy-classr,ehq]hr]ht]uhhj,hb]r,hXidr,r,}r,(hgUhhj,ubahkjubaubhX) r,r,}r,(hgX) hhj,ubj)r,}r,(hgX``->``hm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,hX->r,r,}r,(hgUhhj,ubahkjubhX r,}r,(hgX hhj,ubj)r,}r,(hgX:class:`Types.Identifier`r,hhj,hij)hkjhm}r,(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK+hb]r,j)r,}r,(hgj,hm}r,(ho]hp]r,(jj,Xpy-classr,ehq]hr]ht]uhhj,hb]r,hXTypes.Identifierr,r,}r,(hgUhhj,ubahkjubaubeubahkjfubehkjubjT)r,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj)hb]r,(jY)r,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,h)r,}r,(hgXTier 1r,hhj,hij)hkhhm}r,(ho]hp]hq]hr]ht]uhvK,hb]r,hXTier 1r,r,}r,(hgj,hhj,ubaubahkjfubjY)r,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,h)r,}r,(hgX 1.0, (2.0)r,hhj,hij)hkhhm}r,(ho]hp]hq]hr]ht]uhvK-hb]r,hX 1.0, (2.0)r,r,}r,(hgj,hhj,ubaubahkjfubjY)r,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,h)r,}r,(hgX``POST /generate``r,hhj,hij)hkhhm}r,(ho]hp]hq]hr]ht]uhvK.hb]r,j)r,}r,(hgj,hm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,hXPOST /generater,r,}r,(hgUhhj,ubahkjubaubahkjfubjY)r,}r,(hgUhm}r,(ho]hp]hq]hr]ht]uhhj,hb]r,h)r,}r,(hgX:func:`generateIdentifier`r,hhj,hij)hkhhm}r,(ho]hp]hq]hr]ht]uhvK/hb]r,j)r,}r,(hgj,hhj,hij)hkjhm}r,(UreftypeXfuncjjXgenerateIdentifierU refdomainXpyr,hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK/hb]r,j)r,}r,(hgj,hm}r-(ho]hp]r-(jj,Xpy-funcr-ehq]hr]ht]uhhj,hb]r-hXgenerateIdentifier()r-r-}r-(hgUhhj,ubahkjubaubaubahkjfubjY)r-}r-(hgUhm}r -(ho]hp]hq]hr]ht]uhhj,hb]r -h)r -}r -(hgX^(:class:`session`, ``scheme``, ``[fragment]``) ``->`` :class:`Types.Identifier`hhj-hij)hkhhm}r -(ho]hp]hq]hr]ht]uhvK0hb]r-(hX(r-}r-(hgX(hhj -ubj)r-}r-(hgX:class:`session`r-hhj -hij)hkjhm}r-(UreftypeXclassjjX Types.SessionU refdomainXpyr-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK0hb]r-j)r-}r-(hgj-hm}r-(ho]hp]r-(jj-Xpy-classr-ehq]hr]ht]uhhj-hb]r-hXsessionr-r-}r-(hgUhhj-ubahkjubaubhX, r -r!-}r"-(hgX, hhj -ubj)r#-}r$-(hgX ``scheme``hm}r%-(ho]hp]hq]hr]ht]uhhj -hb]r&-hXschemer'-r(-}r)-(hgUhhj#-ubahkjubhX, r*-r+-}r,-(hgX, hhj -ubj)r--}r.-(hgX``[fragment]``hm}r/-(ho]hp]hq]hr]ht]uhhj -hb]r0-hX [fragment]r1-r2-}r3-(hgUhhj--ubahkjubhX) r4-r5-}r6-(hgX) hhj -ubj)r7-}r8-(hgX``->``hm}r9-(ho]hp]hq]hr]ht]uhhj -hb]r:-hX->r;-r<-}r=-(hgUhhj7-ubahkjubhX r>-}r?-(hgX hhj -ubj)r@-}rA-(hgX:class:`Types.Identifier`rB-hhj -hij)hkjhm}rC-(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrD-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK0hb]rE-j)rF-}rG-(hgjB-hm}rH-(ho]hp]rI-(jjD-Xpy-classrJ-ehq]hr]ht]uhhj@-hb]rK-hXTypes.IdentifierrL-rM-}rN-(hgUhhjF-ubahkjubaubeubahkjfubehkjubjT)rO-}rP-(hgUhm}rQ-(ho]hp]hq]hr]ht]uhhj)hb]rR-(jY)rS-}rT-(hgUhm}rU-(ho]hp]hq]hr]ht]uhhjO-hb]rV-h)rW-}rX-(hgXTier 1rY-hhjS-hij)hkhhm}rZ-(ho]hp]hq]hr]ht]uhvK1hb]r[-hXTier 1r\-r]-}r^-(hgjY-hhjW-ubaubahkjfubjY)r_-}r`-(hgUhm}ra-(ho]hp]hq]hr]ht]uhhjO-hb]rb-h)rc-}rd-(hgX 1.0, (2.0)re-hhj_-hij)hkhhm}rf-(ho]hp]hq]hr]ht]uhvK2hb]rg-hX 1.0, (2.0)rh-ri-}rj-(hgje-hhjc-ubaubahkjfubjY)rk-}rl-(hgUhm}rm-(ho]hp]hq]hr]ht]uhhjO-hb]rn-h)ro-}rp-(hgX``GET /checksum``rq-hhjk-hij)hkhhm}rr-(ho]hp]hq]hr]ht]uhvK3hb]rs-j)rt-}ru-(hgjq-hm}rv-(ho]hp]hq]hr]ht]uhhjo-hb]rw-hX GET /checksumrx-ry-}rz-(hgUhhjt-ubahkjubaubahkjfubjY)r{-}r|-(hgUhm}r}-(ho]hp]hq]hr]ht]uhhjO-hb]r~-h)r-}r-(hgX:func:`listChecksumAlgorithms`r-hhj{-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK4hb]r-j)r-}r-(hgj-hhj-hij)hkjhm}r-(UreftypeXfuncjjXlistChecksumAlgorithmsU refdomainXpyr-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK4hb]r-j)r-}r-(hgj-hm}r-(ho]hp]r-(jj-Xpy-funcr-ehq]hr]ht]uhhj-hb]r-hXlistChecksumAlgorithms()r-r-}r-(hgUhhj-ubahkjubaubaubahkjfubjY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhjO-hb]r-h)r-}r-(hgX.() ``->`` :class:`Types.ChecksumAlgorithmList`hhj-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK5hb]r-(hX() r-r-}r-(hgX() hhj-ubj)r-}r-(hgX``->``hm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-hX->r-r-}r-(hgUhhj-ubahkjubhX r-}r-(hgX hhj-ubj)r-}r-(hgX$:class:`Types.ChecksumAlgorithmList`r-hhj-hij)hkjhm}r-(UreftypeXclassjjXTypes.ChecksumAlgorithmListU refdomainXpyr-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK5hb]r-j)r-}r-(hgj-hm}r-(ho]hp]r-(jj-Xpy-classr-ehq]hr]ht]uhhj-hb]r-hXTypes.ChecksumAlgorithmListr-r-}r-(hgUhhj-ubahkjubaubeubahkjfubehkjubjT)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj)hb]r-(jY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj-hb]hkjfubjY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-h)r-}r-(hgX1.0, 2.0r-hhj-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK7hb]r-hX1.0, 2.0r-r-}r-(hgj-hhj-ubaubahkjfubjY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-h)r-}r-(hgX``PUT /obsoletedBy/{pid}``r-hhj-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK8hb]r-j)r-}r-(hgj-hm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-hXPUT /obsoletedBy/{pid}r-r-}r-(hgUhhj-ubahkjubaubahkjfubjY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-h)r-}r-(hgX:func:`setObsoletedBy`r-hhj-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK9hb]r-j)r-}r-(hgj-hhj-hij)hkjhm}r-(UreftypeXfuncjjXsetObsoletedByU refdomainXpyr-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK9hb]r-j)r-}r-(hgj-hm}r-(ho]hp]r-(jj-Xpy-funcr-ehq]hr]ht]uhhj-hb]r-hXsetObsoletedBy()r-r-}r-(hgUhhj-ubahkjubaubaubahkjfubjY)r-}r-(hgUhm}r-(ho]hp]hq]hr]ht]uhhj-hb]r-h)r-}r-(hgX(:class:`session`, :class:`pid`, :class:`obsoletedByPid`, ``serialVersion``) ``->`` booleanhhj-hij)hkhhm}r-(ho]hp]hq]hr]ht]uhvK:hb]r-(hX(r-}r-(hgX(hhj-ubj)r-}r-(hgX:class:`session`r-hhj-hij)hkjhm}r-(UreftypeXclassjjX Types.SessionU refdomainXpyr-hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK:hb]r-j)r-}r.(hgj-hm}r.(ho]hp]r.(jj-Xpy-classr.ehq]hr]ht]uhhj-hb]r.hXsessionr.r.}r.(hgUhhj-ubahkjubaubhX, r.r .}r .(hgX, hhj-ubj)r .}r .(hgX:class:`pid`r .hhj-hij)hkjhm}r.(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK:hb]r.j)r.}r.(hgj .hm}r.(ho]hp]r.(jj.Xpy-classr.ehq]hr]ht]uhhj .hb]r.hXpidr.r.}r.(hgUhhj.ubahkjubaubhX, r.r.}r.(hgX, hhj-ubj)r.}r.(hgX):class:`obsoletedByPid`r.hhj-hij)hkjhm}r .(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr!.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK:hb]r".j)r#.}r$.(hgj.hm}r%.(ho]hp]r&.(jj!.Xpy-classr'.ehq]hr]ht]uhhj.hb]r(.hXobsoletedByPidr).r*.}r+.(hgUhhj#.ubahkjubaubhX, r,.r-.}r..(hgX, hhj-ubj)r/.}r0.(hgX``serialVersion``hm}r1.(ho]hp]hq]hr]ht]uhhj-hb]r2.hX serialVersionr3.r4.}r5.(hgUhhj/.ubahkjubhX) r6.r7.}r8.(hgX) hhj-ubj)r9.}r:.(hgX``->``hm}r;.(ho]hp]hq]hr]ht]uhhj-hb]r<.hX->r=.r>.}r?.(hgUhhj9.ubahkjubhX booleanr@.rA.}rB.(hgX booleanhhj-ubeubahkjfubehkjubjT)rC.}rD.(hgUhm}rE.(ho]hp]hq]hr]ht]uhhj)hb]rF.(jY)rG.}rH.(hgUhm}rI.(ho]hp]hq]hr]ht]uhhjC.hb]rJ.h)rK.}rL.(hgXTier 3rM.hhjG.hij)hkhhm}rN.(ho]hp]hq]hr]ht]uhvK;hb]rO.hXTier 3rP.rQ.}rR.(hgjM.hhjK.ubaubahkjfubjY)rS.}rT.(hgUhm}rU.(ho]hp]hq]hr]ht]uhhjC.hb]rV.h)rW.}rX.(hgX 1.0, (2.0)rY.hhjS.hij)hkhhm}rZ.(ho]hp]hq]hr]ht]uhvKhb]rw.j)rx.}ry.(hgju.hhjs.hij)hkjhm}rz.(UreftypeXfuncjjXdeleteU refdomainXpyr{.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK>hb]r|.j)r}.}r~.(hgju.hm}r.(ho]hp]r.(jj{.Xpy-funcr.ehq]hr]ht]uhhjx.hb]r.hXdelete()r.r.}r.(hgUhhj}.ubahkjubaubaubahkjfubjY)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhjC.hb]r.h)r.}r.(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhj.hij)hkhhm}r.(ho]hp]hq]hr]ht]uhvK?hb]r.(hX(r.}r.(hgX(hhj.ubj)r.}r.(hgX:class:`session`r.hhj.hij)hkjhm}r.(UreftypeXclassjjX Types.SessionU refdomainXpyr.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK?hb]r.j)r.}r.(hgj.hm}r.(ho]hp]r.(jj.Xpy-classr.ehq]hr]ht]uhhj.hb]r.hXsessionr.r.}r.(hgUhhj.ubahkjubaubhX, r.r.}r.(hgX, hhj.ubj)r.}r.(hgX:class:`id`r.hhj.hij)hkjhm}r.(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK?hb]r.j)r.}r.(hgj.hm}r.(ho]hp]r.(jj.Xpy-classr.ehq]hr]ht]uhhj.hb]r.hXidr.r.}r.(hgUhhj.ubahkjubaubhX) r.r.}r.(hgX) hhj.ubj)r.}r.(hgX``->``hm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.hX->r.r.}r.(hgUhhj.ubahkjubhX r.}r.(hgX hhj.ubj)r.}r.(hgX:class:`Types.Identifier`r.hhj.hij)hkjhm}r.(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr.hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK?hb]r.j)r.}r.(hgj.hm}r.(ho]hp]r.(jj.Xpy-classr.ehq]hr]ht]uhhj.hb]r.hXTypes.Identifierr.r.}r.(hgUhhj.ubahkjubaubeubahkjfubehkjubjT)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhj)hb]r.(jY)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.h)r.}r.(hgXTier 3r.hhj.hij)hkhhm}r.(ho]hp]hq]hr]ht]uhvK@hb]r.hXTier 3r.r.}r.(hgj.hhj.ubaubahkjfubjY)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.h)r.}r.(hgX1.0, 2.0r.hhj.hij)hkhhm}r.(ho]hp]hq]hr]ht]uhvKAhb]r.hX1.0, 2.0r.r.}r.(hgj.hhj.ubaubahkjfubjY)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.h)r.}r.(hgX``PUT /archive/{id}``r.hhj.hij)hkhhm}r.(ho]hp]hq]hr]ht]uhvKBhb]r.j)r.}r.(hgj.hm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.hXPUT /archive/{id}r.r.}r.(hgUhhj.ubahkjubaubahkjfubjY)r.}r.(hgUhm}r.(ho]hp]hq]hr]ht]uhhj.hb]r.h)r.}r.(hgX:func:`archive`r.hhj.hij)hkhhm}r.(ho]hp]hq]hr]ht]uhvKChb]r/j)r/}r/(hgj.hhj.hij)hkjhm}r/(UreftypeXfuncjjXarchiveU refdomainXpyr/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKChb]r/j)r/}r/(hgj.hm}r/(ho]hp]r /(jj/Xpy-funcr /ehq]hr]ht]uhhj/hb]r /hX archive()r /r /}r/(hgUhhj/ubahkjubaubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj.hb]r/h)r/}r/(hgXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKDhb]r/(hX(r/}r/(hgX(hhj/ubj)r/}r/(hgX:class:`session`r/hhj/hij)hkjhm}r/(UreftypeXclassjjX Types.SessionU refdomainXpyr/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKDhb]r/j)r/}r /(hgj/hm}r!/(ho]hp]r"/(jj/Xpy-classr#/ehq]hr]ht]uhhj/hb]r$/hXsessionr%/r&/}r'/(hgUhhj/ubahkjubaubhX, r(/r)/}r*/(hgX, hhj/ubj)r+/}r,/(hgX:class:`id`r-/hhj/hij)hkjhm}r./(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr//hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKDhb]r0/j)r1/}r2/(hgj-/hm}r3/(ho]hp]r4/(jj//Xpy-classr5/ehq]hr]ht]uhhj+/hb]r6/hXidr7/r8/}r9/(hgUhhj1/ubahkjubaubhX) r:/r;/}r/(hgX``->``hm}r?/(ho]hp]hq]hr]ht]uhhj/hb]r@/hX->rA/rB/}rC/(hgUhhj=/ubahkjubhX rD/}rE/(hgX hhj/ubj)rF/}rG/(hgX:class:`Types.Identifier`rH/hhj/hij)hkjhm}rI/(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrJ/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKDhb]rK/j)rL/}rM/(hgjH/hm}rN/(ho]hp]rO/(jjJ/Xpy-classrP/ehq]hr]ht]uhhjF/hb]rQ/hXTypes.IdentifierrR/rS/}rT/(hgUhhjL/ubahkjubaubeubahkjfubehkjubjT)rU/}rV/(hgUhm}rW/(ho]hp]hq]hr]ht]uhhj)hb]rX/(jY)rY/}rZ/(hgUhm}r[/(ho]hp]hq]hr]ht]uhhjU/hb]r\/h)r]/}r^/(hgXTier 1r_/hhjY/hij)hkhhm}r`/(ho]hp]hq]hr]ht]uhvKEhb]ra/hXTier 1rb/rc/}rd/(hgj_/hhj]/ubaubahkjfubjY)re/}rf/(hgUhm}rg/(ho]hp]hq]hr]ht]uhhjU/hb]rh/h)ri/}rj/(hgX1.0, 2.0rk/hhje/hij)hkhhm}rl/(ho]hp]hq]hr]ht]uhvKFhb]rm/hX1.0, 2.0rn/ro/}rp/(hgjk/hhji/ubaubahkjfubjY)rq/}rr/(hgUhm}rs/(ho]hp]hq]hr]ht]uhhjU/hb]rt/h)ru/}rv/(hgX ``GET /node``rw/hhjq/hij)hkhhm}rx/(ho]hp]hq]hr]ht]uhvKGhb]ry/j)rz/}r{/(hgjw/hm}r|/(ho]hp]hq]hr]ht]uhhju/hb]r}/hX GET /noder~/r/}r/(hgUhhjz/ubahkjubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhjU/hb]r/h)r/}r/(hgX:func:`listNodes`r/hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKHhb]r/j)r/}r/(hgj/hhj/hij)hkjhm}r/(UreftypeXfuncjjX listNodesU refdomainXpyr/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKHhb]r/j)r/}r/(hgj/hm}r/(ho]hp]r/(jj/Xpy-funcr/ehq]hr]ht]uhhj/hb]r/hX listNodes()r/r/}r/(hgUhhj/ubahkjubaubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhjU/hb]r/h)r/}r/(hgX!() ``->`` :class:`Types.NodeList`hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKIhb]r/(hX() r/r/}r/(hgX() hhj/ubj)r/}r/(hgX``->``hm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/hX->r/r/}r/(hgUhhj/ubahkjubhX r/}r/(hgX hhj/ubj)r/}r/(hgX:class:`Types.NodeList`r/hhj/hij)hkjhm}r/(UreftypeXclassjjXTypes.NodeListU refdomainXpyr/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKIhb]r/j)r/}r/(hgj/hm}r/(ho]hp]r/(jj/Xpy-classr/ehq]hr]ht]uhhj/hb]r/hXTypes.NodeListr/r/}r/(hgUhhj/ubahkjubaubeubahkjfubehkjubjT)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj)hb]r/(jY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/h)r/}r/(hgXTier 1r/hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKJhb]r/hXTier 1r/r/}r/(hgj/hhj/ubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/h)r/}r/(hgX1.0, 2.0r/hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKKhb]r/hX1.0, 2.0r/r/}r/(hgj/hhj/ubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/h)r/}r/(hgX ``GET /``r/hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKLhb]r/j)r/}r/(hgj/hm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/hXGET /r/r/}r/(hgUhhj/ubahkjubaubahkjfubjY)r/}r/(hgUhm}r/(ho]hp]hq]hr]ht]uhhj/hb]r/h)r/}r/(hgX:func:`getCapabilities`r/hhj/hij)hkhhm}r/(ho]hp]hq]hr]ht]uhvKMhb]r/j)r/}r/(hgj/hhj/hij)hkjhm}r/(UreftypeXfuncjjXgetCapabilitiesU refdomainXpyr/hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKMhb]r/j)r/}r/(hgj/hm}r/(ho]hp]r/(jj/Xpy-funcr/ehq]hr]ht]uhhj/hb]r/hXgetCapabilities()r/r/}r/(hgUhhj/ubahkjubaubaubahkjfubjY)r/}r/(hgUhm}r0(ho]hp]hq]hr]ht]uhhj/hb]r0h)r0}r0(hgX() ``->`` :class:`Types.Node`hhj/hij)hkhhm}r0(ho]hp]hq]hr]ht]uhvKNhb]r0(hX() r0r0}r0(hgX() hhj0ubj)r 0}r 0(hgX``->``hm}r 0(ho]hp]hq]hr]ht]uhhj0hb]r 0hX->r 0r0}r0(hgUhhj 0ubahkjubhX r0}r0(hgX hhj0ubj)r0}r0(hgX:class:`Types.Node`r0hhj0hij)hkjhm}r0(UreftypeXclassjjX Types.NodeU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKNhb]r0j)r0}r0(hgj0hm}r0(ho]hp]r0(jj0Xpy-classr0ehq]hr]ht]uhhj0hb]r0hX Types.Noder0r0}r 0(hgUhhj0ubahkjubaubeubahkjfubehkjubjT)r!0}r"0(hgUhm}r#0(ho]hp]hq]hr]ht]uhhj)hb]r$0(jY)r%0}r&0(hgUhm}r'0(ho]hp]hq]hr]ht]uhhj!0hb]r(0h)r)0}r*0(hgXTier 1r+0hhj%0hij)hkhhm}r,0(ho]hp]hq]hr]ht]uhvKOhb]r-0hXTier 1r.0r/0}r00(hgj+0hhj)0ubaubahkjfubjY)r10}r20(hgUhm}r30(ho]hp]hq]hr]ht]uhhj!0hb]r40h)r50}r60(hgX1.0, 2.0r70hhj10hij)hkhhm}r80(ho]hp]hq]hr]ht]uhvKPhb]r90hX1.0, 2.0r:0r;0}r<0(hgj70hhj50ubaubahkjfubjY)r=0}r>0(hgUhm}r?0(ho]hp]hq]hr]ht]uhhj!0hb]r@0h)rA0}rB0(hgX``POST /meta``rC0hhj=0hij)hkhhm}rD0(ho]hp]hq]hr]ht]uhvKQhb]rE0j)rF0}rG0(hgjC0hm}rH0(ho]hp]hq]hr]ht]uhhjA0hb]rI0hX POST /metarJ0rK0}rL0(hgUhhjF0ubahkjubaubahkjfubjY)rM0}rN0(hgUhm}rO0(ho]hp]hq]hr]ht]uhhj!0hb]rP0h)rQ0}rR0(hgX:func:`registerSystemMetadata`rS0hhjM0hij)hkhhm}rT0(ho]hp]hq]hr]ht]uhvKRhb]rU0j)rV0}rW0(hgjS0hhjQ0hij)hkjhm}rX0(UreftypeXfuncjjXregisterSystemMetadataU refdomainXpyrY0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKRhb]rZ0j)r[0}r\0(hgjS0hm}r]0(ho]hp]r^0(jjY0Xpy-funcr_0ehq]hr]ht]uhhjV0hb]r`0hXregisterSystemMetadata()ra0rb0}rc0(hgUhhj[0ubahkjubaubaubahkjfubjY)rd0}re0(hgUhm}rf0(ho]hp]hq]hr]ht]uhhj!0hb]rg0h)rh0}ri0(hgX(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hhjd0hij)hkhhm}rj0(ho]hp]hq]hr]ht]uhvKShb]rk0(hX(rl0}rm0(hgX(hhjh0ubj)rn0}ro0(hgX:class:`session`rp0hhjh0hij)hkjhm}rq0(UreftypeXclassjjX Types.SessionU refdomainXpyrr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKShb]rs0j)rt0}ru0(hgjp0hm}rv0(ho]hp]rw0(jjr0Xpy-classrx0ehq]hr]ht]uhhjn0hb]ry0hXsessionrz0r{0}r|0(hgUhhjt0ubahkjubaubhX, r}0r~0}r0(hgX, hhjh0ubj)r0}r0(hgX:class:`pid`r0hhjh0hij)hkjhm}r0(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKShb]r0j)r0}r0(hgj0hm}r0(ho]hp]r0(jj0Xpy-classr0ehq]hr]ht]uhhj0hb]r0hXpidr0r0}r0(hgUhhj0ubahkjubaubhX, r0r0}r0(hgX, hhjh0ubj)r0}r0(hgX&:class:`sysmeta`r0hhjh0hij)hkjhm}r0(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKShb]r0j)r0}r0(hgj0hm}r0(ho]hp]r0(jj0Xpy-classr0ehq]hr]ht]uhhj0hb]r0hXsysmetar0r0}r0(hgUhhj0ubahkjubaubhX) r0r0}r0(hgX) hhjh0ubj)r0}r0(hgX``->``hm}r0(ho]hp]hq]hr]ht]uhhjh0hb]r0hX->r0r0}r0(hgUhhj0ubahkjubhX r0}r0(hgX hhjh0ubj)r0}r0(hgX:class:`Types.Identifier`r0hhjh0hij)hkjhm}r0(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKShb]r0j)r0}r0(hgj0hm}r0(ho]hp]r0(jj0Xpy-classr0ehq]hr]ht]uhhj0hb]r0hXTypes.Identifierr0r0}r0(hgUhhj0ubahkjubaubeubahkjfubehkjubjT)r0}r0(hgUhm}r0(ho]hp]hq]hr]ht]uhhj)hb]r0(jY)r0}r0(hgUhm}r0(ho]hp]hq]hr]ht]uhhj0hb]r0h)r0}r0(hgXTier 1r0hhj0hij)hkhhm}r0(ho]hp]hq]hr]ht]uhvKThb]r0hXTier 1r0r0}r0(hgj0hhj0ubaubahkjfubjY)r0}r0(hgUhm}r0(ho]hp]hq]hr]ht]uhhj0hb]r0h)r0}r0(hgX2.0r0hhj0hij)hkhhm}r0(ho]hp]hq]hr]ht]uhvKUhb]r0hX2.0r0r0}r0(hgj0hhj0ubaubahkjfubjY)r0}r0(hgUhm}r0(ho]hp]hq]hr]ht]uhhj0hb]r0h)r0}r0(hgX ``PUT /meta``r0hhj0hij)hkhhm}r0(ho]hp]hq]hr]ht]uhvKVhb]r0j)r0}r0(hgj0hm}r0(ho]hp]hq]hr]ht]uhhj0hb]r0hX PUT /metar0r0}r0(hgUhhj0ubahkjubaubahkjfubjY)r0}r0(hgUhm}r0(ho]hp]hq]hr]ht]uhhj0hb]r0h)r0}r0(hgX:func:`updateSystemMetadata`r0hhj0hij)hkhhm}r0(ho]hp]hq]hr]ht]uhvKWhb]r0j)r0}r0(hgj0hhj0hij)hkjhm}r0(UreftypeXfuncjjXupdateSystemMetadataU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKWhb]r0j)r0}r0(hgj0hm}r0(ho]hp]r0(jj0Xpy-funcr0ehq]hr]ht]uhhj0hb]r0hXupdateSystemMetadata()r0r0}r0(hgUhhj0ubahkjubaubaubahkjfubjY)r0}r1(hgUhm}r1(ho]hp]hq]hr]ht]uhhj0hb]r1h)r1}r1(hgXx(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` booleanhhj0hij)hkhhm}r1(ho]hp]hq]hr]ht]uhvKXhb]r1(hX(r1}r1(hgX(hhj1ubj)r 1}r 1(hgX:class:`session`r 1hhj1hij)hkjhm}r 1(UreftypeXclassjjX Types.SessionU refdomainXpyr 1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKXhb]r1j)r1}r1(hgj 1hm}r1(ho]hp]r1(jj 1Xpy-classr1ehq]hr]ht]uhhj 1hb]r1hXsessionr1r1}r1(hgUhhj1ubahkjubaubhX, r1r1}r1(hgX, hhj1ubj)r1}r1(hgX:class:`pid`r1hhj1hij)hkjhm}r1(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKXhb]r 1j)r!1}r"1(hgj1hm}r#1(ho]hp]r$1(jj1Xpy-classr%1ehq]hr]ht]uhhj1hb]r&1hXpidr'1r(1}r)1(hgUhhj!1ubahkjubaubhX, r*1r+1}r,1(hgX, hhj1ubj)r-1}r.1(hgX&:class:`sysmeta`r/1hhj1hij)hkjhm}r01(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr11hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKXhb]r21j)r31}r41(hgj/1hm}r51(ho]hp]r61(jj11Xpy-classr71ehq]hr]ht]uhhj-1hb]r81hXsysmetar91r:1}r;1(hgUhhj31ubahkjubaubhX) r<1r=1}r>1(hgX) hhj1ubj)r?1}r@1(hgX``->``hm}rA1(ho]hp]hq]hr]ht]uhhj1hb]rB1hX->rC1rD1}rE1(hgUhhj?1ubahkjubhX booleanrF1rG1}rH1(hgX booleanhhj1ubeubahkjfubehkjubjT)rI1}rJ1(hgUhm}rK1(ho]hp]hq]hr]ht]uhhj)hb]rL1(jY)rM1}rN1(hgUhm}rO1(ho]hp]hq]hr]ht]uhhjI1hb]hkjfubjY)rP1}rQ1(hgUhm}rR1(ho]hp]hq]hr]ht]uhhjI1hb]rS1h)rT1}rU1(hgX1.0, 2.0rV1hhjP1hij)hkhhm}rW1(ho]hp]hq]hr]ht]uhvKZhb]rX1hX1.0, 2.0rY1rZ1}r[1(hgjV1hhjT1ubaubahkjfubjY)r\1}r]1(hgUhm}r^1(ho]hp]hq]hr]ht]uhhjI1hb]r_1h)r`1}ra1(hgX'``GET /reserve/{id}?subject={subject}``rb1hhj\1hij)hkhhm}rc1(ho]hp]hq]hr]ht]uhvK[hb]rd1j)re1}rf1(hgjb1hm}rg1(ho]hp]hq]hr]ht]uhhj`1hb]rh1hX#GET /reserve/{id}?subject={subject}ri1rj1}rk1(hgUhhje1ubahkjubaubahkjfubjY)rl1}rm1(hgUhm}rn1(ho]hp]hq]hr]ht]uhhjI1hb]ro1h)rp1}rq1(hgX:func:`hasReservation`rr1hhjl1hij)hkhhm}rs1(ho]hp]hq]hr]ht]uhvK\hb]rt1j)ru1}rv1(hgjr1hhjp1hij)hkjhm}rw1(UreftypeXfuncjjXhasReservationU refdomainXpyrx1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK\hb]ry1j)rz1}r{1(hgjr1hm}r|1(ho]hp]r}1(jjx1Xpy-funcr~1ehq]hr]ht]uhhju1hb]r1hXhasReservation()r1r1}r1(hgUhhjz1ubahkjubaubaubahkjfubjY)r1}r1(hgUhm}r1(ho]hp]hq]hr]ht]uhhjI1hb]r1h)r1}r1(hgXp(:class:`session`, :class:`subject`, :class:`id`) ``->`` booleanhhj1hij)hkhhm}r1(ho]hp]hq]hr]ht]uhvK]hb]r1(hX(r1}r1(hgX(hhj1ubj)r1}r1(hgX:class:`session`r1hhj1hij)hkjhm}r1(UreftypeXclassjjX Types.SessionU refdomainXpyr1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK]hb]r1j)r1}r1(hgj1hm}r1(ho]hp]r1(jj1Xpy-classr1ehq]hr]ht]uhhj1hb]r1hXsessionr1r1}r1(hgUhhj1ubahkjubaubhX, r1r1}r1(hgX, hhj1ubj)r1}r1(hgX:class:`subject`r1hhj1hij)hkjhm}r1(UreftypeXclassjjX Types.SubjectU refdomainXpyr1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK]hb]r1j)r1}r1(hgj1hm}r1(ho]hp]r1(jj1Xpy-classr1ehq]hr]ht]uhhj1hb]r1hXsubjectr1r1}r1(hgUhhj1ubahkjubaubhX, r1r1}r1(hgX, hhj1ubj)r1}r1(hgX:class:`id`r1hhj1hij)hkjhm}r1(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr1hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvK]hb]r1j)r1}r1(hgj1hm}r1(ho]hp]r1(jj1Xpy-classr1ehq]hr]ht]uhhj1hb]r1hXidr1r1}r1(hgUhhj1ubahkjubaubhX) r1r1}r1(hgX) hhj1ubj)r1}r1(hgX``->``hm}r1(ho]hp]hq]hr]ht]uhhj1hb]r1hX->r1r1}r1(hgUhhj1ubahkjubhX booleanr1r1}r1(hgX booleanhhj1ubeubahkjfubehkjubehkjubehkjubeubj)r1}r1(hgUhhj)hiNhkjhm}r1(hr]hq]ho]hp]ht]Uentries]r1(jXping() (in module CNCore)h nullhhj1hij)hkj "hm}r1(hr]r1h2(ho]hp]hq]hr]ht]uhhj02hb]r?2h)r@2}rA2(hgj=2hhj;2hij)hkhhm}rB2(ho]hp]hq]hr]ht]uhvKnhb]rC2hX 1.0, (2.0)rD2rE2}rF2(hgj=2hhj@2ubaubahkhubeubh)rG2}rH2(hgUhhj,2hij)hkhhm}rI2(ho]hp]hq]hr]ht]uhvKohwhhb]rJ2(h)rK2}rL2(hgX Use CaseshhjG2hij)hkhhm}rM2(ho]hp]hq]hr]ht]uhvKhb]rN2hX Use CasesrO2rP2}rQ2(hgUhhjK2ubaubh)rR2}rS2(hgX$:doc:`UC10 `rT2hm}rU2(ho]hp]hq]hr]ht]uhhjG2hb]rV2h)rW2}rX2(hgjT2hhjR2hij)hkhhm}rY2(ho]hp]hq]hr]ht]uhvKphb]rZ2j)r[2}r\2(hgjT2hhjW2hij)hkjhm}r]2(UreftypeXdocr^2jjX/design/UseCases/10_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKphb]r_2cdocutils.nodes inline r`2)ra2}rb2(hgjT2hm}rc2(ho]hp]rd2(jj^2ehq]hr]ht]uhhj[2hb]re2hXUC10rf2rg2}rh2(hgUhhja2ubahkUinlineri2ubaubaubahkhubeubh)rj2}rk2(hgUhhj,2hij)hkhhm}rl2(ho]hp]hq]hr]ht]uhvKqhwhhb]rm2(h)rn2}ro2(hgXREST URLhhjj2hij)hkhhm}rp2(ho]hp]hq]hr]ht]uhvKhb]rq2hXREST URLrr2rs2}rt2(hgUhhjn2ubaubh)ru2}rv2(hgX``GET /monitor/ping``rw2hm}rx2(ho]hp]hq]hr]ht]uhhjj2hb]ry2h)rz2}r{2(hgjw2hhju2hij)hkhhm}r|2(ho]hp]hq]hr]ht]uhvKqhb]r}2j)r~2}r2(hgjw2hm}r2(ho]hp]hq]hr]ht]uhhjz2hb]r2hXGET /monitor/pingr2r2}r2(hgUhhj~2ubahkjubaubahkhubeubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj,2hb]r2(h)r2}r2(hgXReturnshhj2hij)hkhhm}r2(ho]hp]hq]hr]ht]uhvKhb]r2hXReturnsr2r2}r2(hgUhhj2ubaubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2h)r2}r2(hgX{Null body or Exception. The body of the message is ignored by the caller. The HTTP header Date MUST be set in the response.hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2(hXZNull body or Exception. The body of the message is ignored by the caller. The HTTP header r2r2}r2(hgXZNull body or Exception. The body of the message is ignored by the caller. The HTTP header hhj2ubj$)r2}r2(hgX*Date*hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2hXDater2r2}r2(hgUhhj2ubahkj$ubhX MUST be set in the response.r2r2}r2(hgX MUST be set in the response.hhj2ubehkhubahkhubehkhubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj,2hb]r2(h)r2}r2(hgX Return typehhj2hij)hkhhm}r2(ho]hp]hq]hr]ht]uhvKhb]r2hX Return typer2r2}r2(hgUhhj2ubaubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2h)r2}r2(hgXnullhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2j)r2}r2(hgUhm}r2(Ureftypej&j"U reftargetXnullU refdomainj1hr]hq]U refexplicitho]hp]ht]uhhj2hb]r2hXnullr2r2}r2(hgUhhj2ubahkjubahkhubahkhubehkhubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj,2hb]r2(h)r2}r2(hgXRaiseshhj2hij)hkhhm}r2(ho]hp]hq]hr]ht]uhvKhb]r2hXRaisesr2r2}r2(hgUhhj2ubaubh)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2j #)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2(j#)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2h)r2}r2(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2041)hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2(j)r2}r2(hgUhm}r2(Ureftypej#j"U reftargetXExceptions.NotImplementedr2U refdomainj1hr]hq]U refexplicitho]hp]ht]uhhj2hb]r2j")r2}r2(hgj2hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2hXExceptions.NotImplementedr2r2}r2(hgUhhj2ubahkj"ubahkjubhX -- r2r2}r2(hgUhhj2ubj)r2}r2(hgX$``(errorCode=501, detailCode=2041)``hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2hX (errorCode=501, detailCode=2041)r2r2}r2(hgUhhj2ubahkjubehkhubahkj;#ubj#)r2}r2(hgUhm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2h)r2}r2(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2042)hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r2(j)r2}r2(hgUhm}r2(Ureftypej#j"U reftargetXExceptions.ServiceFailurer2U refdomainj1hr]hq]U refexplicitho]hp]ht]uhhj2hb]r2j")r2}r2(hgj2hm}r2(ho]hp]hq]hr]ht]uhhj2hb]r3hXExceptions.ServiceFailurer3r3}r3(hgUhhj2ubahkj"ubahkjubhX -- r3r3}r3(hgUhhj2ubj)r3}r3(hgX$``(errorCode=500, detailCode=2042)``hm}r 3(ho]hp]hq]hr]ht]uhhj2hb]r 3hX (errorCode=500, detailCode=2042)r 3r 3}r 3(hgUhhj3ubahkjubehkhubahkj;#ubj#)r3}r3(hgUhm}r3(ho]hp]hq]hr]ht]uhhj2hb]r3h)r3}r3(hgXExceptions.InsufficientResources -- (errorCode=413, detailCode=2045)A ping response may return InsufficientResources if for example the system is in a state where normal DataONE operations may be impeded by an unusually high load on the node.hm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3(j)r3}r3(hgUhm}r3(Ureftypej#j"U reftargetX Exceptions.InsufficientResourcesr3U refdomainj1hr]hq]U refexplicitho]hp]ht]uhhj3hb]r3j")r3}r3(hgj3hm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3hX Exceptions.InsufficientResourcesr3r 3}r!3(hgUhhj3ubahkj"ubahkjubhX -- r"3r#3}r$3(hgUhhj3ubh)r%3}r&3(hgX$``(errorCode=413, detailCode=2045)``r'3hhj3hij)hkhhm}r(3(ho]hp]hq]hr]ht]uhvKyhb]r)3j)r*3}r+3(hgj'3hm}r,3(ho]hp]hq]hr]ht]uhhj%3hb]r-3hX (errorCode=413, detailCode=2045)r.3r/3}r03(hgUhhj*3ubahkjubaubh)r13}r23(hgXA ping response may return InsufficientResources if for example the system is in a state where normal DataONE operations may be impeded by an unusually high load on the node.r33hhj3hij)hkhhm}r43(ho]hp]hq]hr]ht]uhvK{hb]r53hXA ping response may return InsufficientResources if for example the system is in a state where normal DataONE operations may be impeded by an unusually high load on the node.r63r73}r83(hgj33hhj13ubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubcdocutils.nodes block_quote r93)r:3}r;3(hgUhhj)hiNhkU block_quoter<3hm}r=3(ho]hp]hq]hr]ht]uhvNhwhhb]r>3(h)r?3}r@3(hgX **Response**rA3hhj:3hijXsource/apis/examples/ping.txtrB3rC3}rD3bhkhhm}rE3(ho]hp]hq]hr]ht]uhvKhb]rF3cdocutils.nodes strong rG3)rH3}rI3(hgjA3hm}rJ3(ho]hp]hq]hr]ht]uhhj?3hb]rK3hXResponserL3rM3}rN3(hgUhhjH3ubahkUstrongrO3ubaubh)rP3}rQ3(hgXaThe response should be a valid HTTP response with a blank or arbitrary body. Only the HTTP header information is considered by the requestor. A successful response MUST have a HTTP status code of 200. In case of an error condition, the appropriate HTTP status code MUST be set, and an exception or error information MAY be returned in the response body.rR3hhj:3hijC3hkhhm}rS3(ho]hp]hq]hr]ht]uhvKhb]rT3hXaThe response should be a valid HTTP response with a blank or arbitrary body. Only the HTTP header information is considered by the requestor. A successful response MUST have a HTTP status code of 200. In case of an error condition, the appropriate HTTP status code MUST be set, and an exception or error information MAY be returned in the response body.rU3rV3}rW3(hgjR3hhjP3ubaubh)rX3}rY3(hgX **Example**rZ3hhj:3hijC3hkhhm}r[3(ho]hp]hq]hr]ht]uhvK hb]r\3jG3)r]3}r^3(hgjZ3hm}r_3(ho]hp]hq]hr]ht]uhhjX3hb]r`3hXExamplera3rb3}rc3(hgUhhj]3ubahkjO3ubaubh)rd3}re3(hgXMExample of ping request and response for a Member Node (Coordinating Nodes implement the same functionality). Lines prefixed with ">" indicate outgoing information, lines prefixed with "<" show content returned from the server. Lines associated with SSL connection initiation and close are not shown here. Note that the actual response headers may vary, the only required header fields are the first status line and a ``Date`` entry. However, in order to fully support clients that may cache the response, it is recommended that the ``Expires``, and ``Cache-Control`` headers are returned.hhj:3hijC3hkhhm}rf3(ho]hp]hq]hr]ht]uhvK hb]rg3(hXExample of ping request and response for a Member Node (Coordinating Nodes implement the same functionality). Lines prefixed with ">" indicate outgoing information, lines prefixed with "<" show content returned from the server. Lines associated with SSL connection initiation and close are not shown here. Note that the actual response headers may vary, the only required header fields are the first status line and a rh3ri3}rj3(hgXExample of ping request and response for a Member Node (Coordinating Nodes implement the same functionality). Lines prefixed with ">" indicate outgoing information, lines prefixed with "<" show content returned from the server. Lines associated with SSL connection initiation and close are not shown here. Note that the actual response headers may vary, the only required header fields are the first status line and a hhjd3ubj)rk3}rl3(hgX``Date``hm}rm3(ho]hp]hq]hr]ht]uhhjd3hb]rn3hXDatero3rp3}rq3(hgUhhjk3ubahkjubhXk entry. However, in order to fully support clients that may cache the response, it is recommended that the rr3rs3}rt3(hgXk entry. However, in order to fully support clients that may cache the response, it is recommended that the hhjd3ubj)ru3}rv3(hgX ``Expires``hm}rw3(ho]hp]hq]hr]ht]uhhjd3hb]rx3hXExpiresry3rz3}r{3(hgUhhju3ubahkjubhX, and r|3r}3}r~3(hgX, and hhjd3ubj)r3}r3(hgX``Cache-Control``hm}r3(ho]hp]hq]hr]ht]uhhjd3hb]r3hX Cache-Controlr3r3}r3(hgUhhj3ubahkjubhX headers are returned.r3r3}r3(hgX headers are returned.hhjd3ubeubcdocutils.nodes literal_block r3)r3}r3(hgXexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k -v "$NODE/v1/monitor/ping" > GET /knb/d1/mn/v1/monitor/ping HTTP/1.1 > User-Agent: curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2.3.4 libidn/1.22 librtmp/2.3 > Host: demo2.test.dataone.org > Accept: */* > < HTTP/1.1 200 OK < Date: Tue, 06 Mar 2012 14:19:59 GMT < Server: Apache/2.2.14 (Ubuntu) < Content-Length: 0 < Content-Type: text/plain GET /knb/d1/mn/v1/monitor/ping HTTP/1.1 > User-Agent: curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2.3.4 libidn/1.22 librtmp/2.3 > Host: demo2.test.dataone.org > Accept: */* > < HTTP/1.1 200 OK < Date: Tue, 06 Mar 2012 14:19:59 GMT < Server: Apache/2.2.14 (Ubuntu) < Content-Length: 0 < Content-Type: text/plain Identifierhhj3hij)hkj "hm}r3(hr]r3h;aj"j0)hq]ho]hp]ht]r3h;aj"Xcreater3j"Uj"uhvKhwhhb]r3(j")r3}r3(hgXCNCore.hhj3hij)hkj"hm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3hXCNCore.r3r3}r3(hgUhhj3ubaubj")r3}r3(hgj3hhj3hij)hkj!"hm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3hXcreater3r3}r3(hgUhhj3ubaubj'")r3}r3(hgXsession, pid, object, sysmetahhj3hij)hkj*"hm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3(j-")r3}r3(hgXsessionhm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3hXsessionr3r3}r3(hgUhhj3ubahkj5"ubj-")r3}r3(hgXpidhm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3hXpidr3r3}r3(hgUhhj3ubahkj5"ubj-")r3}r3(hgXobjecthm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3hXobjectr3r3}r3(hgUhhj3ubahkj5"ubj-")r3}r3(hgXsysmetahm}r3(ho]hp]hq]hr]ht]uhhj3hb]r3hXsysmetar3r3}r3(hgUhhj3ubahkj5"ubeubj6")r3}r3(hgX Identifierhhj3hij)hkj9"hm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3hX Identifierr3r3}r3(hgUhhj3ubaubeubj?")r3}r3(hgUhhj3hij)hkjB"hm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3(h)r3}r3(hgXSUsed internally within a Coordinating Node to add a new object to the object store.r3hhj3hij)hkhhm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3hXSUsed internally within a Coordinating Node to add a new object to the object store.r3r3}r3(hgj3hhj3ubaubh)r3}r3(hgX;This method is not publicly exposed by a Coordinating Node.r3hhj3hij)hkhhm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3hX;This method is not publicly exposed by a Coordinating Node.r3r3}r3(hgj3hhj3ubaubh)r3}r3(hgXUv2.0: The structure of :class:`v2_0.Types.SystemMetadata` has changed from Version 1.hhj3hij)hkhhm}r3(ho]hp]hq]hr]ht]uhvKhwhhb]r3(hXv2.0: The structure of r3r3}r3(hgXv2.0: The structure of hhj3ubj)r3}r3(hgX":class:`v2_0.Types.SystemMetadata`r3hhj3hij)hkjhm}r3(UreftypeXclassjjXv2_0.Types.SystemMetadataU refdomainXpyr3hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r3j)r4}r4(hgj3hm}r4(ho]hp]r4(jj3Xpy-classr4ehq]hr]ht]uhhj3hb]r4hXv2_0.Types.SystemMetadatar4r4}r4(hgUhhj4ubahkjubaubhX has changed from Version 1.r 4r 4}r 4(hgX has changed from Version 1.hhj3ubeubh)r 4}r 4(hgUhhj3hiNhkhhm}r4(ho]hp]hq]hr]ht]uhvNhwhhb]r4(h)r4}r4(hgUhhj 4hij)hkhhm}r4(ho]hp]hq]hr]ht]uhvKhwhhb]r4(h)r4}r4(hgXVersionhhj4hij)hkhhm}r4(ho]hp]hq]hr]ht]uhvKhb]r4hXVersionr4r4}r4(hgUhhj4ubaubh)r4}r4(hgX1.0, 2.0r4hm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4h)r 4}r!4(hgj4hhj4hij)hkhhm}r"4(ho]hp]hq]hr]ht]uhvKhb]r#4hX1.0, 2.0r$4r%4}r&4(hgj4hhj 4ubaubahkhubeubh)r'4}r(4(hgUhhj 4hij)hkhhm}r)4(ho]hp]hq]hr]ht]uhvKhwhhb]r*4(h)r+4}r,4(hgX Use Caseshhj'4hij)hkhhm}r-4(ho]hp]hq]hr]ht]uhvKhb]r.4hX Use Casesr/4r04}r14(hgUhhj+4ubaubh)r24}r34(hgXp:doc:`UC04 `, :doc:`UC09 `, :doc:`UC16 `r44hm}r54(ho]hp]hq]hr]ht]uhhj'4hb]r64h)r74}r84(hgj44hhj24hij)hkhhm}r94(ho]hp]hq]hr]ht]uhvKhb]r:4(j)r;4}r<4(hgX$:doc:`UC04 `r=4hhj74hij)hkjhm}r>4(UreftypeXdocr?4jjX/design/UseCases/04_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]r@4j`2)rA4}rB4(hgj=4hm}rC4(ho]hp]rD4(jj?4ehq]hr]ht]uhhj;4hb]rE4hXUC04rF4rG4}rH4(hgUhhjA4ubahkji2ubaubhX, rI4rJ4}rK4(hgX, hhj74ubj)rL4}rM4(hgX$:doc:`UC09 `rN4hhj74hij)hkjhm}rO4(UreftypeXdocrP4jjX/design/UseCases/09_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rQ4j`2)rR4}rS4(hgjN4hm}rT4(ho]hp]rU4(jjP4ehq]hr]ht]uhhjL4hb]rV4hXUC09rW4rX4}rY4(hgUhhjR4ubahkji2ubaubhX, rZ4r[4}r\4(hgX, hhj74ubj)r]4}r^4(hgX$:doc:`UC16 `r_4hhj74hij)hkjhm}r`4(UreftypeXdocra4jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rb4j`2)rc4}rd4(hgj_4hm}re4(ho]hp]rf4(jja4ehq]hr]ht]uhhj]4hb]rg4hXUC16rh4ri4}rj4(hgUhhjc4ubahkji2ubaubeubahkhubeubh)rk4}rl4(hgUhhj 4hij)hkhhm}rm4(ho]hp]hq]hr]ht]uhvKhwhhb]rn4(h)ro4}rp4(hgXREST URLhhjk4hij)hkhhm}rq4(ho]hp]hq]hr]ht]uhvKhb]rr4hXREST URLrs4rt4}ru4(hgUhhjo4ubaubh)rv4}rw4(hgX``POST /object``rx4hm}ry4(ho]hp]hq]hr]ht]uhhjk4hb]rz4h)r{4}r|4(hgjx4hhjv4hij)hkhhm}r}4(ho]hp]hq]hr]ht]uhvKhb]r~4j)r4}r4(hgjx4hm}r4(ho]hp]hq]hr]ht]uhhj{4hb]r4hX POST /objectr4r4}r4(hgUhhj4ubahkjubaubahkhubeubh)r4}r4(hgUhm}r4(ho]hp]hq]hr]ht]uhhj 4hb]r4(h)r4}r4(hgX Parametershhj4hij)hkhhm}r4(ho]hp]hq]hr]ht]uhvKhb]r4hX Parametersr4r4}r4(hgUhhj4ubaubh)r4}r4(hgUhm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4j #)r4}r4(hgUhm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4(j#)r4}r4(hgUhm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4h)r4}r4(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4(j")r4}r4(hgXsessionhm}r4(hr]hq]j"ho]hp]ht]uhhj4hb]r4hXsessionr4r4}r4(hgUhhj4ubahkj"ubhX (r4r4}r4(hgUhhj4ubj)r4}r4(hgX:class:`Types.Session`r4hhj4hij)hkjhm}r4(UreftypeXclassjjX Types.SessionU refdomainXpyr4hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r4j)r4}r4(hgj4hm}r4(ho]hp]r4(jj4Xpy-classr4ehq]hr]ht]uhhj4hb]r4hX Types.Sessionr4r4}r4(hgUhhj4ubahkjubaubhX)r4}r4(hgUhhj4ubhX -- r4r4}r4(hgUhhj4ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r4r4}r4(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj4ubj)r4}r4(hgX:term:`public user`r4hhj4hij)hkjhm}r4(UreftypeXtermjjX public userU refdomainXstdr4hr]hq]U refexplicitho]hp]ht]jjuhvKhb]r4j`2)r4}r4(hgj4hm}r4(ho]hp]r4(jj4Xstd-termr4ehq]hr]ht]uhhj4hb]r4hX public userr4r4}r4(hgUhhj4ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r4r4}r4(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj4ubehkhubahkj;#ubj#)r4}r4(hgUhm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4h)r4}r4(hgXpid (Types.Identifier) -- The identifier that should be used in DataONE to identify and access the object. This is an Unicode string that follows the constraints on identifiers described in /design/PIDs. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r4(ho]hp]hq]hr]ht]uhhj4hb]r4(j")r4}r4(hgXpidhm}r4(hr]hq]j"ho]hp]ht]uhhj4hb]r4hXpidr4r4}r4(hgUhhj4ubahkj"ubhX (r4r4}r4(hgUhhj4ubj)r4}r4(hgX:class:`Types.Identifier`r4hhj4hij)hkjhm}r4(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr4hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r4j)r4}r4(hgj4hm}r4(ho]hp]r4(jj4Xpy-classr4ehq]hr]ht]uhhj4hb]r4hXTypes.Identifierr4r4}r4(hgUhhj4ubahkjubaubhX)r4}r4(hgUhhj4ubhX -- r4r4}r4(hgUhhj4ubhXThe identifier that should be used in DataONE to identify and access the object. This is an Unicode string that follows the constraints on identifiers described in r4r4}r4(hgXThe identifier that should be used in DataONE to identify and access the object. This is an Unicode string that follows the constraints on identifiers described in hhj4ubj)r4}r4(hgX:doc:`/design/PIDs`r4hhj4hij)hkjhm}r5(UreftypeXdocr5jjX /design/PIDsU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]r5j`2)r5}r5(hgj4hm}r5(ho]hp]r5(jj5ehq]hr]ht]uhhj4hb]r5hX /design/PIDsr5r 5}r 5(hgUhhj5ubahkji2ubaubhX%. Transmitted as a UTF-8 String as a r 5r 5}r 5(hgX%. Transmitted as a UTF-8 String as a hhj4ubj$)r5}r5(hgX *Param part*hm}r5(ho]hp]hq]hr]ht]uhhj4hb]r5hX Param partr5r5}r5(hgUhhj5ubahkj$ubhX% of the MIME multipart/mixed message.r5r5}r5(hgX% of the MIME multipart/mixed message.hhj4ubehkhubahkj;#ubj#)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj4hb]r5h)r5}r5(hgX;object (bytes) -- The object (e.g. Science Metadata) bytes.hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5(j")r 5}r!5(hgXobjecthm}r"5(hr]hq]j"ho]hp]ht]uhhj5hb]r#5hXobjectr$5r%5}r&5(hgUhhj 5ubahkj"ubhX (r'5r(5}r)5(hgUhhj5ubj)r*5}r+5(hgUhm}r,5(Ureftypej&j"U reftargetXbytesr-5U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj5hb]r.5j&)r/5}r05(hgj-5hm}r15(ho]hp]hq]hr]ht]uhhj*5hb]r25hXbytesr35r45}r55(hgUhhj/5ubahkj&ubahkjubhX)r65}r75(hgUhhj5ubhX -- r85r95}r:5(hgUhhj5ubhX)The object (e.g. Science Metadata) bytes.r;5r<5}r=5(hgX)The object (e.g. Science Metadata) bytes.hhj5ubehkhubahkj;#ubj#)r>5}r?5(hgUhm}r@5(ho]hp]hq]hr]ht]uhhj4hb]rA5h)rB5}rC5(hgXsysmeta (Types.SystemMetadata) -- The complete system metadata document describing the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}rD5(ho]hp]hq]hr]ht]uhhj>5hb]rE5(j")rF5}rG5(hgXsysmetahm}rH5(hr]hq]j"ho]hp]ht]uhhjB5hb]rI5hXsysmetarJ5rK5}rL5(hgUhhjF5ubahkj"ubhX (rM5rN5}rO5(hgUhhjB5ubj)rP5}rQ5(hgX:class:`Types.SystemMetadata`rR5hhjB5hij)hkjhm}rS5(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrT5hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]rU5j)rV5}rW5(hgjR5hm}rX5(ho]hp]rY5(jjT5Xpy-classrZ5ehq]hr]ht]uhhjP5hb]r[5hXTypes.SystemMetadatar\5r]5}r^5(hgUhhjV5ubahkjubaubhX)r_5}r`5(hgUhhjB5ubhX -- ra5rb5}rc5(hgUhhjB5ubhXThe complete system metadata document describing the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rd5re5}rf5(hgXThe complete system metadata document describing the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjB5ubj$)rg5}rh5(hgX *File part*hm}ri5(ho]hp]hq]hr]ht]uhhjB5hb]rj5hX File partrk5rl5}rm5(hgUhhjg5ubahkj$ubhX% of the MIME multipart/mixed message.rn5ro5}rp5(hgX% of the MIME multipart/mixed message.hhjB5ubehkhubahkj;#ubehkj#ubahkhubehkhubh)rq5}rr5(hgUhm}rs5(ho]hp]hq]hr]ht]uhhj 4hb]rt5(h)ru5}rv5(hgXReturnshhjq5hij)hkhhm}rw5(ho]hp]hq]hr]ht]uhvKhb]rx5hXReturnsry5rz5}r{5(hgUhhju5ubaubh)r|5}r}5(hgUhm}r~5(ho]hp]hq]hr]ht]uhhjq5hb]r5h)r5}r5(hgXThe identifier that was used to insert the document into the system. This should be the same as the identifier provided as the pid parameter.hm}r5(ho]hp]hq]hr]ht]uhhj|5hb]r5(hXThe identifier that was used to insert the document into the system. This should be the same as the identifier provided as the r5r5}r5(hgXThe identifier that was used to insert the document into the system. This should be the same as the identifier provided as the hhj5ubj$)r5}r5(hgX*pid*hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5hXpidr5r5}r5(hgUhhj5ubahkj$ubhX parameter.r5r5}r5(hgX parameter.hhj5ubehkhubahkhubehkhubh)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj 4hb]r5(h)r5}r5(hgX Return typehhj5hij)hkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r5hX Return typer5r5}r5(hgUhhj5ubaubh)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5h)r5}r5(hgXTypes.Identifierhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5j)r5}r5(hgX:class:`Types.Identifier`r5hhj5hij)hkjhm}r5(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr5hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r5j)r5}r5(hgj5hm}r5(ho]hp]r5(jj5Xpy-classr5ehq]hr]ht]uhhj5hb]r5hXTypes.Identifierr5r5}r5(hgUhhj5ubahkjubaubahkhubahkhubehkhubh)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj 4hb]r5(h)r5}r5(hgXRaiseshhj5hij)hkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r5hXRaisesr5r5}r5(hgUhhj5ubaubh)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5j #)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5(j#)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5h)r5}r5(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=1100)The provided identity does not have permission to WRITE to the Member Node.hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5(j)r5}r5(hgUhm}r5(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr5U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj5hb]r5j")r5}r5(hgj5hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5hXExceptions.NotAuthorizedr5r5}r5(hgUhhj5ubahkj"ubahkjubhX -- r5r5}r5(hgUhhj5ubh)r5}r5(hgX$``(errorCode=401, detailCode=1100)``r5hhj5hij)hkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r5j)r5}r5(hgj5hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5hX (errorCode=401, detailCode=1100)r5r5}r5(hgUhhj5ubahkjubaubh)r5}r5(hgXKThe provided identity does not have permission to WRITE to the Member Node.r5hhj5hij)hkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r5hXKThe provided identity does not have permission to WRITE to the Member Node.r5r5}r5(hgj5hhj5ubaubehkhubahkj;#ubj#)r5}r5(hgUhm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5h)r5}r5(hgX+Exceptions.IdentifierNotUnique -- (errorCode=409, detailCode=1120)The requested identifier is already used by another object and therefore can not be used for this object. Clients should choose a new identifier that is unique and retry the operation or use CNCore.reserveIdentifier() to reserve one.hm}r5(ho]hp]hq]hr]ht]uhhj5hb]r5(j)r5}r5(hgUhm}r5(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquer5U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj5hb]r5j")r5}r5(hgj5hm}r6(ho]hp]hq]hr]ht]uhhj5hb]r6hXExceptions.IdentifierNotUniquer6r6}r6(hgUhhj5ubahkj"ubahkjubhX -- r6r6}r6(hgUhhj5ubh)r6}r 6(hgX$``(errorCode=409, detailCode=1120)``r 6hhj5hij)hkhhm}r 6(ho]hp]hq]hr]ht]uhvKhb]r 6j)r 6}r6(hgj 6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hX (errorCode=409, detailCode=1120)r6r6}r6(hgUhhj 6ubahkjubaubh)r6}r6(hgXThe requested identifier is already used by another object and therefore can not be used for this object. Clients should choose a new identifier that is unique and retry the operation or use :func:`CNCore.reserveIdentifier` to reserve one.hhj5hij)hkhhm}r6(ho]hp]hq]hr]ht]uhvKhb]r6(hXThe requested identifier is already used by another object and therefore can not be used for this object. Clients should choose a new identifier that is unique and retry the operation or use r6r6}r6(hgXThe requested identifier is already used by another object and therefore can not be used for this object. Clients should choose a new identifier that is unique and retry the operation or use hhj6ubj)r6}r6(hgX :func:`CNCore.reserveIdentifier`r6hhj6hij)hkjhm}r6(UreftypeXfuncjjXCNCore.reserveIdentifierU refdomainXpyr6hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r 6j)r!6}r"6(hgj6hm}r#6(ho]hp]r$6(jj6Xpy-funcr%6ehq]hr]ht]uhhj6hb]r&6hXCNCore.reserveIdentifier()r'6r(6}r)6(hgUhhj!6ubahkjubaubhX to reserve one.r*6r+6}r,6(hgX to reserve one.hhj6ubeubehkhubahkj;#ubj#)r-6}r.6(hgUhm}r/6(ho]hp]hq]hr]ht]uhhj5hb]r06h)r16}r26(hgXwExceptions.UnsupportedType -- (errorCode=400, detailCode=4895)The object store is unable to store the provided content.hm}r36(ho]hp]hq]hr]ht]uhhj-6hb]r46(j)r56}r66(hgUhm}r76(Ureftypej#j"U reftargetXExceptions.UnsupportedTyper86U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj16hb]r96j")r:6}r;6(hgj86hm}r<6(ho]hp]hq]hr]ht]uhhj56hb]r=6hXExceptions.UnsupportedTyper>6r?6}r@6(hgUhhj:6ubahkj"ubahkjubhX -- rA6rB6}rC6(hgUhhj16ubh)rD6}rE6(hgX$``(errorCode=400, detailCode=4895)``rF6hhj16hij)hkhhm}rG6(ho]hp]hq]hr]ht]uhvKhb]rH6j)rI6}rJ6(hgjF6hm}rK6(ho]hp]hq]hr]ht]uhhjD6hb]rL6hX (errorCode=400, detailCode=4895)rM6rN6}rO6(hgUhhjI6ubahkjubaubh)rP6}rQ6(hgX9The object store is unable to store the provided content.rR6hhj16hij)hkhhm}rS6(ho]hp]hq]hr]ht]uhvKhb]rT6hX9The object store is unable to store the provided content.rU6rV6}rW6(hgjR6hhjP6ubaubehkhubahkj;#ubj#)rX6}rY6(hgUhm}rZ6(ho]hp]hq]hr]ht]uhhj5hb]r[6h)r\6}r]6(hgXExceptions.InsufficientResources -- (errorCode=413, detailCode=4897)The CN object store is unable to execute the transfer because of resource limitations.hm}r^6(ho]hp]hq]hr]ht]uhhjX6hb]r_6(j)r`6}ra6(hgUhm}rb6(Ureftypej#j"U reftargetX Exceptions.InsufficientResourcesrc6U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj\6hb]rd6j")re6}rf6(hgjc6hm}rg6(ho]hp]hq]hr]ht]uhhj`6hb]rh6hX Exceptions.InsufficientResourcesri6rj6}rk6(hgUhhje6ubahkj"ubahkjubhX -- rl6rm6}rn6(hgUhhj\6ubh)ro6}rp6(hgX$``(errorCode=413, detailCode=4897)``rq6hhj\6hij)hkhhm}rr6(ho]hp]hq]hr]ht]uhvKhb]rs6j)rt6}ru6(hgjq6hm}rv6(ho]hp]hq]hr]ht]uhhjo6hb]rw6hX (errorCode=413, detailCode=4897)rx6ry6}rz6(hgUhhjt6ubahkjubaubh)r{6}r|6(hgXVThe CN object store is unable to execute the transfer because of resource limitations.r}6hhj\6hij)hkhhm}r~6(ho]hp]hq]hr]ht]uhvKhb]r6hXVThe CN object store is unable to execute the transfer because of resource limitations.r6r6}r6(hgj}6hhj{6ubaubehkhubahkj;#ubj#)r6}r6(hgUhm}r6(ho]hp]hq]hr]ht]uhhj5hb]r6h)r6}r6(hgXExceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=4896)The supplied system metadata is invalid. This could be because some required field is not set, the metadata document is malformed, or the value of some field is not valid.hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6(j)r6}r6(hgUhm}r6(Ureftypej#j"U reftargetX Exceptions.InvalidSystemMetadatar6U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj6hb]r6j")r6}r6(hgj6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hX Exceptions.InvalidSystemMetadatar6r6}r6(hgUhhj6ubahkj"ubahkjubhX -- r6r6}r6(hgUhhj6ubh)r6}r6(hgX$``(errorCode=400, detailCode=4896)``r6hhj6hij)hkhhm}r6(ho]hp]hq]hr]ht]uhvKhb]r6j)r6}r6(hgj6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hX (errorCode=400, detailCode=4896)r6r6}r6(hgUhhj6ubahkjubaubh)r6}r6(hgXThe supplied system metadata is invalid. This could be because some required field is not set, the metadata document is malformed, or the value of some field is not valid.r6hhj6hij)hkhhm}r6(ho]hp]hq]hr]ht]uhvKhb]r6hXThe supplied system metadata is invalid. This could be because some required field is not set, the metadata document is malformed, or the value of some field is not valid.r6r6}r6(hgj6hhj6ubaubehkhubahkj;#ubj#)r6}r6(hgUhm}r6(ho]hp]hq]hr]ht]uhhj5hb]r6h)r6}r6(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4893)hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6(j)r6}r6(hgUhm}r6(Ureftypej#j"U reftargetXExceptions.ServiceFailurer6U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj6hb]r6j")r6}r6(hgj6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hXExceptions.ServiceFailurer6r6}r6(hgUhhj6ubahkj"ubahkjubhX -- r6r6}r6(hgUhhj6ubj)r6}r6(hgX$``(errorCode=500, detailCode=4893)``hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hX (errorCode=500, detailCode=4893)r6r6}r6(hgUhhj6ubahkjubehkhubahkj;#ubj#)r6}r6(hgUhm}r6(ho]hp]hq]hr]ht]uhhj5hb]r6h)r6}r6(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4894)hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6(j)r6}r6(hgUhm}r6(Ureftypej#j"U reftargetXExceptions.InvalidTokenr6U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj6hb]r6j")r6}r6(hgj6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hXExceptions.InvalidTokenr6r6}r6(hgUhhj6ubahkj"ubahkjubhX -- r6r6}r6(hgUhhj6ubj)r6}r6(hgX$``(errorCode=401, detailCode=4894)``hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hX (errorCode=401, detailCode=4894)r6r6}r6(hgUhhj6ubahkjubehkhubahkj;#ubj#)r6}r6(hgUhm}r6(ho]hp]hq]hr]ht]uhhj5hb]r6h)r6}r6(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4890)hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6(j)r6}r6(hgUhm}r6(Ureftypej#j"U reftargetXExceptions.NotImplementedr6U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj6hb]r6j")r6}r6(hgj6hm}r6(ho]hp]hq]hr]ht]uhhj6hb]r6hXExceptions.NotImplementedr6r6}r6(hgUhhj6ubahkj"ubahkjubhX -- r6r6}r7(hgUhhj6ubj)r7}r7(hgX$``(errorCode=501, detailCode=4890)``hm}r7(ho]hp]hq]hr]ht]uhhj6hb]r7hX (errorCode=501, detailCode=4890)r7r7}r7(hgUhhj7ubahkjubehkhubahkj;#ubj#)r7}r 7(hgUhm}r 7(ho]hp]hq]hr]ht]uhhj5hb]r 7h)r 7}r 7(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4891)hm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7(j)r7}r7(hgUhm}r7(Ureftypej#j"U reftargetXExceptions.InvalidRequestr7U refdomainj3hr]hq]U refexplicitho]hp]ht]uhhj 7hb]r7j")r7}r7(hgj7hm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7hXExceptions.InvalidRequestr7r7}r7(hgUhhj7ubahkj"ubahkjubhX -- r7r7}r7(hgUhhj 7ubj)r7}r 7(hgX$``(errorCode=400, detailCode=4891)``hm}r!7(ho]hp]hq]hr]ht]uhhj 7hb]r"7hX (errorCode=400, detailCode=4891)r#7r$7}r%7(hgUhhj7ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r&7}r'7(hgUhhj)hiNhkjhm}r(7(hr]hq]ho]hp]ht]Uentries]r)7(jX listFormats() (in module CNCore)h%UNtr*7auhvNhwhhb]ubj!)r+7}r,7(hgUhhj)hiNhkj!hm}r-7(j"j"Xpyr.7hr]hq]ho]hp]ht]j"Xfunctionr/7j"j/7uhvNhwhhb]r07(j")r17}r27(hgX!listFormats() -> ObjectFormatListhhj+7hij)hkj "hm}r37(hr]r47h%aj"j0)hq]ho]hp]ht]r57h%aj"X listFormatsr67j"Uj"uhvKhwhhb]r77(j")r87}r97(hgXCNCore.hhj17hij)hkj"hm}r:7(ho]hp]hq]hr]ht]uhvKhwhhb]r;7hXCNCore.r<7r=7}r>7(hgUhhj87ubaubj")r?7}r@7(hgj67hhj17hij)hkj!"hm}rA7(ho]hp]hq]hr]ht]uhvKhwhhb]rB7hX listFormatsrC7rD7}rE7(hgUhhj?7ubaubj'")rF7}rG7(hgUhhj17hij)hkj*"hm}rH7(ho]hp]hq]hr]ht]uhvKhwhhb]ubj6")rI7}rJ7(hgXObjectFormatListhhj17hij)hkj9"hm}rK7(ho]hp]hq]hr]ht]uhvKhwhhb]rL7hXObjectFormatListrM7rN7}rO7(hgUhhjI7ubaubeubj?")rP7}rQ7(hgUhhj+7hij)hkjB"hm}rR7(ho]hp]hq]hr]ht]uhvKhwhhb]rS7(h)rT7}rU7(hgXXReturns a list of all object formats registered in the DataONE Object Format Vocabulary.rV7hhjP7hij)hkhhm}rW7(ho]hp]hq]hr]ht]uhvKhwhhb]rX7hXXReturns a list of all object formats registered in the DataONE Object Format Vocabulary.rY7rZ7}r[7(hgjV7hhjT7ubaubh)r\7}r]7(hgXDv2.0: The structure of :class:`v2_0.Types.ObjectFormat` has changed.hhjP7hij)hkhhm}r^7(ho]hp]hq]hr]ht]uhvKhwhhb]r_7(hXv2.0: The structure of r`7ra7}rb7(hgXv2.0: The structure of hhj\7ubj)rc7}rd7(hgX :class:`v2_0.Types.ObjectFormat`re7hhj\7hij)hkjhm}rf7(UreftypeXclassjjXv2_0.Types.ObjectFormatU refdomainXpyrg7hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]rh7j)ri7}rj7(hgje7hm}rk7(ho]hp]rl7(jjg7Xpy-classrm7ehq]hr]ht]uhhjc7hb]rn7hXv2_0.Types.ObjectFormatro7rp7}rq7(hgUhhji7ubahkjubaubhX has changed.rr7rs7}rt7(hgX has changed.hhj\7ubeubh)ru7}rv7(hgUhhjP7hiNhkhhm}rw7(ho]hp]hq]hr]ht]uhvNhwhhb]rx7(h)ry7}rz7(hgUhhju7hij)hkhhm}r{7(ho]hp]hq]hr]ht]uhvKhwhhb]r|7(h)r}7}r~7(hgXVersionhhjy7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hXVersionr7r7}r7(hgUhhj}7ubaubh)r7}r7(hgX1.0, 2.0r7hm}r7(ho]hp]hq]hr]ht]uhhjy7hb]r7h)r7}r7(hgj7hhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hX1.0, 2.0r7r7}r7(hgj7hhj7ubaubahkhubeubh)r7}r7(hgUhhju7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhwhhb]r7(h)r7}r7(hgXREST URLhhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hXREST URLr7r7}r7(hgUhhj7ubaubh)r7}r7(hgX``GET /formats``r7hm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7h)r7}r7(hgj7hhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7j)r7}r7(hgj7hm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7hX GET /formatsr7r7}r7(hgUhhj7ubahkjubaubahkhubeubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhju7hb]r7(h)r7}r7(hgXReturnshhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hXReturnsr7r7}r7(hgUhhj7ubaubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7h)r7}r7(hgXMThe list of object formats registered in the DataONE Object Format Vocabularyhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7hXMThe list of object formats registered in the DataONE Object Format Vocabularyr7r7}r7(hgXMThe list of object formats registered in the DataONE Object Format Vocabularyhhj7ubahkhubahkhubehkhubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhju7hb]r7(h)r7}r7(hgX Return typehhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hX Return typer7r7}r7(hgUhhj7ubaubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7h)r7}r7(hgXTypes.ObjectFormatListhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7j)r7}r7(hgX:class:`Types.ObjectFormatList`r7hhj7hij)hkjhm}r7(UreftypeXclassjjXTypes.ObjectFormatListU refdomainXpyr7hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r7j)r7}r7(hgj7hm}r7(ho]hp]r7(jj7Xpy-classr7ehq]hr]ht]uhhj7hb]r7hXTypes.ObjectFormatListr7r7}r7(hgUhhj7ubahkjubaubahkhubahkhubehkhubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhju7hb]r7(h)r7}r7(hgXRaiseshhj7hij)hkhhm}r7(ho]hp]hq]hr]ht]uhvKhb]r7hXRaisesr7r7}r7(hgUhhj7ubaubh)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7j #)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7(j#)r7}r7(hgUhm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7h)r7}r7(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4840)The service is not implemented.hm}r7(ho]hp]hq]hr]ht]uhhj7hb]r7(j)r7}r7(hgUhm}r8(Ureftypej#j"U reftargetXExceptions.NotImplementedr8U refdomainj.7hr]hq]U refexplicitho]hp]ht]uhhj7hb]r8j")r8}r8(hgj8hm}r8(ho]hp]hq]hr]ht]uhhj7hb]r8hXExceptions.NotImplementedr8r8}r 8(hgUhhj8ubahkj"ubahkjubhX -- r 8r 8}r 8(hgUhhj7ubh)r 8}r8(hgX$``(errorCode=501, detailCode=4840)``r8hhj7hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8j)r8}r8(hgj8hm}r8(ho]hp]hq]hr]ht]uhhj 8hb]r8hX (errorCode=501, detailCode=4840)r8r8}r8(hgUhhj8ubahkjubaubh)r8}r8(hgXThe service is not implemented.r8hhj7hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8hXThe service is not implemented.r8r8}r 8(hgj8hhj8ubaubehkhubahkj;#ubj#)r!8}r"8(hgUhm}r#8(ho]hp]hq]hr]ht]uhhj7hb]r$8h)r%8}r&8(hgXvExceptions.ServiceFailure -- (errorCode=500, detailCode=4841)An error occurred when attempting to service the request.hm}r'8(ho]hp]hq]hr]ht]uhhj!8hb]r(8(j)r)8}r*8(hgUhm}r+8(Ureftypej#j"U reftargetXExceptions.ServiceFailurer,8U refdomainj.7hr]hq]U refexplicitho]hp]ht]uhhj%8hb]r-8j")r.8}r/8(hgj,8hm}r08(ho]hp]hq]hr]ht]uhhj)8hb]r18hXExceptions.ServiceFailurer28r38}r48(hgUhhj.8ubahkj"ubahkjubhX -- r58r68}r78(hgUhhj%8ubh)r88}r98(hgX$``(errorCode=500, detailCode=4841)``r:8hhj%8hij)hkhhm}r;8(ho]hp]hq]hr]ht]uhvKhb]r<8j)r=8}r>8(hgj:8hm}r?8(ho]hp]hq]hr]ht]uhhj88hb]r@8hX (errorCode=500, detailCode=4841)rA8rB8}rC8(hgUhhj=8ubahkjubaubh)rD8}rE8(hgX9An error occurred when attempting to service the request.rF8hhj%8hij)hkhhm}rG8(ho]hp]hq]hr]ht]uhvKhb]rH8hX9An error occurred when attempting to service the request.rI8rJ8}rK8(hgjF8hhjD8ubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubh)rL8}rM8(hgX **Example**rN8hhj)hijX-source/apis/examples/cn_listObjectFormats.txtrO8rP8}rQ8bhkhhm}rR8(ho]hp]hq]hr]ht]uhvKhwhhb]rS8jG3)rT8}rU8(hgjN8hm}rV8(ho]hp]hq]hr]ht]uhhjL8hb]rW8hXExamplerX8rY8}rZ8(hgUhhjT8ubahkjO3ubaubj3)r[8}r\8(hgXcurl "http://cn.dataone.org/cn/v1/formats" -//ecoinformatics.org//eml-access-2.0.0beta4//EN Ecological Metadata Language, Access module, version 2.0.0beta4 METADATA -//ecoinformatics.org//eml-attribute-2.0.0beta4//EN Ecological Metadata Language, Attribute module, version 2.0.0beta4 METADATA -//ecoinformatics.org//eml-constraint-2.0.0beta4//EN Ecological Metadata Language, Constraint module, version 2.0.0beta4 METADATA ... hhj)hijP8hkj3hm}r]8(j3j3Xbashj#j$hr]hq]ho]j3}hp]ht]uhvKhwhhb]r^8hXcurl "http://cn.dataone.org/cn/v1/formats" -//ecoinformatics.org//eml-access-2.0.0beta4//EN Ecological Metadata Language, Access module, version 2.0.0beta4 METADATA -//ecoinformatics.org//eml-attribute-2.0.0beta4//EN Ecological Metadata Language, Attribute module, version 2.0.0beta4 METADATA -//ecoinformatics.org//eml-constraint-2.0.0beta4//EN Ecological Metadata Language, Constraint module, version 2.0.0beta4 METADATA ... r_8r`8}ra8(hgUhhj[8ubaubj)rb8}rc8(hgUhhj)hiNhkjhm}rd8(hr]hq]ho]hp]ht]Uentries]re8(jXgetFormat() (in module CNCore)hUNtrf8auhvNhwhhb]ubj!)rg8}rh8(hgUhhj)hiNhkj!hm}ri8(j"j"Xpyrj8hr]hq]ho]hp]ht]j"Xfunctionrk8j"jk8uhvNhwhhb]rl8(j")rm8}rn8(hgX#getFormat(formatId) -> ObjectFormathhjg8hij)hkj "hm}ro8(hr]rp8haj"j0)hq]ho]hp]ht]rq8haj"X getFormatrr8j"Uj"uhvKhwhhb]rs8(j")rt8}ru8(hgXCNCore.hhjm8hij)hkj"hm}rv8(ho]hp]hq]hr]ht]uhvKhwhhb]rw8hXCNCore.rx8ry8}rz8(hgUhhjt8ubaubj")r{8}r|8(hgjr8hhjm8hij)hkj!"hm}r}8(ho]hp]hq]hr]ht]uhvKhwhhb]r~8hX getFormatr8r8}r8(hgUhhj{8ubaubj'")r8}r8(hgXformatIdhhjm8hij)hkj*"hm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8j-")r8}r8(hgXformatIdhm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8hXformatIdr8r8}r8(hgUhhj8ubahkj5"ubaubj6")r8}r8(hgX ObjectFormathhjm8hij)hkj9"hm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8hX ObjectFormatr8r8}r8(hgUhhj8ubaubeubj?")r8}r8(hgUhhjg8hij)hkjB"hm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8(h)r8}r8(hgXmReturns the object format registered in the DataONE Object Format Vocabulary for the given format identifier.r8hhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8hXmReturns the object format registered in the DataONE Object Format Vocabulary for the given format identifier.r8r8}r8(hgj8hhj8ubaubh)r8}r8(hgXDv2.0: The structure of :class:`v2_0.Types.ObjectFormat` has changed.hhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8(hXv2.0: The structure of r8r8}r8(hgXv2.0: The structure of hhj8ubj)r8}r8(hgX :class:`v2_0.Types.ObjectFormat`r8hhj8hij)hkjhm}r8(UreftypeXclassjjXv2_0.Types.ObjectFormatU refdomainXpyr8hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r8j)r8}r8(hgj8hm}r8(ho]hp]r8(jj8Xpy-classr8ehq]hr]ht]uhhj8hb]r8hXv2_0.Types.ObjectFormatr8r8}r8(hgUhhj8ubahkjubaubhX has changed.r8r8}r8(hgX has changed.hhj8ubeubh)r8}r8(hgUhhj8hiNhkhhm}r8(ho]hp]hq]hr]ht]uhvNhwhhb]r8(h)r8}r8(hgUhhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8(h)r8}r8(hgXVersionhhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8hXVersionr8r8}r8(hgUhhj8ubaubh)r8}r8(hgX1.0, 2.0r8hm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8h)r8}r8(hgj8hhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8hX1.0, 2.0r8r8}r8(hgj8hhj8ubaubahkhubeubh)r8}r8(hgUhhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhwhhb]r8(h)r8}r8(hgXREST URLhhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8hXREST URLr8r8}r8(hgUhhj8ubaubh)r8}r8(hgX``GET /formats/{formatId}``r8hm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8h)r8}r8(hgj8hhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8j)r8}r8(hgj8hm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8hXGET /formats/{formatId}r8r8}r8(hgUhhj8ubahkjubaubahkhubeubh)r8}r8(hgUhm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8(h)r8}r8(hgX Parametershhj8hij)hkhhm}r8(ho]hp]hq]hr]ht]uhvKhb]r8hX Parametersr8r8}r8(hgUhhj8ubaubh)r8}r8(hgUhm}r8(ho]hp]hq]hr]ht]uhhj8hb]r8h)r8}r8(hgXformatId (Types.ObjectFormatIdentifier) -- Unique ObjectFormatIdentifier for the object format Transmitted as part of the URL path and must be escaped accordingly.hm}r9(ho]hp]hq]hr]ht]uhhj8hb]r9(j")r9}r9(hgXformatIdhm}r9(hr]hq]j"ho]hp]ht]uhhj8hb]r9hXformatIdr9r9}r9(hgUhhj9ubahkj"ubhX (r 9r 9}r 9(hgUhhj8ubj)r 9}r 9(hgX%:class:`Types.ObjectFormatIdentifier`r9hhj8hij)hkjhm}r9(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyr9hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r9j)r9}r9(hgj9hm}r9(ho]hp]r9(jj9Xpy-classr9ehq]hr]ht]uhhj 9hb]r9hXTypes.ObjectFormatIdentifierr9r9}r9(hgUhhj9ubahkjubaubhX)r9}r9(hgUhhj8ubhX -- r9r9}r9(hgUhhj8ubhXxUnique ObjectFormatIdentifier for the object format Transmitted as part of the URL path and must be escaped accordingly.r 9r!9}r"9(hgXxUnique ObjectFormatIdentifier for the object format Transmitted as part of the URL path and must be escaped accordingly.hhj8ubehkhubahkhubehkhubh)r#9}r$9(hgUhm}r%9(ho]hp]hq]hr]ht]uhhj8hb]r&9(h)r'9}r(9(hgXReturnshhj#9hij)hkhhm}r)9(ho]hp]hq]hr]ht]uhvKhb]r*9hXReturnsr+9r,9}r-9(hgUhhj'9ubaubh)r.9}r/9(hgUhm}r09(ho]hp]hq]hr]ht]uhhj#9hb]r19h)r29}r39(hgXEThe object format registered in the DataONE Object Format Vocablularyhm}r49(ho]hp]hq]hr]ht]uhhj.9hb]r59hXEThe object format registered in the DataONE Object Format Vocablularyr69r79}r89(hgXEThe object format registered in the DataONE Object Format Vocablularyhhj29ubahkhubahkhubehkhubh)r99}r:9(hgUhm}r;9(ho]hp]hq]hr]ht]uhhj8hb]r<9(h)r=9}r>9(hgX Return typehhj99hij)hkhhm}r?9(ho]hp]hq]hr]ht]uhvKhb]r@9hX Return typerA9rB9}rC9(hgUhhj=9ubaubh)rD9}rE9(hgUhm}rF9(ho]hp]hq]hr]ht]uhhj99hb]rG9h)rH9}rI9(hgXTypes.ObjectFormathm}rJ9(ho]hp]hq]hr]ht]uhhjD9hb]rK9j)rL9}rM9(hgX:class:`Types.ObjectFormat`rN9hhjH9hij)hkjhm}rO9(UreftypeXclassjjXTypes.ObjectFormatU refdomainXpyrP9hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]rQ9j)rR9}rS9(hgjN9hm}rT9(ho]hp]rU9(jjP9Xpy-classrV9ehq]hr]ht]uhhjL9hb]rW9hXTypes.ObjectFormatrX9rY9}rZ9(hgUhhjR9ubahkjubaubahkhubahkhubehkhubh)r[9}r\9(hgUhm}r]9(ho]hp]hq]hr]ht]uhhj8hb]r^9(h)r_9}r`9(hgXRaiseshhj[9hij)hkhhm}ra9(ho]hp]hq]hr]ht]uhvKhb]rb9hXRaisesrc9rd9}re9(hgUhhj_9ubaubh)rf9}rg9(hgUhm}rh9(ho]hp]hq]hr]ht]uhhj[9hb]ri9j #)rj9}rk9(hgUhm}rl9(ho]hp]hq]hr]ht]uhhjf9hb]rm9(j#)rn9}ro9(hgUhm}rp9(ho]hp]hq]hr]ht]uhhjj9hb]rq9h)rr9}rs9(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4845)The service is not implemented.hm}rt9(ho]hp]hq]hr]ht]uhhjn9hb]ru9(j)rv9}rw9(hgUhm}rx9(Ureftypej#j"U reftargetXExceptions.NotImplementedry9U refdomainjj8hr]hq]U refexplicitho]hp]ht]uhhjr9hb]rz9j")r{9}r|9(hgjy9hm}r}9(ho]hp]hq]hr]ht]uhhjv9hb]r~9hXExceptions.NotImplementedr9r9}r9(hgUhhj{9ubahkj"ubahkjubhX -- r9r9}r9(hgUhhjr9ubh)r9}r9(hgX$``(errorCode=501, detailCode=4845)``r9hhjr9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9j)r9}r9(hgj9hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hX (errorCode=501, detailCode=4845)r9r9}r9(hgUhhj9ubahkjubaubh)r9}r9(hgXThe service is not implemented.r9hhjr9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9hXThe service is not implemented.r9r9}r9(hgj9hhj9ubaubehkhubahkj;#ubj#)r9}r9(hgUhm}r9(ho]hp]hq]hr]ht]uhhjj9hb]r9h)r9}r9(hgXcExceptions.ServiceFailure -- (errorCode=500, detailCode=4846)Unexpected exception from the service.hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9(j)r9}r9(hgUhm}r9(Ureftypej#j"U reftargetXExceptions.ServiceFailurer9U refdomainjj8hr]hq]U refexplicitho]hp]ht]uhhj9hb]r9j")r9}r9(hgj9hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hXExceptions.ServiceFailurer9r9}r9(hgUhhj9ubahkj"ubahkjubhX -- r9r9}r9(hgUhhj9ubh)r9}r9(hgX$``(errorCode=500, detailCode=4846)``r9hhj9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9j)r9}r9(hgj9hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hX (errorCode=500, detailCode=4846)r9r9}r9(hgUhhj9ubahkjubaubh)r9}r9(hgX&Unexpected exception from the service.r9hhj9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9hX&Unexpected exception from the service.r9r9}r9(hgj9hhj9ubaubehkhubahkj;#ubj#)r9}r9(hgUhm}r9(ho]hp]hq]hr]ht]uhhjj9hb]r9h)r9}r9(hgXtExceptions.NotFound -- (errorCode=404, detailCode=4848)The format specified by formatId does not exist at this node.hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9(j)r9}r9(hgUhm}r9(Ureftypej#j"U reftargetXExceptions.NotFoundr9U refdomainjj8hr]hq]U refexplicitho]hp]ht]uhhj9hb]r9j")r9}r9(hgj9hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hXExceptions.NotFoundr9r9}r9(hgUhhj9ubahkj"ubahkjubhX -- r9r9}r9(hgUhhj9ubh)r9}r9(hgX$``(errorCode=404, detailCode=4848)``r9hhj9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9j)r9}r9(hgj9hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hX (errorCode=404, detailCode=4848)r9r9}r9(hgUhhj9ubahkjubaubh)r9}r9(hgX?The format specified by *formatId* does not exist at this node.hhj9hij)hkhhm}r9(ho]hp]hq]hr]ht]uhvKhb]r9(hXThe format specified by r9r9}r9(hgXThe format specified by hhj9ubj$)r9}r9(hgX *formatId*hm}r9(ho]hp]hq]hr]ht]uhhj9hb]r9hXformatIdr9r9}r9(hgUhhj9ubahkj$ubhX does not exist at this node.r9r9}r9(hgX does not exist at this node.hhj9ubeubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubh)r9}r9(hgX **Example**r9hhj)hijX%source/apis/examples/cn_getFormat.txtr9r9}r9bhkhhm}r9(ho]hp]hq]hr]ht]uhvKhwhhb]r9jG3)r:}r:(hgj9hm}r:(ho]hp]hq]hr]ht]uhhj9hb]r:hXExampler:r:}r:(hgUhhj:ubahkjO3ubaubh)r:}r:(hgXRetrieve information about the ``http://www.openarchives.org/ore/terms`` formatId. Note that formatId has characters that should be escaped when added as a URL path element. This is done using the urlencode script.hhj)hij9hkhhm}r :(ho]hp]hq]hr]ht]uhvKhwhhb]r :(hXRetrieve information about the r :r :}r :(hgXRetrieve information about the hhj:ubj)r:}r:(hgX)``http://www.openarchives.org/ore/terms``hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hX%http://www.openarchives.org/ore/termsr:r:}r:(hgUhhj:ubahkjubhX formatId. Note that formatId has characters that should be escaped when added as a URL path element. This is done using the urlencode script.r:r:}r:(hgX formatId. Note that formatId has characters that should be escaped when added as a URL path element. This is done using the urlencode script.hhj:ubeubcdocutils.nodes note r:)r:}r:(hgXThe *xml* command is implemented by XMLStarlet_, and is used here to format the output for easier reading. The *urlencode* command is a script available with the `d1_client_bash`_ itk toolhhj)hij9hkUnoter:hm}r:(ho]hp]hq]hr]ht]uhvNhwhhb]r:h)r:}r:(hgXThe *xml* command is implemented by XMLStarlet_, and is used here to format the output for easier reading. The *urlencode* command is a script available with the `d1_client_bash`_ itk toolhhj:hij9hkhhm}r :(ho]hp]hq]hr]ht]uhvKhb]r!:(hXThe r":r#:}r$:(hgXThe hhj:ubj$)r%:}r&:(hgX*xml*hm}r':(ho]hp]hq]hr]ht]uhhj:hb]r(:hXxmlr):r*:}r+:(hgUhhj%:ubahkj$ubhX command is implemented by r,:r-:}r.:(hgX command is implemented by hhj:ubj2)r/:}r0:(hgX XMLStarlet_Uresolvedr1:Khhj:hkj#2hm}r2:(UnameX XMLStarletUrefurir3:Xhttp://xmlstar.sourceforge.net/r4:hr]hq]ho]hp]ht]uhb]r5:hX XMLStarletr6:r7:}r8:(hgUhhj/:ubaubhX@, and is used here to format the output for easier reading. The r9:r::}r;:(hgX@, and is used here to format the output for easier reading. The hhj:ubj$)r<:}r=:(hgX *urlencode*hm}r>:(ho]hp]hq]hr]ht]uhhj:hb]r?:hX urlencoder@:rA:}rB:(hgUhhj<:ubahkj$ubhX( command is a script available with the rC:rD:}rE:(hgX( command is a script available with the hhj:ubj2)rF:}rG:(hgX`d1_client_bash`_j1:Khhj:hkj#2hm}rH:(UnameXd1_client_bashrI:j3:XGhttps://repository.dataone.org/software/cicore/trunk/itk/d1_client_bashrJ:hr]hq]ho]hp]ht]uhb]rK:hXd1_client_bashrL:rM:}rN:(hgUhhjF:ubaubhX itk toolrO:rP:}rQ:(hgX itk toolhhj:ubeubaubj3)rR:}rS:(hgXformatid=$(echo "http://www.openarchives.org/ore/terms" | urlencode) curl -s "http://cn-dev.dataone.org/cn/v1/formats/${formatid}" | xml fo http://www.openarchives.org/ore/terms Object Reuse and Exchange Vocabulary RESOURCE hhj)hij9hkj3hm}rT:(j3j3Xbashj#j$hr]hq]ho]j3}hp]ht]uhvK hwhhb]rU:hXformatid=$(echo "http://www.openarchives.org/ore/terms" | urlencode) curl -s "http://cn-dev.dataone.org/cn/v1/formats/${formatid}" | xml fo http://www.openarchives.org/ore/terms Object Reuse and Exchange Vocabulary RESOURCE rV:rW:}rX:(hgUhhjR:ubaubcdocutils.nodes target rY:)rZ:}r[:(hgX/.. _XMLStarlet: http://xmlstar.sourceforge.net/U referencedr\:Khhj)hij9hkUtargetr]:hm}r^:(j3:j4:hr]r_:hXahq]ho]hp]ht]r`:hauhvM^hwhhb]ubjY:)ra:}rb:(hgX[.. _d1_client_bash: https://repository.dataone.org/software/cicore/trunk/itk/d1_client_bashj\:Khhj)hij9hkj]:hm}rc:(j3:jJ:hr]rd:h]ahq]ho]hp]ht]re:hBauhvM`hwhhb]ubj)rf:}rg:(hgUhhj)hiNhkjhm}rh:(hr]hq]ho]hp]ht]Uentries]ri:(jX"getLogRecords() (in module CNCore)h UNtrj:auhvNhwhhb]ubj!)rk:}rl:(hgUhhj)hiNhkj!hm}rm:(j"j"Xpyrn:hr]hq]ho]hp]ht]j"Xfunctionro:j"jo:uhvNhwhhb]rp:(j")rq:}rr:(hgXTgetLogRecords(session,[fromDate],[toDate],[event],[idFilter],[start],[count]) -> Loghhjk:hij)hkj "hm}rs:(hr]rt:h aj"j0)hq]ho]hp]ht]ru:h aj"X getLogRecordsrv:j"Uj"uhvM.hwhhb]rw:(j")rx:}ry:(hgXCNCore.hhjq:hij)hkj"hm}rz:(ho]hp]hq]hr]ht]uhvM.hwhhb]r{:hXCNCore.r|:r}:}r~:(hgUhhjx:ubaubj")r:}r:(hgjv:hhjq:hij)hkj!"hm}r:(ho]hp]hq]hr]ht]uhvM.hwhhb]r:hX getLogRecordsr:r:}r:(hgUhhj:ubaubj'")r:}r:(hgXDsession, [fromDate], [toDate], [event], [idFilter], [start], [count]hhjq:hij)hkj*"hm}r:(ho]hp]hq]hr]ht]uhvM.hwhhb]r:(j-")r:}r:(hgXsessionhm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXsessionr:r:}r:(hgUhhj:ubahkj5"ubcsphinx.addnodes desc_optional r:)r:}r:(hgX [fromDate]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXfromDatehm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXfromDater:r:}r:(hgUhhj:ubahkj5"ubahkU desc_optionalr:ubj:)r:}r:(hgX[toDate]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXtoDatehm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXtoDater:r:}r:(hgUhhj:ubahkj5"ubahkj:ubj:)r:}r:(hgX[event]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXeventhm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXeventr:r:}r:(hgUhhj:ubahkj5"ubahkj:ubj:)r:}r:(hgX [idFilter]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXidFilterhm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXidFilterr:r:}r:(hgUhhj:ubahkj5"ubahkj:ubj:)r:}r:(hgX[start]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXstarthm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXstartr:r:}r:(hgUhhj:ubahkj5"ubahkj:ubj:)r:}r:(hgX[count]hm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:j-")r:}r:(hgXcounthm}r:(ho]hp]hq]hr]ht]uhhj:hb]r:hXcountr:r:}r:(hgUhhj:ubahkj5"ubahkj:ubeubj6")r:}r:(hgXLoghhjq:hij)hkj9"hm}r:(ho]hp]hq]hr]ht]uhvM.hwhhb]r:hXLogr:r:}r:(hgUhhj:ubaubeubj?")r:}r:(hgUhhjk:hij)hkjB"hm}r:(ho]hp]hq]hr]ht]uhvM.hwhhb]r:(h)r:}r:(hgXRetrieves consolidated log information for the specified date range (fromDate < timestamp <= toDate) for the entire DataONE infrastructurer:hhj:hij)hkhhm}r:(ho]hp]hq]hr]ht]uhvKhwhhb]r:hXRetrieves consolidated log information for the specified date range (fromDate < timestamp <= toDate) for the entire DataONE infrastructurer:r:}r:(hgj:hhj:ubaubh)r:}r:(hgX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r:hhj:hij)hkhhm}r:(ho]hp]hq]hr]ht]uhvKhwhhb]r:hX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r:r:}r:(hgj:hhj:ubaubh)r:}r:(hgXNote that full access to log records requires access through a priviledged account. A public user may be presented with an empty response.r:hhj:hij)hkhhm}r:(ho]hp]hq]hr]ht]uhvKhwhhb]r:hXNote that full access to log records requires access through a priviledged account. A public user may be presented with an empty response.r:r:}r:(hgj:hhj:ubaubh)r:}r:(hgX;v2.0: The structure of :class:`v2_0.Types.Log` has changed.hhj:hij)hkhhm}r:(ho]hp]hq]hr]ht]uhvKhwhhb]r:(hXv2.0: The structure of r:r:}r:(hgXv2.0: The structure of hhj:ubj)r:}r;(hgX:class:`v2_0.Types.Log`r;hhj:hij)hkjhm}r;(UreftypeXclassjjXv2_0.Types.LogU refdomainXpyr;hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvKhb]r;j)r;}r;(hgj;hm}r;(ho]hp]r;(jj;Xpy-classr ;ehq]hr]ht]uhhj:hb]r ;hXv2_0.Types.Logr ;r ;}r ;(hgUhhj;ubahkjubaubhX has changed.r;r;}r;(hgX has changed.hhj:ubeubh)r;}r;(hgXXv2.0: The event parameter has changed from :class:`v1_0.Types.Event` to a plain *string*hhj:hij)hkhhm}r;(ho]hp]hq]hr]ht]uhvMhwhhb]r;(hX+v2.0: The event parameter has changed from r;r;}r;(hgX+v2.0: The event parameter has changed from hhj;ubj)r;}r;(hgX:class:`v1_0.Types.Event`r;hhj;hij)hkjhm}r;(UreftypeXclassjjXv1_0.Types.EventU refdomainXpyr;hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r;j)r;}r;(hgj;hm}r ;(ho]hp]r!;(jj;Xpy-classr";ehq]hr]ht]uhhj;hb]r#;hXv1_0.Types.Eventr$;r%;}r&;(hgUhhj;ubahkjubaubhX to a plain r';r(;}r);(hgX to a plain hhj;ubj$)r*;}r+;(hgX*string*hm}r,;(ho]hp]hq]hr]ht]uhhj;hb]r-;hXstringr.;r/;}r0;(hgUhhj*;ubahkj$ubeubh)r1;}r2;(hgUhhj:hiNhkhhm}r3;(ho]hp]hq]hr]ht]uhvNhwhhb]r4;(h)r5;}r6;(hgUhhj1;hij)hkhhm}r7;(ho]hp]hq]hr]ht]uhvMhwhhb]r8;(h)r9;}r:;(hgXVersionhhj5;hij)hkhhm}r;;(ho]hp]hq]hr]ht]uhvKhb]r<;hXVersionr=;r>;}r?;(hgUhhj9;ubaubh)r@;}rA;(hgX1.0, 2.0rB;hm}rC;(ho]hp]hq]hr]ht]uhhj5;hb]rD;h)rE;}rF;(hgjB;hhj@;hij)hkhhm}rG;(ho]hp]hq]hr]ht]uhvMhb]rH;hX1.0, 2.0rI;rJ;}rK;(hgjB;hhjE;ubaubahkhubeubh)rL;}rM;(hgUhhj1;hij)hkhhm}rN;(ho]hp]hq]hr]ht]uhvMhwhhb]rO;(h)rP;}rQ;(hgX Use CaseshhjL;hij)hkhhm}rR;(ho]hp]hq]hr]ht]uhvKhb]rS;hX Use CasesrT;rU;}rV;(hgUhhjP;ubaubh)rW;}rX;(hgX$:doc:`UC16 `rY;hm}rZ;(ho]hp]hq]hr]ht]uhhjL;hb]r[;h)r\;}r];(hgjY;hhjW;hij)hkhhm}r^;(ho]hp]hq]hr]ht]uhvMhb]r_;j)r`;}ra;(hgjY;hhj\;hij)hkjhm}rb;(UreftypeXdocrc;jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rd;j`2)re;}rf;(hgjY;hm}rg;(ho]hp]rh;(jjc;ehq]hr]ht]uhhj`;hb]ri;hXUC16rj;rk;}rl;(hgUhhje;ubahkji2ubaubaubahkhubeubh)rm;}rn;(hgUhhj1;hij)hkhhm}ro;(ho]hp]hq]hr]ht]uhvMhwhhb]rp;(h)rq;}rr;(hgXREST URLhhjm;hij)hkhhm}rs;(ho]hp]hq]hr]ht]uhvKhb]rt;hXREST URLru;rv;}rw;(hgUhhjq;ubaubh)rx;}ry;(hgXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``rz;hm}r{;(ho]hp]hq]hr]ht]uhhjm;hb]r|;h)r};}r~;(hgjz;hhjx;hij)hkhhm}r;(ho]hp]hq]hr]ht]uhvMhb]r;j)r;}r;(hgjz;hm}r;(ho]hp]hq]hr]ht]uhhj};hb]r;hXvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]r;r;}r;(hgUhhj;ubahkjubaubahkhubeubh)r;}r;(hgUhm}r;(ho]hp]hq]hr]ht]uhhj1;hb]r;(h)r;}r;(hgX Parametershhj;hij)hkhhm}r;(ho]hp]hq]hr]ht]uhvKhb]r;hX Parametersr;r;}r;(hgUhhj;ubaubh)r;}r;(hgUhm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;j #)r;}r;(hgUhm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;(j#)r;}r;(hgUhm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;h)r;}r;(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;(j")r;}r;(hgXsessionhm}r;(hr]hq]j"ho]hp]ht]uhhj;hb]r;hXsessionr;r;}r;(hgUhhj;ubahkj"ubhX (r;r;}r;(hgUhhj;ubj)r;}r;(hgX:class:`Types.Session`r;hhj;hij)hkjhm}r;(UreftypeXclassjjX Types.SessionU refdomainXpyr;hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r;j)r;}r;(hgj;hm}r;(ho]hp]r;(jj;Xpy-classr;ehq]hr]ht]uhhj;hb]r;hX Types.Sessionr;r;}r;(hgUhhj;ubahkjubaubhX)r;}r;(hgUhhj;ubhX -- r;r;}r;(hgUhhj;ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r;r;}r;(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj;ubj)r;}r;(hgX:term:`public user`r;hhj;hij)hkjhm}r;(UreftypeXtermjjX public userU refdomainXstdr;hr]hq]U refexplicitho]hp]ht]jjuhvMhb]r;j`2)r;}r;(hgj;hm}r;(ho]hp]r;(jj;Xstd-termr;ehq]hr]ht]uhhj;hb]r;hX public userr;r;}r;(hgUhhj;ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r;r;}r;(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj;ubehkhubahkj;#ubj#)r;}r;(hgUhm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;h)r;}r;(hgXfromDate (Types.DateTime) -- Starting time for records in response, entries with timestamp greater than or equal to (>=) this value will be returned. Defaults to include all records. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r;(ho]hp]hq]hr]ht]uhhj;hb]r;(j")r;}r;(hgXfromDatehm}r;(hr]hq]j"ho]hp]ht]uhhj;hb]r;hXfromDater;r;}r;(hgUhhj;ubahkj"ubhX (r;r;}r;(hgUhhj;ubj)r;}r;(hgX:class:`Types.DateTime`r;hhj;hij)hkjhm}r;(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr;hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM hb]r;j)r;}r;(hgj;hm}r;(ho]hp]r;(jj;Xpy-classr;ehq]hr]ht]uhhj;hb]r;hXTypes.DateTimer;r;}r;(hgUhhj;ubahkjubaubhX)r;}r;(hgUhhj;ubhX -- r;r;}r;(hgUhhj;ubhXStarting time for records in response, entries with timestamp greater than or equal to (>=) this value will be returned. Defaults to include all records. Transmitted as a URL query parameter, and so must be escaped accordingly.r;r;}r;(hgXStarting time for records in response, entries with timestamp greater than or equal to (>=) this value will be returned. Defaults to include all records. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj;ubehkhubahkj;#ubj#)r;}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj;hb]r<h)r<}r<(hgXtoDate (Types.DateTime) -- End time for records in response, entries with timestamp less than (<) this value will be returned. If not specified, then defaults to now. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r<(ho]hp]hq]hr]ht]uhhj;hb]r<(j")r<}r<(hgXtoDatehm}r <(hr]hq]j"ho]hp]ht]uhhj<hb]r <hXtoDater <r <}r <(hgUhhj<ubahkj"ubhX (r<r<}r<(hgUhhj<ubj)r<}r<(hgX:class:`Types.DateTime`r<hhj<hij)hkjhm}r<(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr<hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM hb]r<j)r<}r<(hgj<hm}r<(ho]hp]r<(jj<Xpy-classr<ehq]hr]ht]uhhj<hb]r<hXTypes.DateTimer<r<}r<(hgUhhj<ubahkjubaubhX)r <}r!<(hgUhhj<ubhX -- r"<r#<}r$<(hgUhhj<ubhXEnd time for records in response, entries with timestamp less than (<) this value will be returned. If not specified, then defaults to now. Transmitted as a URL query parameter, and so must be escaped accordingly.r%<r&<}r'<(hgXEnd time for records in response, entries with timestamp less than (<) this value will be returned. If not specified, then defaults to now. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj<ubehkhubahkj;#ubj#)r(<}r)<(hgUhm}r*<(ho]hp]hq]hr]ht]uhhj;hb]r+<h)r,<}r-<(hgXevent (Types.Event, string) -- Return only log records for the specified type of event. Default is all. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r.<(ho]hp]hq]hr]ht]uhhj(<hb]r/<(j")r0<}r1<(hgXeventhm}r2<(hr]hq]j"ho]hp]ht]uhhj,<hb]r3<hXeventr4<r5<}r6<(hgUhhj0<ubahkj"ubhX (r7<r8<}r9<(hgUhhj,<ubj)r:<}r;<(hgX:class:`Types.Event, string`r<<hhj,<hij)hkjhm}r=<(UreftypeXclassjjXTypes.Event, stringU refdomainXpyr><hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r?<j)r@<}rA<(hgj<<hm}rB<(ho]hp]rC<(jj><Xpy-classrD<ehq]hr]ht]uhhj:<hb]rE<hXTypes.Event, stringrF<rG<}rH<(hgUhhj@<ubahkjubaubhX)rI<}rJ<(hgUhhj,<ubhX -- rK<rL<}rM<(hgUhhj,<ubhXReturn only log records for the specified type of event. Default is all. Transmitted as a URL query parameter, and so must be escaped accordingly.rN<rO<}rP<(hgXReturn only log records for the specified type of event. Default is all. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj,<ubehkhubahkj;#ubj#)rQ<}rR<(hgUhm}rS<(ho]hp]hq]hr]ht]uhhj;hb]rT<h)rU<}rV<(hgXidFilter (string) -- Return only log records for identifiers that start with the supplied identifier string. Support for this parameter is optional and MAY be ignored by the Coordinating Node implementation with no warning. Supports PID and SID values. Only PID values will be included in the returned entries. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rW<(ho]hp]hq]hr]ht]uhhjQ<hb]rX<(j")rY<}rZ<(hgXidFilterhm}r[<(hr]hq]j"ho]hp]ht]uhhjU<hb]r\<hXidFilterr]<r^<}r_<(hgUhhjY<ubahkj"ubhX (r`<ra<}rb<(hgUhhjU<ubj)rc<}rd<(hgUhm}re<(Ureftypej&j"U reftargetXstringrf<U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhjU<hb]rg<j&)rh<}ri<(hgjf<hm}rj<(ho]hp]hq]hr]ht]uhhjc<hb]rk<hXstringrl<rm<}rn<(hgUhhjh<ubahkj&ubahkjubhX)ro<}rp<(hgUhhjU<ubhX -- rq<rr<}rs<(hgUhhjU<ubhXkReturn only log records for identifiers that start with the supplied identifier string. Support for this parameter is optional and MAY be ignored by the Coordinating Node implementation with no warning. Supports PID and SID values. Only PID values will be included in the returned entries. Transmitted as a URL query parameter, and so must be escaped accordingly.rt<ru<}rv<(hgXkReturn only log records for identifiers that start with the supplied identifier string. Support for this parameter is optional and MAY be ignored by the Coordinating Node implementation with no warning. Supports PID and SID values. Only PID values will be included in the returned entries. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjU<ubehkhubahkj;#ubj#)rw<}rx<(hgUhm}ry<(ho]hp]hq]hr]ht]uhhj;hb]rz<h)r{<}r|<(hgXstart (integer) -- The zero based index of the first log record to return. Default is 0. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r}<(ho]hp]hq]hr]ht]uhhjw<hb]r~<(j")r<}r<(hgXstarthm}r<(hr]hq]j"ho]hp]ht]uhhj{<hb]r<hXstartr<r<}r<(hgUhhj<ubahkj"ubhX (r<r<}r<(hgUhhj{<ubj)r<}r<(hgUhm}r<(Ureftypej&j"U reftargetXintegerr<U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj{<hb]r<j&)r<}r<(hgj<hm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<hXintegerr<r<}r<(hgUhhj<ubahkj&ubahkjubhX)r<}r<(hgUhhj{<ubhX -- r<r<}r<(hgUhhj{<ubhXThe zero based index of the first log record to return. Default is 0. Transmitted as a URL query parameter, and so must be escaped accordingly.r<r<}r<(hgXThe zero based index of the first log record to return. Default is 0. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj{<ubehkhubahkj;#ubj#)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj;hb]r<h)r<}r<(hgX.count (integer) -- The maximum number of log records that should be returned in the response. The Member Node may return fewer and the caller should check the total in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<(j")r<}r<(hgXcounthm}r<(hr]hq]j"ho]hp]ht]uhhj<hb]r<hXcountr<r<}r<(hgUhhj<ubahkj"ubhX (r<r<}r<(hgUhhj<ubj)r<}r<(hgUhm}r<(Ureftypej&j"U reftargetXintegerr<U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj<hb]r<j&)r<}r<(hgj<hm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<hXintegerr<r<}r<(hgUhhj<ubahkj&ubahkjubhX)r<}r<(hgUhhj<ubhX -- r<r<}r<(hgUhhj<ubhXThe maximum number of log records that should be returned in the response. The Member Node may return fewer and the caller should check the r<r<}r<(hgXThe maximum number of log records that should be returned in the response. The Member Node may return fewer and the caller should check the hhj<ubj$)r<}r<(hgX*total*hm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<hXtotalr<r<}r<(hgUhhj<ubahkj$ubhX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.r<r<}r<(hgX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj<ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj1;hb]r<(h)r<}r<(hgXReturnshhj<hij)hkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r<hXReturnsr<r<}r<(hgUhhj<ubaubh)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<h)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj<hb]hkhubahkhubehkhubh)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj1;hb]r<(h)r<}r<(hgX Return typehhj<hij)hkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r<hX Return typer<r<}r<(hgUhhj<ubaubh)r<}r<(hgUhm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<h)r<}r<(hgX Types.Loghm}r<(ho]hp]hq]hr]ht]uhhj<hb]r<j)r<}r<(hgX:class:`Types.Log`r<hhj<hij)hkjhm}r<(UreftypeXclassjjX Types.LogU refdomainXpyr<hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r<j)r<}r<(hgj<hm}r<(ho]hp]r<(jj<Xpy-classr<ehq]hr]ht]uhhj<hb]r<hX Types.Logr<r<}r=(hgUhhj<ubahkjubaubahkhubahkhubehkhubh)r=}r=(hgUhm}r=(ho]hp]hq]hr]ht]uhhj1;hb]r=(h)r=}r=(hgXRaiseshhj=hij)hkhhm}r=(ho]hp]hq]hr]ht]uhvKhb]r=hXRaisesr =r =}r =(hgUhhj=ubaubh)r =}r =(hgUhm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=j #)r=}r=(hgUhm}r=(ho]hp]hq]hr]ht]uhhj =hb]r=(j#)r=}r=(hgUhm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=h)r=}r=(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1470)hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=(j)r=}r=(hgUhm}r=(Ureftypej#j"U reftargetXExceptions.InvalidTokenr=U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj=hb]r =j")r!=}r"=(hgj=hm}r#=(ho]hp]hq]hr]ht]uhhj=hb]r$=hXExceptions.InvalidTokenr%=r&=}r'=(hgUhhj!=ubahkj"ubahkjubhX -- r(=r)=}r*=(hgUhhj=ubj)r+=}r,=(hgX$``(errorCode=401, detailCode=1470)``hm}r-=(ho]hp]hq]hr]ht]uhhj=hb]r.=hX (errorCode=401, detailCode=1470)r/=r0=}r1=(hgUhhj+=ubahkjubehkhubahkj;#ubj#)r2=}r3=(hgUhm}r4=(ho]hp]hq]hr]ht]uhhj=hb]r5=h)r6=}r7=(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1490)hm}r8=(ho]hp]hq]hr]ht]uhhj2=hb]r9=(j)r:=}r;=(hgUhm}r<=(Ureftypej#j"U reftargetXExceptions.ServiceFailurer==U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj6=hb]r>=j")r?=}r@=(hgj==hm}rA=(ho]hp]hq]hr]ht]uhhj:=hb]rB=hXExceptions.ServiceFailurerC=rD=}rE=(hgUhhj?=ubahkj"ubahkjubhX -- rF=rG=}rH=(hgUhhj6=ubj)rI=}rJ=(hgX$``(errorCode=500, detailCode=1490)``hm}rK=(ho]hp]hq]hr]ht]uhhj6=hb]rL=hX (errorCode=500, detailCode=1490)rM=rN=}rO=(hgUhhjI=ubahkjubehkhubahkj;#ubj#)rP=}rQ=(hgUhm}rR=(ho]hp]hq]hr]ht]uhhj=hb]rS=h)rT=}rU=(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1460)hm}rV=(ho]hp]hq]hr]ht]uhhjP=hb]rW=(j)rX=}rY=(hgUhm}rZ=(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr[=U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhjT=hb]r\=j")r]=}r^=(hgj[=hm}r_=(ho]hp]hq]hr]ht]uhhjX=hb]r`=hXExceptions.NotAuthorizedra=rb=}rc=(hgUhhj]=ubahkj"ubahkjubhX -- rd=re=}rf=(hgUhhjT=ubj)rg=}rh=(hgX$``(errorCode=401, detailCode=1460)``hm}ri=(ho]hp]hq]hr]ht]uhhjT=hb]rj=hX (errorCode=401, detailCode=1460)rk=rl=}rm=(hgUhhjg=ubahkjubehkhubahkj;#ubj#)rn=}ro=(hgUhm}rp=(ho]hp]hq]hr]ht]uhhj=hb]rq=h)rr=}rs=(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1461)hm}rt=(ho]hp]hq]hr]ht]uhhjn=hb]ru=(j)rv=}rw=(hgUhm}rx=(Ureftypej#j"U reftargetXExceptions.NotImplementedry=U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhjr=hb]rz=j")r{=}r|=(hgjy=hm}r}=(ho]hp]hq]hr]ht]uhhjv=hb]r~=hXExceptions.NotImplementedr=r=}r=(hgUhhj{=ubahkj"ubahkjubhX -- r=r=}r=(hgUhhjr=ubj)r=}r=(hgX$``(errorCode=501, detailCode=1461)``hm}r=(ho]hp]hq]hr]ht]uhhjr=hb]r=hX (errorCode=501, detailCode=1461)r=r=}r=(hgUhhj=ubahkjubehkhubahkj;#ubj#)r=}r=(hgUhm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=h)r=}r=(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1480)hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=(j)r=}r=(hgUhm}r=(Ureftypej#j"U reftargetXExceptions.InvalidRequestr=U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj=hb]r=j")r=}r=(hgj=hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=hXExceptions.InvalidRequestr=r=}r=(hgUhhj=ubahkj"ubahkjubhX -- r=r=}r=(hgUhhj=ubj)r=}r=(hgX$``(errorCode=400, detailCode=1480)``hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=hX (errorCode=400, detailCode=1480)r=r=}r=(hgUhhj=ubahkjubehkhubahkj;#ubj#)r=}r=(hgUhm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=h)r=}r=(hgXExceptions.InsufficientResources -- (errorCode=413, detailCode=1481)The request could not be serviced due to a limitation of resources - too many requests, internal service timeout, or another similar failure.hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=(j)r=}r=(hgUhm}r=(Ureftypej#j"U reftargetX Exceptions.InsufficientResourcesr=U refdomainjn:hr]hq]U refexplicitho]hp]ht]uhhj=hb]r=j")r=}r=(hgj=hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=hX Exceptions.InsufficientResourcesr=r=}r=(hgUhhj=ubahkj"ubahkjubhX -- r=r=}r=(hgUhhj=ubh)r=}r=(hgX$``(errorCode=413, detailCode=1481)``r=hhj=hij)hkhhm}r=(ho]hp]hq]hr]ht]uhvM(hb]r=j)r=}r=(hgj=hm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=hX (errorCode=413, detailCode=1481)r=r=}r=(hgUhhj=ubahkjubaubh)r=}r=(hgXThe request could not be serviced due to a limitation of resources - too many requests, internal service timeout, or another similar failure.r=hhj=hij)hkhhm}r=(ho]hp]hq]hr]ht]uhvM*hb]r=hXThe request could not be serviced due to a limitation of resources - too many requests, internal service timeout, or another similar failure.r=r=}r=(hgj=hhj=ubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r=}r=(hgUhhj)hiNhkjhm}r=(hr]hq]ho]hp]ht]Uentries]r=(jX&reserveIdentifier() (in module CNCore)hEUNtr=auhvNhwhhb]ubj!)r=}r=(hgUhhj)hiNhkj!hm}r=(j"j"Xpyr=hr]hq]ho]hp]ht]j"Xfunctionr=j"j=uhvNhwhhb]r=(j")r=}r=(hgX+reserveIdentifier(session,id) -> Identifierhhj=hij)hkj "hm}r=(hr]r=hEaj"j0)hq]ho]hp]ht]r=hEaj"XreserveIdentifierr=j"Uj"uhvMXhwhhb]r=(j")r=}r=(hgXCNCore.hhj=hij)hkj"hm}r=(ho]hp]hq]hr]ht]uhvMXhwhhb]r=hXCNCore.r=r=}r=(hgUhhj=ubaubj")r=}r=(hgj=hhj=hij)hkj!"hm}r=(ho]hp]hq]hr]ht]uhvMXhwhhb]r=hXreserveIdentifierr=r=}r=(hgUhhj=ubaubj'")r=}r=(hgX session, idhhj=hij)hkj*"hm}r=(ho]hp]hq]hr]ht]uhvMXhwhhb]r=(j-")r=}r=(hgXsessionhm}r=(ho]hp]hq]hr]ht]uhhj=hb]r=hXsessionr=r=}r=(hgUhhj=ubahkj5"ubj-")r>}r>(hgXidhm}r>(ho]hp]hq]hr]ht]uhhj=hb]r>hXidr>r>}r>(hgUhhj>ubahkj5"ubeubj6")r>}r>(hgX Identifierhhj=hij)hkj9"hm}r >(ho]hp]hq]hr]ht]uhvMXhwhhb]r >hX Identifierr >r >}r >(hgUhhj>ubaubeubj?")r>}r>(hgUhhj=hij)hkjB"hm}r>(ho]hp]hq]hr]ht]uhvMXhwhhb]r>(h)r>}r>(hgX Reserves the identifier that is unique and can not be used by any other sessions. Future calls to :func:`MNStorage.create` and :func:`MNStorage.update` that reference this ID must be made by the same :term:`principal` making the reservation, otherwise an error is raised on those methods.hhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM1hwhhb]r>(hXbReserves the identifier that is unique and can not be used by any other sessions. Future calls to r>r>}r>(hgXbReserves the identifier that is unique and can not be used by any other sessions. Future calls to hhj>ubj)r>}r>(hgX:func:`MNStorage.create`r>hhj>hij)hkjhm}r>(UreftypeXfuncjjXMNStorage.createU refdomainXpyr>hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM1hb]r>j)r>}r >(hgj>hm}r!>(ho]hp]r">(jj>Xpy-funcr#>ehq]hr]ht]uhhj>hb]r$>hXMNStorage.create()r%>r&>}r'>(hgUhhj>ubahkjubaubhX and r(>r)>}r*>(hgX and hhj>ubj)r+>}r,>(hgX:func:`MNStorage.update`r->hhj>hij)hkjhm}r.>(UreftypeXfuncjjXMNStorage.updateU refdomainXpyr/>hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM1hb]r0>j)r1>}r2>(hgj->hm}r3>(ho]hp]r4>(jj/>Xpy-funcr5>ehq]hr]ht]uhhj+>hb]r6>hXMNStorage.update()r7>r8>}r9>(hgUhhj1>ubahkjubaubhX1 that reference this ID must be made by the same r:>r;>}r<>(hgX1 that reference this ID must be made by the same hhj>ubj)r=>}r>>(hgX:term:`principal`r?>hhj>hij)hkjhm}r@>(UreftypeXtermjjX principalU refdomainXstdrA>hr]hq]U refexplicitho]hp]ht]jjuhvM1hb]rB>j`2)rC>}rD>(hgj?>hm}rE>(ho]hp]rF>(jjA>Xstd-termrG>ehq]hr]ht]uhhj=>hb]rH>hX principalrI>rJ>}rK>(hgUhhjC>ubahkji2ubaubhXG making the reservation, otherwise an error is raised on those methods.rL>rM>}rN>(hgXG making the reservation, otherwise an error is raised on those methods.hhj>ubeubh)rO>}rP>(hgXThe requested identifier is transmitted in a MIME Multipart/form-data body with *id* as key, and the identifier string as value.hhj>hij)hkhhm}rQ>(ho]hp]hq]hr]ht]uhvM3hwhhb]rR>(hXPThe requested identifier is transmitted in a MIME Multipart/form-data body with rS>rT>}rU>(hgXPThe requested identifier is transmitted in a MIME Multipart/form-data body with hhjO>ubj$)rV>}rW>(hgX*id*hm}rX>(ho]hp]hq]hr]ht]uhhjO>hb]rY>hXidrZ>r[>}r\>(hgUhhjV>ubahkj$ubhX, as key, and the identifier string as value.r]>r^>}r_>(hgX, as key, and the identifier string as value.hhjO>ubeubh)r`>}ra>(hgXPv2.0: The identifier being reserved may be used as a :term:`PID` or :term:`SID`.hhj>hij)hkhhm}rb>(ho]hp]hq]hr]ht]uhvM5hwhhb]rc>(hX5v2.0: The identifier being reserved may be used as a rd>re>}rf>(hgX5v2.0: The identifier being reserved may be used as a hhj`>ubj)rg>}rh>(hgX :term:`PID`ri>hhj`>hij)hkjhm}rj>(UreftypeXtermjjXpidU refdomainXstdrk>hr]hq]U refexplicitho]hp]ht]jjuhvM5hb]rl>j`2)rm>}rn>(hgji>hm}ro>(ho]hp]rp>(jjk>Xstd-termrq>ehq]hr]ht]uhhjg>hb]rr>hXPIDrs>rt>}ru>(hgUhhjm>ubahkji2ubaubhX or rv>rw>}rx>(hgX or hhj`>ubj)ry>}rz>(hgX :term:`SID`r{>hhj`>hij)hkjhm}r|>(UreftypeXtermjjXsidU refdomainXstdr}>hr]hq]U refexplicitho]hp]ht]jjuhvM5hb]r~>j`2)r>}r>(hgj{>hm}r>(ho]hp]r>(jj}>Xstd-termr>ehq]hr]ht]uhhjy>hb]r>hXSIDr>r>}r>(hgUhhj>ubahkji2ubaubhX.r>}r>(hgX.hhj`>ubeubh)r>}r>(hgUhhj>hiNhkhhm}r>(ho]hp]hq]hr]ht]uhvNhwhhb]r>(h)r>}r>(hgUhhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM7hwhhb]r>(h)r>}r>(hgXVersionhhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvKhb]r>hXVersionr>r>}r>(hgUhhj>ubaubh)r>}r>(hgX1.0, 2.0r>hm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>h)r>}r>(hgj>hhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM7hb]r>hX1.0, 2.0r>r>}r>(hgj>hhj>ubaubahkhubeubh)r>}r>(hgUhhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM8hwhhb]r>(h)r>}r>(hgX Use Caseshhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvKhb]r>hX Use Casesr>r>}r>(hgUhhj>ubaubh)r>}r>(hgX$:doc:`UC16 `r>hm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>h)r>}r>(hgj>hhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM9hb]r>j)r>}r>(hgj>hhj>hij)hkjhm}r>(UreftypeXdocr>jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvM9hb]r>j`2)r>}r>(hgj>hm}r>(ho]hp]r>(jj>ehq]hr]ht]uhhj>hb]r>hXUC16r>r>}r>(hgUhhj>ubahkji2ubaubaubahkhubeubh)r>}r>(hgUhhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM:hwhhb]r>(h)r>}r>(hgXREST URLhhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvKhb]r>hXREST URLr>r>}r>(hgUhhj>ubaubh)r>}r>(hgX``POST /reserve``r>hm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>h)r>}r>(hgj>hhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvM:hb]r>j)r>}r>(hgj>hm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>hX POST /reserver>r>}r>(hgUhhj>ubahkjubaubahkhubeubh)r>}r>(hgUhm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>(h)r>}r>(hgX Parametershhj>hij)hkhhm}r>(ho]hp]hq]hr]ht]uhvKhb]r>hX Parametersr>r>}r>(hgUhhj>ubaubh)r>}r>(hgUhm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>j #)r>}r>(hgUhm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>(j#)r>}r>(hgUhm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>h)r>}r>(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r>(ho]hp]hq]hr]ht]uhhj>hb]r>(j")r>}r>(hgXsessionhm}r>(hr]hq]j"ho]hp]ht]uhhj>hb]r>hXsessionr?r?}r?(hgUhhj>ubahkj"ubhX (r?r?}r?(hgUhhj>ubj)r?}r?(hgX:class:`Types.Session`r?hhj>hij)hkjhm}r ?(UreftypeXclassjjX Types.SessionU refdomainXpyr ?hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM<hb]r ?j)r ?}r ?(hgj?hm}r?(ho]hp]r?(jj ?Xpy-classr?ehq]hr]ht]uhhj?hb]r?hX Types.Sessionr?r?}r?(hgUhhj ?ubahkjubaubhX)r?}r?(hgUhhj>ubhX -- r?r?}r?(hgUhhj>ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r?r?}r?(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj>ubj)r?}r?(hgX:term:`public user`r?hhj>hij)hkjhm}r ?(UreftypeXtermjjX public userU refdomainXstdr!?hr]hq]U refexplicitho]hp]ht]jjuhvM;hb]r"?j`2)r#?}r$?(hgj?hm}r%?(ho]hp]r&?(jj!?Xstd-termr'?ehq]hr]ht]uhhj?hb]r(?hX public userr)?r*?}r+?(hgUhhj#?ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r,?r-?}r.?(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj>ubehkhubahkj;#ubj#)r/?}r0?(hgUhm}r1?(ho]hp]hq]hr]ht]uhhj>hb]r2?h)r3?}r4?(hgXid (Types.Identifier) -- The identifier that is to be reserved. May be a PID or a SID value. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r5?(ho]hp]hq]hr]ht]uhhj/?hb]r6?(j")r7?}r8?(hgXidhm}r9?(hr]hq]j"ho]hp]ht]uhhj3?hb]r:?hXidr;?r?r??}r@?(hgUhhj3?ubj)rA?}rB?(hgX:class:`Types.Identifier`rC?hhj3?hij)hkjhm}rD?(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrE?hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM?hb]rF?j)rG?}rH?(hgjC?hm}rI?(ho]hp]rJ?(jjE?Xpy-classrK?ehq]hr]ht]uhhjA?hb]rL?hXTypes.IdentifierrM?rN?}rO?(hgUhhjG?ubahkjubaubhX)rP?}rQ?(hgUhhj3?ubhX -- rR?rS?}rT?(hgUhhj3?ubhXgThe identifier that is to be reserved. May be a PID or a SID value. Transmitted as a UTF-8 String as a rU?rV?}rW?(hgXgThe identifier that is to be reserved. May be a PID or a SID value. Transmitted as a UTF-8 String as a hhj3?ubj$)rX?}rY?(hgX *Param part*hm}rZ?(ho]hp]hq]hr]ht]uhhj3?hb]r[?hX Param partr\?r]?}r^?(hgUhhjX?ubahkj$ubhX% of the MIME multipart/mixed message.r_?r`?}ra?(hgX% of the MIME multipart/mixed message.hhj3?ubehkhubahkj;#ubehkj#ubahkhubehkhubh)rb?}rc?(hgUhm}rd?(ho]hp]hq]hr]ht]uhhj>hb]re?(h)rf?}rg?(hgXReturnshhjb?hij)hkhhm}rh?(ho]hp]hq]hr]ht]uhvKhb]ri?hXReturnsrj?rk?}rl?(hgUhhjf?ubaubh)rm?}rn?(hgUhm}ro?(ho]hp]hq]hr]ht]uhhjb?hb]rp?h)rq?}rr?(hgX The identifier that was reservedhm}rs?(ho]hp]hq]hr]ht]uhhjm?hb]rt?hX The identifier that was reservedru?rv?}rw?(hgX The identifier that was reservedhhjq?ubahkhubahkhubehkhubh)rx?}ry?(hgUhm}rz?(ho]hp]hq]hr]ht]uhhj>hb]r{?(h)r|?}r}?(hgX Return typehhjx?hij)hkhhm}r~?(ho]hp]hq]hr]ht]uhvKhb]r?hX Return typer?r?}r?(hgUhhj|?ubaubh)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhjx?hb]r?h)r?}r?(hgXTypes.Identifierhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?j)r?}r?(hgX:class:`Types.Identifier`r?hhj?hij)hkjhm}r?(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr?hr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMBhb]r?j)r?}r?(hgj?hm}r?(ho]hp]r?(jj?Xpy-classr?ehq]hr]ht]uhhj?hb]r?hXTypes.Identifierr?r?}r?(hgUhhj?ubahkjubaubahkhubahkhubehkhubh)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj>hb]r?(h)r?}r?(hgXRaiseshhj?hij)hkhhm}r?(ho]hp]hq]hr]ht]uhvKhb]r?hXRaisesr?r?}r?(hgUhhj?ubaubh)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?j #)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?(j#)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?h)r?}r?(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4190)hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?(j)r?}r?(hgUhm}r?(Ureftypej#j"U reftargetXExceptions.InvalidTokenr?U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhj?hb]r?j")r?}r?(hgj?hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?hXExceptions.InvalidTokenr?r?}r?(hgUhhj?ubahkj"ubahkjubhX -- r?r?}r?(hgUhhj?ubj)r?}r?(hgX$``(errorCode=401, detailCode=4190)``hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?hX (errorCode=401, detailCode=4190)r?r?}r?(hgUhhj?ubahkjubehkhubahkj;#ubj#)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?h)r?}r?(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4210)hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?(j)r?}r?(hgUhm}r?(Ureftypej#j"U reftargetXExceptions.ServiceFailurer?U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhj?hb]r?j")r?}r?(hgj?hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?hXExceptions.ServiceFailurer?r?}r?(hgUhhj?ubahkj"ubahkjubhX -- r?r?}r?(hgUhhj?ubj)r?}r?(hgX$``(errorCode=500, detailCode=4210)``hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?hX (errorCode=500, detailCode=4210)r?r?}r?(hgUhhj?ubahkjubehkhubahkj;#ubj#)r?}r?(hgUhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?h)r?}r?(hgXoExceptions.NotAuthorized -- (errorCode=401, detailCode=4180)Supplied credentials does not have WRITE permissionhm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?(j)r?}r?(hgUhm}r?(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr?U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhj?hb]r?j")r?}r?(hgj?hm}r?(ho]hp]hq]hr]ht]uhhj?hb]r?hXExceptions.NotAuthorizedr?r?}r?(hgUhhj?ubahkj"ubahkjubhX -- r?r?}r?(hgUhhj?ubh)r@}r@(hgX$``(errorCode=401, detailCode=4180)``r@hhj?hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvMHhb]r@j)r@}r@(hgj@hm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@hX (errorCode=401, detailCode=4180)r @r @}r @(hgUhhj@ubahkjubaubh)r @}r @(hgX3Supplied credentials does not have WRITE permissionr@hhj?hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvMJhb]r@hX3Supplied credentials does not have WRITE permissionr@r@}r@(hgj@hhj @ubaubehkhubahkj;#ubj#)r@}r@(hgUhm}r@(ho]hp]hq]hr]ht]uhhj?hb]r@h)r@}r@(hgXExceptions.InvalidRequest -- (errorCode=400, detailCode=4200)The identifier requested is not a valid format accepted by this servicehm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@(j)r@}r@(hgUhm}r@(Ureftypej#j"U reftargetXExceptions.InvalidRequestr@U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhj@hb]r @j")r!@}r"@(hgj@hm}r#@(ho]hp]hq]hr]ht]uhhj@hb]r$@hXExceptions.InvalidRequestr%@r&@}r'@(hgUhhj!@ubahkj"ubahkjubhX -- r(@r)@}r*@(hgUhhj@ubh)r+@}r,@(hgX$``(errorCode=400, detailCode=4200)``r-@hhj@hij)hkhhm}r.@(ho]hp]hq]hr]ht]uhvMLhb]r/@j)r0@}r1@(hgj-@hm}r2@(ho]hp]hq]hr]ht]uhhj+@hb]r3@hX (errorCode=400, detailCode=4200)r4@r5@}r6@(hgUhhj0@ubahkjubaubh)r7@}r8@(hgXGThe identifier requested is not a valid format accepted by this servicer9@hhj@hij)hkhhm}r:@(ho]hp]hq]hr]ht]uhvMNhb]r;@hXGThe identifier requested is not a valid format accepted by this servicer<@r=@}r>@(hgj9@hhj7@ubaubehkhubahkj;#ubj#)r?@}r@@(hgUhm}rA@(ho]hp]hq]hr]ht]uhhj?hb]rB@h)rC@}rD@(hgXExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=4210)The requested identifier can not be reserved because it already exists in the DataONE system or has already been reserved.hm}rE@(ho]hp]hq]hr]ht]uhhj?@hb]rF@(j)rG@}rH@(hgUhm}rI@(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerJ@U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhjC@hb]rK@j")rL@}rM@(hgjJ@hm}rN@(ho]hp]hq]hr]ht]uhhjG@hb]rO@hXExceptions.IdentifierNotUniquerP@rQ@}rR@(hgUhhjL@ubahkj"ubahkjubhX -- rS@rT@}rU@(hgUhhjC@ubh)rV@}rW@(hgX$``(errorCode=409, detailCode=4210)``rX@hhjC@hij)hkhhm}rY@(ho]hp]hq]hr]ht]uhvMPhb]rZ@j)r[@}r\@(hgjX@hm}r]@(ho]hp]hq]hr]ht]uhhjV@hb]r^@hX (errorCode=409, detailCode=4210)r_@r`@}ra@(hgUhhj[@ubahkjubaubh)rb@}rc@(hgXzThe requested identifier can not be reserved because it already exists in the DataONE system or has already been reserved.rd@hhjC@hij)hkhhm}re@(ho]hp]hq]hr]ht]uhvMRhb]rf@hXzThe requested identifier can not be reserved because it already exists in the DataONE system or has already been reserved.rg@rh@}ri@(hgjd@hhjb@ubaubehkhubahkj;#ubj#)rj@}rk@(hgUhm}rl@(ho]hp]hq]hr]ht]uhhj?hb]rm@h)rn@}ro@(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4191)hm}rp@(ho]hp]hq]hr]ht]uhhjj@hb]rq@(j)rr@}rs@(hgUhm}rt@(Ureftypej#j"U reftargetXExceptions.NotImplementedru@U refdomainj=hr]hq]U refexplicitho]hp]ht]uhhjn@hb]rv@j")rw@}rx@(hgju@hm}ry@(ho]hp]hq]hr]ht]uhhjr@hb]rz@hXExceptions.NotImplementedr{@r|@}r}@(hgUhhjw@ubahkj"ubahkjubhX -- r~@r@}r@(hgUhhjn@ubj)r@}r@(hgX$``(errorCode=501, detailCode=4191)``hm}r@(ho]hp]hq]hr]ht]uhhjn@hb]r@hX (errorCode=501, detailCode=4191)r@r@}r@(hgUhhj@ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r@}r@(hgUhhj)hiNhkjhm}r@(hr]hq]ho]hp]ht]Uentries]r@(jX'generateIdentifier() (in module CNCore)hUNtr@auhvNhwhhb]ubj!)r@}r@(hgUhhj)hiNhkj!hm}r@(j"j"Xpyr@hr]hq]ho]hp]ht]j"Xfunctionr@j"j@uhvNhwhhb]r@(j")r@}r@(hgX;generateIdentifier(session,scheme,[fragment]) -> Identifierhhj@hij)hkj "hm}r@(hr]r@haj"j0)hq]ho]hp]ht]r@haj"XgenerateIdentifierr@j"Uj"uhvM~hwhhb]r@(j")r@}r@(hgXCNCore.hhj@hij)hkj"hm}r@(ho]hp]hq]hr]ht]uhvM~hwhhb]r@hXCNCore.r@r@}r@(hgUhhj@ubaubj")r@}r@(hgj@hhj@hij)hkj!"hm}r@(ho]hp]hq]hr]ht]uhvM~hwhhb]r@hXgenerateIdentifierr@r@}r@(hgUhhj@ubaubj'")r@}r@(hgXsession, scheme, [fragment]hhj@hij)hkj*"hm}r@(ho]hp]hq]hr]ht]uhvM~hwhhb]r@(j-")r@}r@(hgXsessionhm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@hXsessionr@r@}r@(hgUhhj@ubahkj5"ubj-")r@}r@(hgXschemehm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@hXschemer@r@}r@(hgUhhj@ubahkj5"ubj:)r@}r@(hgX [fragment]hm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@j-")r@}r@(hgXfragmenthm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@hXfragmentr@r@}r@(hgUhhj@ubahkj5"ubahkj:ubeubj6")r@}r@(hgX Identifierhhj@hij)hkj9"hm}r@(ho]hp]hq]hr]ht]uhvM~hwhhb]r@hX Identifierr@r@}r@(hgUhhj@ubaubeubj?")r@}r@(hgUhhj@hij)hkjB"hm}r@(ho]hp]hq]hr]ht]uhvM~hwhhb]r@(h)r@}r@(hgXGiven a scheme and optional fragment, generates an identifier with that scheme and fragment that is unique. Returned identifier may be used as either a PID or a SID.r@hhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvM[hwhhb]r@hXGiven a scheme and optional fragment, generates an identifier with that scheme and fragment that is unique. Returned identifier may be used as either a PID or a SID.r@r@}r@(hgj@hhj@ubaubh)r@}r@(hgX7The message body is encoded as MIME Multipart/form-datar@hhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvM]hwhhb]r@hX7The message body is encoded as MIME Multipart/form-datar@r@}r@(hgj@hhj@ubaubh)r@}r@(hgUhhj@hiNhkhhm}r@(ho]hp]hq]hr]ht]uhvNhwhhb]r@(h)r@}r@(hgUhhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvM_hwhhb]r@(h)r@}r@(hgXVersionhhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvKhb]r@hXVersionr@r@}r@(hgUhhj@ubaubh)r@}r@(hgX 1.0, (2.0)r@hm}r@(ho]hp]hq]hr]ht]uhhj@hb]r@h)r@}r@(hgj@hhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvM_hb]r@hX 1.0, (2.0)r@r@}r@(hgj@hhj@ubaubahkhubeubh)r@}r@(hgUhhj@hij)hkhhm}r@(ho]hp]hq]hr]ht]uhvM`hwhhb]r@(h)r@}rA(hgX Use Caseshhj@hij)hkhhm}rA(ho]hp]hq]hr]ht]uhvKhb]rAhX Use CasesrArA}rA(hgUhhj@ubaubh)rA}rA(hgX$:doc:`UC16 `rAhm}r A(ho]hp]hq]hr]ht]uhhj@hb]r Ah)r A}r A(hgjAhhjAhij)hkhhm}r A(ho]hp]hq]hr]ht]uhvMahb]rAj)rA}rA(hgjAhhj Ahij)hkjhm}rA(UreftypeXdocrAjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMahb]rAj`2)rA}rA(hgjAhm}rA(ho]hp]rA(jjAehq]hr]ht]uhhjAhb]rAhXUC16rArA}rA(hgUhhjAubahkji2ubaubaubahkhubeubh)rA}rA(hgUhhj@hij)hkhhm}rA(ho]hp]hq]hr]ht]uhvMbhwhhb]rA(h)r A}r!A(hgXREST URLhhjAhij)hkhhm}r"A(ho]hp]hq]hr]ht]uhvKhb]r#AhXREST URLr$Ar%A}r&A(hgUhhj Aubaubh)r'A}r(A(hgX``POST /generate``r)Ahm}r*A(ho]hp]hq]hr]ht]uhhjAhb]r+Ah)r,A}r-A(hgj)Ahhj'Ahij)hkhhm}r.A(ho]hp]hq]hr]ht]uhvMbhb]r/Aj)r0A}r1A(hgj)Ahm}r2A(ho]hp]hq]hr]ht]uhhj,Ahb]r3AhXPOST /generater4Ar5A}r6A(hgUhhj0Aubahkjubaubahkhubeubh)r7A}r8A(hgUhm}r9A(ho]hp]hq]hr]ht]uhhj@hb]r:A(h)r;A}rAhX Parametersr?Ar@A}rAA(hgUhhj;Aubaubh)rBA}rCA(hgUhm}rDA(ho]hp]hq]hr]ht]uhhj7Ahb]rEAj #)rFA}rGA(hgUhm}rHA(ho]hp]hq]hr]ht]uhhjBAhb]rIA(j#)rJA}rKA(hgUhm}rLA(ho]hp]hq]hr]ht]uhhjFAhb]rMAh)rNA}rOA(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rPA(ho]hp]hq]hr]ht]uhhjJAhb]rQA(j")rRA}rSA(hgXsessionhm}rTA(hr]hq]j"ho]hp]ht]uhhjNAhb]rUAhXsessionrVArWA}rXA(hgUhhjRAubahkj"ubhX (rYArZA}r[A(hgUhhjNAubj)r\A}r]A(hgX:class:`Types.Session`r^AhhjNAhij)hkjhm}r_A(UreftypeXclassjjX Types.SessionU refdomainXpyr`Ahr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMdhb]raAj)rbA}rcA(hgj^Ahm}rdA(ho]hp]reA(jj`AXpy-classrfAehq]hr]ht]uhhj\Ahb]rgAhX Types.SessionrhAriA}rjA(hgUhhjbAubahkjubaubhX)rkA}rlA(hgUhhjNAubhX -- rmArnA}roA(hgUhhjNAubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rpArqA}rrA(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjNAubj)rsA}rtA(hgX:term:`public user`ruAhhjNAhij)hkjhm}rvA(UreftypeXtermjjX public userU refdomainXstdrwAhr]hq]U refexplicitho]hp]ht]jjuhvMchb]rxAj`2)ryA}rzA(hgjuAhm}r{A(ho]hp]r|A(jjwAXstd-termr}Aehq]hr]ht]uhhjsAhb]r~AhX public userrArA}rA(hgUhhjyAubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rArA}rA(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjNAubehkhubahkj;#ubj#)rA}rA(hgUhm}rA(ho]hp]hq]hr]ht]uhhjFAhb]rAh)rA}rA(hgXscheme (string) -- The name of the identifier scheme to be used, drawn from a DataONE-specific vocabulary of identifier scheme names, including several common syntaxes such as DOI, ARK, LSID, UUID, and LSRN, among others. The first version of this method only supports the UUID scheme, and ignores the fragment parameter. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rA(ho]hp]hq]hr]ht]uhhjAhb]rA(j")rA}rA(hgXschemehm}rA(hr]hq]j"ho]hp]ht]uhhjAhb]rAhXschemerArA}rA(hgUhhjAubahkj"ubhX (rArA}rA(hgUhhjAubj)rA}rA(hgUhm}rA(Ureftypej&j"U reftargetXstringrAU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhjAhb]rAj&)rA}rA(hgjAhm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAhXstringrArA}rA(hgUhhjAubahkj&ubahkjubhX)rA}rA(hgUhhjAubhX -- rArA}rA(hgUhhjAubhXSThe name of the identifier scheme to be used, drawn from a DataONE-specific vocabulary of identifier scheme names, including several common syntaxes such as DOI, ARK, LSID, UUID, and LSRN, among others. The first version of this method only supports the UUID scheme, and ignores the fragment parameter. Transmitted as a UTF-8 String as a rArA}rA(hgXSThe name of the identifier scheme to be used, drawn from a DataONE-specific vocabulary of identifier scheme names, including several common syntaxes such as DOI, ARK, LSID, UUID, and LSRN, among others. The first version of this method only supports the UUID scheme, and ignores the fragment parameter. Transmitted as a UTF-8 String as a hhjAubj$)rA}rA(hgX *Param part*hm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAhX Param partrArA}rA(hgUhhjAubahkj$ubhX% of the MIME multipart/mixed message.rArA}rA(hgX% of the MIME multipart/mixed message.hhjAubehkhubahkj;#ubj#)rA}rA(hgUhm}rA(ho]hp]hq]hr]ht]uhhjFAhb]rAh)rA}rA(hgXfragment (string) -- The optional fragment to include in the generated Identifier. This parameter is optional and may not be present in the message body. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rA(ho]hp]hq]hr]ht]uhhjAhb]rA(j")rA}rA(hgXfragmenthm}rA(hr]hq]j"ho]hp]ht]uhhjAhb]rAhXfragmentrArA}rA(hgUhhjAubahkj"ubhX (rArA}rA(hgUhhjAubj)rA}rA(hgUhm}rA(Ureftypej&j"U reftargetXstringrAU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhjAhb]rAj&)rA}rA(hgjAhm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAhXstringrArA}rA(hgUhhjAubahkj&ubahkjubhX)rA}rA(hgUhhjAubhX -- rArA}rA(hgUhhjAubhXThe optional fragment to include in the generated Identifier. This parameter is optional and may not be present in the message body. Transmitted as a UTF-8 String as a rArA}rA(hgXThe optional fragment to include in the generated Identifier. This parameter is optional and may not be present in the message body. Transmitted as a UTF-8 String as a hhjAubj$)rA}rA(hgX *Param part*hm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAhX Param partrArA}rA(hgUhhjAubahkj$ubhX% of the MIME multipart/mixed message.rArA}rA(hgX% of the MIME multipart/mixed message.hhjAubehkhubahkj;#ubehkj#ubahkhubehkhubh)rA}rA(hgUhm}rA(ho]hp]hq]hr]ht]uhhj@hb]rA(h)rA}rA(hgXReturnshhjAhij)hkhhm}rA(ho]hp]hq]hr]ht]uhvKhb]rAhXReturnsrArA}rA(hgUhhjAubaubh)rA}rA(hgUhm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAh)rA}rA(hgX!The identifier that was generatedhm}rA(ho]hp]hq]hr]ht]uhhjAhb]rAhX!The identifier that was generatedrArA}rA(hgX!The identifier that was generatedhhjAubahkhubahkhubehkhubh)rA}rA(hgUhm}rA(ho]hp]hq]hr]ht]uhhj@hb]rA(h)rA}rB(hgX Return typehhjAhij)hkhhm}rB(ho]hp]hq]hr]ht]uhvKhb]rBhX Return typerBrB}rB(hgUhhjAubaubh)rB}rB(hgUhm}rB(ho]hp]hq]hr]ht]uhhjAhb]r Bh)r B}r B(hgXTypes.Identifierhm}r B(ho]hp]hq]hr]ht]uhhjBhb]r Bj)rB}rB(hgX:class:`Types.Identifier`rBhhj Bhij)hkjhm}rB(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrBhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMmhb]rBj)rB}rB(hgjBhm}rB(ho]hp]rB(jjBXpy-classrBehq]hr]ht]uhhjBhb]rBhXTypes.IdentifierrBrB}rB(hgUhhjBubahkjubaubahkhubahkhubehkhubh)rB}rB(hgUhm}rB(ho]hp]hq]hr]ht]uhhj@hb]r B(h)r!B}r"B(hgXRaiseshhjBhij)hkhhm}r#B(ho]hp]hq]hr]ht]uhvKhb]r$BhXRaisesr%Br&B}r'B(hgUhhj!Bubaubh)r(B}r)B(hgUhm}r*B(ho]hp]hq]hr]ht]uhhjBhb]r+Bj #)r,B}r-B(hgUhm}r.B(ho]hp]hq]hr]ht]uhhj(Bhb]r/B(j#)r0B}r1B(hgUhm}r2B(ho]hp]hq]hr]ht]uhhj,Bhb]r3Bh)r4B}r5B(hgXExceptions.InvalidToken -- (errorCode=401, detailCode=4190)The supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.hm}r6B(ho]hp]hq]hr]ht]uhhj0Bhb]r7B(j)r8B}r9B(hgUhm}r:B(Ureftypej#j"U reftargetXExceptions.InvalidTokenr;BU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhj4Bhb]rB(hgj;Bhm}r?B(ho]hp]hq]hr]ht]uhhj8Bhb]r@BhXExceptions.InvalidTokenrABrBB}rCB(hgUhhj=Bubahkj"ubahkjubhX -- rDBrEB}rFB(hgUhhj4Bubh)rGB}rHB(hgX$``(errorCode=401, detailCode=4190)``rIBhhj4Bhij)hkhhm}rJB(ho]hp]hq]hr]ht]uhvMohb]rKBj)rLB}rMB(hgjIBhm}rNB(ho]hp]hq]hr]ht]uhhjGBhb]rOBhX (errorCode=401, detailCode=4190)rPBrQB}rRB(hgUhhjLBubahkjubaubh)rSB}rTB(hgXwThe supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.rUBhhj4Bhij)hkhhm}rVB(ho]hp]hq]hr]ht]uhvMqhb]rWBhXwThe supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.rXBrYB}rZB(hgjUBhhjSBubaubehkhubahkj;#ubj#)r[B}r\B(hgUhm}r]B(ho]hp]hq]hr]ht]uhhj,Bhb]r^Bh)r_B}r`B(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4210)hm}raB(ho]hp]hq]hr]ht]uhhj[Bhb]rbB(j)rcB}rdB(hgUhm}reB(Ureftypej#j"U reftargetXExceptions.ServiceFailurerfBU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhj_Bhb]rgBj")rhB}riB(hgjfBhm}rjB(ho]hp]hq]hr]ht]uhhjcBhb]rkBhXExceptions.ServiceFailurerlBrmB}rnB(hgUhhjhBubahkj"ubahkjubhX -- roBrpB}rqB(hgUhhj_Bubj)rrB}rsB(hgX$``(errorCode=500, detailCode=4210)``hm}rtB(ho]hp]hq]hr]ht]uhhj_Bhb]ruBhX (errorCode=500, detailCode=4210)rvBrwB}rxB(hgUhhjrBubahkjubehkhubahkj;#ubj#)ryB}rzB(hgUhm}r{B(ho]hp]hq]hr]ht]uhhj,Bhb]r|Bh)r}B}r~B(hgXoExceptions.NotAuthorized -- (errorCode=401, detailCode=4180)Supplied credentials does not have WRITE permissionhm}rB(ho]hp]hq]hr]ht]uhhjyBhb]rB(j)rB}rB(hgUhm}rB(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrBU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhj}Bhb]rBj")rB}rB(hgjBhm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhXExceptions.NotAuthorizedrBrB}rB(hgUhhjBubahkj"ubahkjubhX -- rBrB}rB(hgUhhj}Bubh)rB}rB(hgX$``(errorCode=401, detailCode=4180)``rBhhj}Bhij)hkhhm}rB(ho]hp]hq]hr]ht]uhvMuhb]rBj)rB}rB(hgjBhm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhX (errorCode=401, detailCode=4180)rBrB}rB(hgUhhjBubahkjubaubh)rB}rB(hgX3Supplied credentials does not have WRITE permissionrBhhj}Bhij)hkhhm}rB(ho]hp]hq]hr]ht]uhvMwhb]rBhX3Supplied credentials does not have WRITE permissionrBrB}rB(hgjBhhjBubaubehkhubahkj;#ubj#)rB}rB(hgUhm}rB(ho]hp]hq]hr]ht]uhhj,Bhb]rBh)rB}rB(hgX~Exceptions.InvalidRequest -- (errorCode=400, detailCode=4200)The schme requested is not a valid schme accepted by this servicehm}rB(ho]hp]hq]hr]ht]uhhjBhb]rB(j)rB}rB(hgUhm}rB(Ureftypej#j"U reftargetXExceptions.InvalidRequestrBU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhjBhb]rBj")rB}rB(hgjBhm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhXExceptions.InvalidRequestrBrB}rB(hgUhhjBubahkj"ubahkjubhX -- rBrB}rB(hgUhhjBubh)rB}rB(hgX$``(errorCode=400, detailCode=4200)``rBhhjBhij)hkhhm}rB(ho]hp]hq]hr]ht]uhvMyhb]rBj)rB}rB(hgjBhm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhX (errorCode=400, detailCode=4200)rBrB}rB(hgUhhjBubahkjubaubh)rB}rB(hgXAThe schme requested is not a valid schme accepted by this servicerBhhjBhij)hkhhm}rB(ho]hp]hq]hr]ht]uhvM{hb]rBhXAThe schme requested is not a valid schme accepted by this servicerBrB}rB(hgjBhhjBubaubehkhubahkj;#ubj#)rB}rB(hgUhm}rB(ho]hp]hq]hr]ht]uhhj,Bhb]rBh)rB}rB(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4191)hm}rB(ho]hp]hq]hr]ht]uhhjBhb]rB(j)rB}rB(hgUhm}rB(Ureftypej#j"U reftargetXExceptions.NotImplementedrBU refdomainj@hr]hq]U refexplicitho]hp]ht]uhhjBhb]rBj")rB}rB(hgjBhm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhXExceptions.NotImplementedrBrB}rB(hgUhhjBubahkj"ubahkjubhX -- rBrB}rB(hgUhhjBubj)rB}rB(hgX$``(errorCode=501, detailCode=4191)``hm}rB(ho]hp]hq]hr]ht]uhhjBhb]rBhX (errorCode=501, detailCode=4191)rBrB}rB(hgUhhjBubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubjY:)rB}rB(hgUhhj)hij)hkj]:hm}rB(hr]hq]ho]hp]ht]UrefidrBUindex-0rBuhvNhwhhb]ubcsphinx.ext.todo todo_node rB)rB}rB(hgX9Need to provide a list of recommended identifier schemes.rBhhj)hij)Uexpect_referenced_by_namerB}hkU todo_noderBhm}rB(ho]hp]rBUadmonition-todorBahq]hr]rBjBaht]uhvMhwhUexpect_referenced_by_idrB}rBjBjBshb]rB(hy)rB}rC(hgXTodorChm}rC(ho]hp]hq]hr]ht]uhhjBhb]rChXTodorCrC}rC(hgUhhjBubahkh}ubh)rC}rC(hgjBhhjBhij)hkhhm}r C(ho]hp]hq]hr]ht]uhvMhb]r ChX9Need to provide a list of recommended identifier schemes.r Cr C}r C(hgjBhhjCubaubeubj)rC}rC(hgUhhj)hiNhkjhm}rC(hr]hq]ho]hp]ht]Uentries]rC(jX+listChecksumAlgorithms() (in module CNCore)h>UNtrCauhvNhwhhb]ubj!)rC}rC(hgUhhj)hiNhkj!hm}rC(j"j"XpyrChr]hq]ho]hp]ht]j"XfunctionrCj"jCuhvNhwhhb]rC(j")rC}rC(hgX1listChecksumAlgorithms() -> ChecksumAlgorithmListhhjChij)hkj "hm}rC(hr]rCh>aj"j0)hq]ho]hp]ht]rCh>aj"XlistChecksumAlgorithmsrCj"Uj"uhvMhwhhb]rC(j")r C}r!C(hgXCNCore.hhjChij)hkj"hm}r"C(ho]hp]hq]hr]ht]uhvMhwhhb]r#ChXCNCore.r$Cr%C}r&C(hgUhhj Cubaubj")r'C}r(C(hgjChhjChij)hkj!"hm}r)C(ho]hp]hq]hr]ht]uhvMhwhhb]r*ChXlistChecksumAlgorithmsr+Cr,C}r-C(hgUhhj'Cubaubj'")r.C}r/C(hgUhhjChij)hkj*"hm}r0C(ho]hp]hq]hr]ht]uhvMhwhhb]ubj6")r1C}r2C(hgXChecksumAlgorithmListhhjChij)hkj9"hm}r3C(ho]hp]hq]hr]ht]uhvMhwhhb]r4ChXChecksumAlgorithmListr5Cr6C}r7C(hgUhhj1Cubaubeubj?")r8C}r9C(hgUhhjChij)hkjB"hm}r:C(ho]hp]hq]hr]ht]uhvMhwhhb]r;C(h)rChhj8Chij)hkhhm}r?C(ho]hp]hq]hr]ht]uhvMhwhhb]r@ChXDReturns a list of checksum algorithms that are supported by DataONE.rACrBC}rCC(hgj>Chhj booleanhhj Dhij)hkj "hm}r(D(hr]r)Dhaj"j0)hq]ho]hp]ht]r*Dhaj"XsetObsoletedByr+Dj"Uj"uhvMhwhhb]r,D(j")r-D}r.D(hgXCNCore.hhj&Dhij)hkj"hm}r/D(ho]hp]hq]hr]ht]uhvMhwhhb]r0DhXCNCore.r1Dr2D}r3D(hgUhhj-Dubaubj")r4D}r5D(hgj+Dhhj&Dhij)hkj!"hm}r6D(ho]hp]hq]hr]ht]uhvMhwhhb]r7DhXsetObsoletedByr8Dr9D}r:D(hgUhhj4Dubaubj'")r;D}rD(j-")r?D}r@D(hgXsessionhm}rAD(ho]hp]hq]hr]ht]uhhj;Dhb]rBDhXsessionrCDrDD}rED(hgUhhj?Dubahkj5"ubj-")rFD}rGD(hgXpidhm}rHD(ho]hp]hq]hr]ht]uhhj;Dhb]rIDhXpidrJDrKD}rLD(hgUhhjFDubahkj5"ubj-")rMD}rND(hgXobsoletedByPidhm}rOD(ho]hp]hq]hr]ht]uhhj;Dhb]rPDhXobsoletedByPidrQDrRD}rSD(hgUhhjMDubahkj5"ubj-")rTD}rUD(hgX serialVersionhm}rVD(ho]hp]hq]hr]ht]uhhj;Dhb]rWDhX serialVersionrXDrYD}rZD(hgUhhjTDubahkj5"ubeubj6")r[D}r\D(hgXbooleanhhj&Dhij)hkj9"hm}r]D(ho]hp]hq]hr]ht]uhvMhwhhb]r^DhXbooleanr_Dr`D}raD(hgUhhj[Dubaubeubj?")rbD}rcD(hgUhhj Dhij)hkjB"hm}rdD(ho]hp]hq]hr]ht]uhvMhwhhb]reD(h)rfD}rgD(hgXUpdates the :attr:`Types.SystemMetadata.obsoletedBy` property for an object, indicating that the object specified by *pid* has been obsoleted by the identifier in *obsoletedByPid*.hhjbDhij)hkhhm}rhD(ho]hp]hq]hr]ht]uhvMhwhhb]riD(hX Updates the rjDrkD}rlD(hgX Updates the hhjfDubj)rmD}rnD(hgX(:attr:`Types.SystemMetadata.obsoletedBy`roDhhjfDhij)hkjhm}rpD(UreftypeXattrjjX Types.SystemMetadata.obsoletedByU refdomainXpyrqDhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rrDj)rsD}rtD(hgjoDhm}ruD(ho]hp]rvD(jjqDXpy-attrrwDehq]hr]ht]uhhjmDhb]rxDhX Types.SystemMetadata.obsoletedByryDrzD}r{D(hgUhhjsDubahkjubaubhXA property for an object, indicating that the object specified by r|Dr}D}r~D(hgXA property for an object, indicating that the object specified by hhjfDubj$)rD}rD(hgX*pid*hm}rD(ho]hp]hq]hr]ht]uhhjfDhb]rDhXpidrDrD}rD(hgUhhjDubahkj$ubhX) has been obsoleted by the identifier in rDrD}rD(hgX) has been obsoleted by the identifier in hhjfDubj$)rD}rD(hgX*obsoletedByPid*hm}rD(ho]hp]hq]hr]ht]uhhjfDhb]rDhXobsoletedByPidrDrD}rD(hgUhhjDubahkj$ubhX.rD}rD(hgX.hhjfDubeubh)rD}rD(hgXv2.0: Method implementation has changed to ensure that the obsolescence chain is consistent with use of any SID assigned to the object.rDhhjbDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvMhwhhb]rDhXv2.0: Method implementation has changed to ensure that the obsolescence chain is consistent with use of any SID assigned to the object.rDrD}rD(hgjDhhjDubaubh)rD}rD(hgUhhjbDhiNhkhhm}rD(ho]hp]hq]hr]ht]uhvNhwhhb]rD(h)rD}rD(hgUhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvMhwhhb]rD(h)rD}rD(hgXVersionhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rDhXVersionrDrD}rD(hgUhhjDubaubh)rD}rD(hgX1.0, 2.0rDhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rDh)rD}rD(hgjDhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvMhb]rDhX1.0, 2.0rDrD}rD(hgjDhhjDubaubahkhubeubh)rD}rD(hgUhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvMhwhhb]rD(h)rD}rD(hgXREST URLhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rDhXREST URLrDrD}rD(hgUhhjDubaubh)rD}rD(hgX``PUT /obsoletedBy/{pid}``rDhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rDh)rD}rD(hgjDhhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvMhb]rDj)rD}rD(hgjDhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rDhXPUT /obsoletedBy/{pid}rDrD}rD(hgUhhjDubahkjubaubahkhubeubh)rD}rD(hgUhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rD(h)rD}rD(hgX ParametershhjDhij)hkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rDhX ParametersrDrD}rD(hgUhhjDubaubh)rD}rD(hgUhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rDj #)rD}rD(hgUhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rD(j#)rD}rD(hgUhm}rD(ho]hp]hq]hr]ht]uhhjDhb]rDh)rD}rD(hgX,session (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The Subject of the session MUST have write permission on the object. Transmitted as part of the SSL handshake process.hm}rD(ho]hp]hq]hr]ht]uhhjDhb]rD(j")rD}rD(hgXsessionhm}rD(hr]hq]j"ho]hp]ht]uhhjDhb]rDhXsessionrDrD}rD(hgUhhjDubahkj"ubhX (rDrD}rD(hgUhhjDubj)rD}rD(hgX:class:`Types.Session`rDhhjDhij)hkjhm}rD(UreftypeXclassjjX Types.SessionU refdomainXpyrDhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rDj)rD}rD(hgjDhm}rD(ho]hp]rD(jjDXpy-classrDehq]hr]ht]uhhjDhb]rEhX Types.SessionrErE}rE(hgUhhjDubahkjubaubhX)rE}rE(hgUhhjDubhX -- rErE}rE(hgUhhjDubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The r Er E}r E(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The hhjDubj)r E}r E(hgX:term:`Subject`rEhhjDhij)hkjhm}rE(UreftypeXtermjjXsubjectU refdomainXstdrEhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rEj`2)rE}rE(hgjEhm}rE(ho]hp]rE(jjEXstd-termrEehq]hr]ht]uhhj Ehb]rEhXSubjectrErE}rE(hgUhhjEubahkji2ubaubhX of the session MUST have rErE}rE(hgX of the session MUST have hhjDubj$)rE}rE(hgX*write*hm}r E(ho]hp]hq]hr]ht]uhhjDhb]r!EhXwriter"Er#E}r$E(hgUhhjEubahkj$ubhXL permission on the object. Transmitted as part of the SSL handshake process.r%Er&E}r'E(hgXL permission on the object. Transmitted as part of the SSL handshake process.hhjDubehkhubahkj;#ubj#)r(E}r)E(hgUhm}r*E(ho]hp]hq]hr]ht]uhhjDhb]r+Eh)r,E}r-E(hgXpid (Types.Identifier) -- Identifier of the object system metadata being updated. Transmitted as part of the URL path and must be escaped accordingly.hm}r.E(ho]hp]hq]hr]ht]uhhj(Ehb]r/E(j")r0E}r1E(hgXpidhm}r2E(hr]hq]j"ho]hp]ht]uhhj,Ehb]r3EhXpidr4Er5E}r6E(hgUhhj0Eubahkj"ubhX (r7Er8E}r9E(hgUhhj,Eubj)r:E}r;E(hgX:class:`Types.Identifier`rEhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r?Ej)r@E}rAE(hgjEXpy-classrDEehq]hr]ht]uhhj:Ehb]rEEhXTypes.IdentifierrFErGE}rHE(hgUhhj@EubahkjubaubhX)rIE}rJE(hgUhhj,EubhX -- rKErLE}rME(hgUhhj,EubhX|Identifier of the object system metadata being updated. Transmitted as part of the URL path and must be escaped accordingly.rNErOE}rPE(hgX|Identifier of the object system metadata being updated. Transmitted as part of the URL path and must be escaped accordingly.hhj,Eubehkhubahkj;#ubj#)rQE}rRE(hgUhm}rSE(ho]hp]hq]hr]ht]uhhjDhb]rTEh)rUE}rVE(hgXobsoletedByPid (Types.Identifier) -- Identifier of the object that obsoletes the object identified by pid. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rWE(ho]hp]hq]hr]ht]uhhjQEhb]rXE(j")rYE}rZE(hgXobsoletedByPidhm}r[E(hr]hq]j"ho]hp]ht]uhhjUEhb]r\EhXobsoletedByPidr]Er^E}r_E(hgUhhjYEubahkj"ubhX (r`EraE}rbE(hgUhhjUEubj)rcE}rdE(hgX:class:`Types.Identifier`reEhhjUEhij)hkjhm}rfE(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrgEhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rhEj)riE}rjE(hgjeEhm}rkE(ho]hp]rlE(jjgEXpy-classrmEehq]hr]ht]uhhjcEhb]rnEhXTypes.IdentifierroErpE}rqE(hgUhhjiEubahkjubaubhX)rrE}rsE(hgUhhjUEubhX -- rtEruE}rvE(hgUhhjUEubhXAIdentifier of the object that obsoletes the object identified by rwErxE}ryE(hgXAIdentifier of the object that obsoletes the object identified by hhjUEubj$)rzE}r{E(hgX*pid*hm}r|E(ho]hp]hq]hr]ht]uhhjUEhb]r}EhXpidr~ErE}rE(hgUhhjzEubahkj$ubhX&. Transmitted as a UTF-8 String as a rErE}rE(hgX&. Transmitted as a UTF-8 String as a hhjUEubj$)rE}rE(hgX *Param part*hm}rE(ho]hp]hq]hr]ht]uhhjUEhb]rEhX Param partrErE}rE(hgUhhjEubahkj$ubhX% of the MIME multipart/mixed message.rErE}rE(hgX% of the MIME multipart/mixed message.hhjUEubehkhubahkj;#ubj#)rE}rE(hgUhm}rE(ho]hp]hq]hr]ht]uhhjDhb]rEh)rE}rE(hgXTserialVersion (unsigned long) -- The serial version of the system metadata being updated. If the specified serialVersion does not match the current version at the Coordinating Nodes, then a Exceptions.VersionMismatch error is raised and no changes are made. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rE(ho]hp]hq]hr]ht]uhhjEhb]rE(j")rE}rE(hgX serialVersionhm}rE(hr]hq]j"ho]hp]ht]uhhjEhb]rEhX serialVersionrErE}rE(hgUhhjEubahkj"ubhX (rErE}rE(hgUhhjEubj)rE}rE(hgUhm}rE(Ureftypej&j"U reftargetX unsigned longrEU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjEhb]rEj&)rE}rE(hgjEhm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEhX unsigned longrErE}rE(hgUhhjEubahkj&ubahkjubhX)rE}rE(hgUhhjEubhX -- rErE}rE(hgUhhjEubhXJThe serial version of the system metadata being updated. If the specified rErE}rE(hgXJThe serial version of the system metadata being updated. If the specified hhjEubj$)rE}rE(hgX*serialVersion*hm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEhX serialVersionrErE}rE(hgUhhjEubahkj$ubhXF does not match the current version at the Coordinating Nodes, then a rErE}rE(hgXF does not match the current version at the Coordinating Nodes, then a hhjEubj)rE}rE(hgX!:exc:`Exceptions.VersionMismatch`rEhhjEhij)hkjhm}rE(UreftypeXexcjjXExceptions.VersionMismatchU refdomainXpyrEhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rEj)rE}rE(hgjEhm}rE(ho]hp]rE(jjEXpy-excrEehq]hr]ht]uhhjEhb]rEhXExceptions.VersionMismatchrErE}rE(hgUhhjEubahkjubaubhXM error is raised and no changes are made. Transmitted as a UTF-8 String as a rErE}rE(hgXM error is raised and no changes are made. Transmitted as a UTF-8 String as a hhjEubj$)rE}rE(hgX *Param part*hm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEhX Param partrErE}rE(hgUhhjEubahkj$ubhX% of the MIME multipart/mixed message.rErE}rE(hgX% of the MIME multipart/mixed message.hhjEubehkhubahkj;#ubehkj#ubahkhubehkhubh)rE}rE(hgUhm}rE(ho]hp]hq]hr]ht]uhhjDhb]rE(h)rE}rE(hgXReturnshhjEhij)hkhhm}rE(ho]hp]hq]hr]ht]uhvKhb]rEhXReturnsrErE}rE(hgUhhjEubaubh)rE}rE(hgUhm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEh)rE}rE(hgX0True if the operation succeeds, otherwise false.hm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEhX0True if the operation succeeds, otherwise false.rErE}rE(hgX0True if the operation succeeds, otherwise false.hhjEubahkhubahkhubehkhubh)rE}rE(hgUhm}rE(ho]hp]hq]hr]ht]uhhjDhb]rE(h)rE}rE(hgX Return typehhjEhij)hkhhm}rE(ho]hp]hq]hr]ht]uhvKhb]rEhX Return typerErE}rE(hgUhhjEubaubh)rE}rE(hgUhm}rE(ho]hp]hq]hr]ht]uhhjEhb]rEh)rE}rF(hgXbooleanhm}rF(ho]hp]hq]hr]ht]uhhjEhb]rFj)rF}rF(hgUhm}rF(Ureftypej&j"U reftargetXbooleanU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjEhb]rFhXbooleanrFrF}r F(hgUhhjFubahkjubahkhubahkhubehkhubh)r F}r F(hgUhm}r F(ho]hp]hq]hr]ht]uhhjDhb]r F(h)rF}rF(hgXRaiseshhj Fhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvKhb]rFhXRaisesrFrF}rF(hgUhhjFubaubh)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhj Fhb]rFj #)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rF(j#)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhjFhb]r Fh)r!F}r"F(hgXtExceptions.NotImplemented -- (errorCode=501, detailCode=4940)The service endpoint has not yet been fully implementedhm}r#F(ho]hp]hq]hr]ht]uhhjFhb]r$F(j)r%F}r&F(hgUhm}r'F(Ureftypej#j"U reftargetXExceptions.NotImplementedr(FU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhj!Fhb]r)Fj")r*F}r+F(hgj(Fhm}r,F(ho]hp]hq]hr]ht]uhhj%Fhb]r-FhXExceptions.NotImplementedr.Fr/F}r0F(hgUhhj*Fubahkj"ubahkjubhX -- r1Fr2F}r3F(hgUhhj!Fubh)r4F}r5F(hgX$``(errorCode=501, detailCode=4940)``r6Fhhj!Fhij)hkhhm}r7F(ho]hp]hq]hr]ht]uhvMhb]r8Fj)r9F}r:F(hgj6Fhm}r;F(ho]hp]hq]hr]ht]uhhj4Fhb]rF}r?F(hgUhhj9Fubahkjubaubh)r@F}rAF(hgX7The service endpoint has not yet been fully implementedrBFhhj!Fhij)hkhhm}rCF(ho]hp]hq]hr]ht]uhvMhb]rDFhX7The service endpoint has not yet been fully implementedrEFrFF}rGF(hgjBFhhj@Fubaubehkhubahkj;#ubj#)rHF}rIF(hgUhm}rJF(ho]hp]hq]hr]ht]uhhjFhb]rKFh)rLF}rMF(hgXExceptions.ServiceFailure -- (errorCode=500, detailCode=4941)A problem occurred with the service that prevented it from returning the expected response.hm}rNF(ho]hp]hq]hr]ht]uhhjHFhb]rOF(j)rPF}rQF(hgUhm}rRF(Ureftypej#j"U reftargetXExceptions.ServiceFailurerSFU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjLFhb]rTFj")rUF}rVF(hgjSFhm}rWF(ho]hp]hq]hr]ht]uhhjPFhb]rXFhXExceptions.ServiceFailurerYFrZF}r[F(hgUhhjUFubahkj"ubahkjubhX -- r\Fr]F}r^F(hgUhhjLFubh)r_F}r`F(hgX$``(errorCode=500, detailCode=4941)``raFhhjLFhij)hkhhm}rbF(ho]hp]hq]hr]ht]uhvMhb]rcFj)rdF}reF(hgjaFhm}rfF(ho]hp]hq]hr]ht]uhhj_Fhb]rgFhX (errorCode=500, detailCode=4941)rhFriF}rjF(hgUhhjdFubahkjubaubh)rkF}rlF(hgX[A problem occurred with the service that prevented it from returning the expected response.rmFhhjLFhij)hkhhm}rnF(ho]hp]hq]hr]ht]uhvMhb]roFhX[A problem occurred with the service that prevented it from returning the expected response.rpFrqF}rrF(hgjmFhhjkFubaubehkhubahkj;#ubj#)rsF}rtF(hgUhm}ruF(ho]hp]hq]hr]ht]uhhjFhb]rvFh)rwF}rxF(hgXrExceptions.InvalidRequest -- (errorCode=400, detailCode=4942)The request was malformed and could not be processed.hm}ryF(ho]hp]hq]hr]ht]uhhjsFhb]rzF(j)r{F}r|F(hgUhm}r}F(Ureftypej#j"U reftargetXExceptions.InvalidRequestr~FU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjwFhb]rFj")rF}rF(hgj~Fhm}rF(ho]hp]hq]hr]ht]uhhj{Fhb]rFhXExceptions.InvalidRequestrFrF}rF(hgUhhjFubahkj"ubahkjubhX -- rFrF}rF(hgUhhjwFubh)rF}rF(hgX$``(errorCode=400, detailCode=4942)``rFhhjwFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rFj)rF}rF(hgjFhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhX (errorCode=400, detailCode=4942)rFrF}rF(hgUhhjFubahkjubaubh)rF}rF(hgX5The request was malformed and could not be processed.rFhhjwFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rFhX5The request was malformed and could not be processed.rFrF}rF(hgjFhhjFubaubehkhubahkj;#ubj#)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFh)rF}rF(hgXExceptions.InvalidToken -- (errorCode=401, detailCode=4943)The supplied session information could not be verified as a valid DataONE session.hm}rF(ho]hp]hq]hr]ht]uhhjFhb]rF(j)rF}rF(hgUhm}rF(Ureftypej#j"U reftargetXExceptions.InvalidTokenrFU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjFhb]rFj")rF}rF(hgjFhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhXExceptions.InvalidTokenrFrF}rF(hgUhhjFubahkj"ubahkjubhX -- rFrF}rF(hgUhhjFubh)rF}rF(hgX$``(errorCode=401, detailCode=4943)``rFhhjFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rFj)rF}rF(hgjFhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhX (errorCode=401, detailCode=4943)rFrF}rF(hgUhhjFubahkjubaubh)rF}rF(hgXRThe supplied session information could not be verified as a valid DataONE session.rFhhjFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rFhXRThe supplied session information could not be verified as a valid DataONE session.rFrF}rF(hgjFhhjFubaubehkhubahkj;#ubj#)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFh)rF}rF(hgXXExceptions.NotFound -- (errorCode=404, detailCode=4944)The specified pid does not exist.hm}rF(ho]hp]hq]hr]ht]uhhjFhb]rF(j)rF}rF(hgUhm}rF(Ureftypej#j"U reftargetXExceptions.NotFoundrFU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjFhb]rFj")rF}rF(hgjFhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhXExceptions.NotFoundrFrF}rF(hgUhhjFubahkj"ubahkjubhX -- rFrF}rF(hgUhhjFubh)rF}rF(hgX$``(errorCode=404, detailCode=4944)``rFhhjFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rFj)rF}rF(hgjFhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhX (errorCode=404, detailCode=4944)rFrF}rF(hgUhhjFubahkjubaubh)rF}rF(hgX#The specified *pid* does not exist.hhjFhij)hkhhm}rF(ho]hp]hq]hr]ht]uhvMhb]rF(hXThe specified rFrF}rF(hgXThe specified hhjFubj$)rF}rF(hgX*pid*hm}rF(ho]hp]hq]hr]ht]uhhjFhb]rFhXpidrFrF}rF(hgUhhjFubahkj$ubhX does not exist.rFrF}rF(hgX does not exist.hhjFubeubehkhubahkj;#ubj#)rF}rF(hgUhm}rF(ho]hp]hq]hr]ht]uhhjFhb]rGh)rG}rG(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4945)The credentials provided with the request in the session do not have write privileges on pid.hm}rG(ho]hp]hq]hr]ht]uhhjFhb]rG(j)rG}rG(hgUhm}rG(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrGU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjGhb]r Gj")r G}r G(hgjGhm}r G(ho]hp]hq]hr]ht]uhhjGhb]r GhXExceptions.NotAuthorizedrGrG}rG(hgUhhj Gubahkj"ubahkjubhX -- rGrG}rG(hgUhhjGubh)rG}rG(hgX$``(errorCode=401, detailCode=4945)``rGhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhb]rGj)rG}rG(hgjGhm}rG(ho]hp]hq]hr]ht]uhhjGhb]rGhX (errorCode=401, detailCode=4945)rGrG}rG(hgUhhjGubahkjubaubh)r G}r!G(hgXcThe credentials provided with the request in the *session* do not have *write* privileges on *pid*.hhjGhij)hkhhm}r"G(ho]hp]hq]hr]ht]uhvMhb]r#G(hX1The credentials provided with the request in the r$Gr%G}r&G(hgX1The credentials provided with the request in the hhj Gubj$)r'G}r(G(hgX *session*hm}r)G(ho]hp]hq]hr]ht]uhhj Ghb]r*GhXsessionr+Gr,G}r-G(hgUhhj'Gubahkj$ubhX do not have r.Gr/G}r0G(hgX do not have hhj Gubj$)r1G}r2G(hgX*write*hm}r3G(ho]hp]hq]hr]ht]uhhj Ghb]r4GhXwriter5Gr6G}r7G(hgUhhj1Gubahkj$ubhX privileges on r8Gr9G}r:G(hgX privileges on hhj Gubj$)r;G}rGhXpidr?Gr@G}rAG(hgUhhj;Gubahkj$ubhX.rBG}rCG(hgX.hhj Gubeubehkhubahkj;#ubj#)rDG}rEG(hgUhm}rFG(ho]hp]hq]hr]ht]uhhjFhb]rGGh)rHG}rIG(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4946)The provided serialVersion does not match the latest version that is held by the CN. The client should refresh it's copy, verify that the update is still necessary, and resubmit the request with the updated information.hm}rJG(ho]hp]hq]hr]ht]uhhjDGhb]rKG(j)rLG}rMG(hgUhm}rNG(Ureftypej#j"U reftargetXExceptions.VersionMismatchrOGU refdomainj#Dhr]hq]U refexplicitho]hp]ht]uhhjHGhb]rPGj")rQG}rRG(hgjOGhm}rSG(ho]hp]hq]hr]ht]uhhjLGhb]rTGhXExceptions.VersionMismatchrUGrVG}rWG(hgUhhjQGubahkj"ubahkjubhX -- rXGrYG}rZG(hgUhhjHGubh)r[G}r\G(hgX$``(errorCode=409, detailCode=4946)``r]GhhjHGhij)hkhhm}r^G(ho]hp]hq]hr]ht]uhvMhb]r_Gj)r`G}raG(hgj]Ghm}rbG(ho]hp]hq]hr]ht]uhhj[Ghb]rcGhX (errorCode=409, detailCode=4946)rdGreG}rfG(hgUhhj`Gubahkjubaubh)rgG}rhG(hgXThe provided *serialVersion* does not match the latest version that is held by the CN. The client should refresh it's copy, verify that the update is still necessary, and resubmit the request with the updated information.hhjHGhij)hkhhm}riG(ho]hp]hq]hr]ht]uhvMhb]rjG(hX The provided rkGrlG}rmG(hgX The provided hhjgGubj$)rnG}roG(hgX*serialVersion*hm}rpG(ho]hp]hq]hr]ht]uhhjgGhb]rqGhX serialVersionrrGrsG}rtG(hgUhhjnGubahkj$ubhX does not match the latest version that is held by the CN. The client should refresh it's copy, verify that the update is still necessary, and resubmit the request with the updated information.ruGrvG}rwG(hgX does not match the latest version that is held by the CN. The client should refresh it's copy, verify that the update is still necessary, and resubmit the request with the updated information.hhjgGubeubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rxG}ryG(hgUhhj)hiNhkjhm}rzG(hr]hq]ho]hp]ht]Uentries]r{G(jXdelete() (in module CNCore)h"UNtr|GauhvNhwhhb]ubj!)r}G}r~G(hgUhhj)hiNhkj!hm}rG(j"j"XpyrGhr]hq]ho]hp]ht]j"XfunctionrGj"jGuhvNhwhhb]rG(j")rG}rG(hgX delete(session,id) -> Identifierhhj}Ghij)hkj "hm}rG(hr]rGh"aj"j0)hq]ho]hp]ht]rGh"aj"XdeleterGj"Uj"uhvMhwhhb]rG(j")rG}rG(hgXCNCore.hhjGhij)hkj"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rGhXCNCore.rGrG}rG(hgUhhjGubaubj")rG}rG(hgjGhhjGhij)hkj!"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rGhXdeleterGrG}rG(hgUhhjGubaubj'")rG}rG(hgX session, idhhjGhij)hkj*"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rG(j-")rG}rG(hgXsessionhm}rG(ho]hp]hq]hr]ht]uhhjGhb]rGhXsessionrGrG}rG(hgUhhjGubahkj5"ubj-")rG}rG(hgXidhm}rG(ho]hp]hq]hr]ht]uhhjGhb]rGhXidrGrG}rG(hgUhhjGubahkj5"ubeubj6")rG}rG(hgX IdentifierhhjGhij)hkj9"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rGhX IdentifierrGrG}rG(hgUhhjGubaubeubj?")rG}rG(hgUhhj}Ghij)hkjB"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rG(h)rG}rG(hgXDeletes an object from the entire DataONE system, including all nodes known to hold a copy of the object. The PID and/or SID of the object will continue to be shown as in use (preventing its reuse for other objects), however the object should not be resolvable (NotFound) or retrievable.rGhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rGhXDeletes an object from the entire DataONE system, including all nodes known to hold a copy of the object. The PID and/or SID of the object will continue to be shown as in use (preventing its reuse for other objects), however the object should not be resolvable (NotFound) or retrievable.rGrG}rG(hgjGhhjGubaubh)rG}rG(hgXThe delete operation is used only by administrators in response to a request to remove an object from DataONE, perhaps because of legal requirements or the object has been identified as containing malicious content.rGhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rGhXThe delete operation is used only by administrators in response to a request to remove an object from DataONE, perhaps because of legal requirements or the object has been identified as containing malicious content.rGrG}rG(hgjGhhjGubaubh)rG}rG(hgUhhjGhiNhkhhm}rG(ho]hp]hq]hr]ht]uhvNhwhhb]rG(h)rG}rG(hgUhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rG(h)rG}rG(hgXVersionhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvKhb]rGhXVersionrGrG}rG(hgUhhjGubaubh)rG}rG(hgX 1.0, (2.0)rGhm}rG(ho]hp]hq]hr]ht]uhhjGhb]rGh)rG}rG(hgjGhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhb]rGhX 1.0, (2.0)rGrG}rG(hgjGhhjGubaubahkhubeubh)rG}rG(hgUhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rG(h)rG}rG(hgX Use CaseshhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvKhb]rGhX Use CasesrGrG}rG(hgUhhjGubaubh)rG}rG(hgX$:doc:`UC16 `rGhm}rG(ho]hp]hq]hr]ht]uhhjGhb]rGh)rG}rG(hgjGhhjGhij)hkhhm}rG(ho]hp]hq]hr]ht]uhvMhb]rGj)rG}rG(hgjGhhjGhij)hkjhm}rG(UreftypeXdocrGjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rGj`2)rG}rG(hgjGhm}rG(ho]hp]rG(jjGehq]hr]ht]uhhjGhb]rGhXUC16rGrG}rH(hgUhhjGubahkji2ubaubaubahkhubeubh)rH}rH(hgUhhjGhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvMhwhhb]rH(h)rH}rH(hgXREST URLhhjHhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvKhb]rHhXREST URLr Hr H}r H(hgUhhjHubaubh)r H}r H(hgX``DELETE /object/{id}``rHhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHh)rH}rH(hgjHhhj Hhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvMhb]rHj)rH}rH(hgjHhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHhXDELETE /object/{id}rHrH}rH(hgUhhjHubahkjubaubahkhubeubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjGhb]rH(h)r H}r!H(hgX ParametershhjHhij)hkhhm}r"H(ho]hp]hq]hr]ht]uhvKhb]r#HhX Parametersr$Hr%H}r&H(hgUhhj Hubaubh)r'H}r(H(hgUhm}r)H(ho]hp]hq]hr]ht]uhhjHhb]r*Hj #)r+H}r,H(hgUhm}r-H(ho]hp]hq]hr]ht]uhhj'Hhb]r.H(j#)r/H}r0H(hgUhm}r1H(ho]hp]hq]hr]ht]uhhj+Hhb]r2Hh)r3H}r4H(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r5H(ho]hp]hq]hr]ht]uhhj/Hhb]r6H(j")r7H}r8H(hgXsessionhm}r9H(hr]hq]j"ho]hp]ht]uhhj3Hhb]r:HhXsessionr;HrHr?H}r@H(hgUhhj3Hubj)rAH}rBH(hgX:class:`Types.Session`rCHhhj3Hhij)hkjhm}rDH(UreftypeXclassjjX Types.SessionU refdomainXpyrEHhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rFHj)rGH}rHH(hgjCHhm}rIH(ho]hp]rJH(jjEHXpy-classrKHehq]hr]ht]uhhjAHhb]rLHhX Types.SessionrMHrNH}rOH(hgUhhjGHubahkjubaubhX)rPH}rQH(hgUhhj3HubhX -- rRHrSH}rTH(hgUhhj3HubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rUHrVH}rWH(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj3Hubj)rXH}rYH(hgX:term:`public user`rZHhhj3Hhij)hkjhm}r[H(UreftypeXtermjjX public userU refdomainXstdr\Hhr]hq]U refexplicitho]hp]ht]jjuhvMhb]r]Hj`2)r^H}r_H(hgjZHhm}r`H(ho]hp]raH(jj\HXstd-termrbHehq]hr]ht]uhhjXHhb]rcHhX public userrdHreH}rfH(hgUhhj^Hubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rgHrhH}riH(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj3Hubehkhubahkj;#ubj#)rjH}rkH(hgUhm}rlH(ho]hp]hq]hr]ht]uhhj+Hhb]rmHh)rnH}roH(hgXid (Types.Identifier) -- The identifier of the object to be deleted. May be either a PID or SID, the latter will operate on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}rpH(ho]hp]hq]hr]ht]uhhjjHhb]rqH(j")rrH}rsH(hgXidhm}rtH(hr]hq]j"ho]hp]ht]uhhjnHhb]ruHhXidrvHrwH}rxH(hgUhhjrHubahkj"ubhX (ryHrzH}r{H(hgUhhjnHubj)r|H}r}H(hgX:class:`Types.Identifier`r~HhhjnHhij)hkjhm}rH(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrHhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rHj)rH}rH(hgj~Hhm}rH(ho]hp]rH(jjHXpy-classrHehq]hr]ht]uhhj|Hhb]rHhXTypes.IdentifierrHrH}rH(hgUhhjHubahkjubaubhX)rH}rH(hgUhhjnHubhX -- rHrH}rH(hgUhhjnHubhXThe identifier of the object to be deleted. May be either a PID or SID, the latter will operate on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.rHrH}rH(hgXThe identifier of the object to be deleted. May be either a PID or SID, the latter will operate on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjnHubehkhubahkj;#ubehkj#ubahkhubehkhubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjGhb]rH(h)rH}rH(hgXReturnshhjHhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvKhb]rHhXReturnsrHrH}rH(hgUhhjHubaubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHh)rH}rH(hgX.The identifier of the object that was deleted.hm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHhX.The identifier of the object that was deleted.rHrH}rH(hgX.The identifier of the object that was deleted.hhjHubahkhubahkhubehkhubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjGhb]rH(h)rH}rH(hgX Return typehhjHhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvKhb]rHhX Return typerHrH}rH(hgUhhjHubaubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHh)rH}rH(hgXTypes.Identifierhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHj)rH}rH(hgX:class:`Types.Identifier`rHhhjHhij)hkjhm}rH(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrHhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rHj)rH}rH(hgjHhm}rH(ho]hp]rH(jjHXpy-classrHehq]hr]ht]uhhjHhb]rHhXTypes.IdentifierrHrH}rH(hgUhhjHubahkjubaubahkhubahkhubehkhubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjGhb]rH(h)rH}rH(hgXRaiseshhjHhij)hkhhm}rH(ho]hp]hq]hr]ht]uhvKhb]rHhXRaisesrHrH}rH(hgUhhjHubaubh)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHj #)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rH(j#)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHh)rH}rH(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4960)hm}rH(ho]hp]hq]hr]ht]uhhjHhb]rH(j)rH}rH(hgUhm}rH(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrHU refdomainjGhr]hq]U refexplicitho]hp]ht]uhhjHhb]rHj")rH}rH(hgjHhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHhXExceptions.NotAuthorizedrHrH}rH(hgUhhjHubahkj"ubahkjubhX -- rHrH}rH(hgUhhjHubj)rH}rH(hgX$``(errorCode=401, detailCode=4960)``hm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHhX (errorCode=401, detailCode=4960)rHrH}rH(hgUhhjHubahkjubehkhubahkj;#ubj#)rH}rH(hgUhm}rH(ho]hp]hq]hr]ht]uhhjHhb]rHh)rI}rI(hgXuExceptions.NotFound -- (errorCode=404, detailCode=4961)The delete operation failed because the object does not exist.hm}rI(ho]hp]hq]hr]ht]uhhjHhb]rI(j)rI}rI(hgUhm}rI(Ureftypej#j"U reftargetXExceptions.NotFoundrIU refdomainjGhr]hq]U refexplicitho]hp]ht]uhhjIhb]rIj")r I}r I(hgjIhm}r I(ho]hp]hq]hr]ht]uhhjIhb]r IhXExceptions.NotFoundr IrI}rI(hgUhhj Iubahkj"ubahkjubhX -- rIrI}rI(hgUhhjIubh)rI}rI(hgX$``(errorCode=404, detailCode=4961)``rIhhjIhij)hkhhm}rI(ho]hp]hq]hr]ht]uhvMhb]rIj)rI}rI(hgjIhm}rI(ho]hp]hq]hr]ht]uhhjIhb]rIhX (errorCode=404, detailCode=4961)rIrI}rI(hgUhhjIubahkjubaubh)rI}r I(hgX>The delete operation failed because the object does not exist.r!IhhjIhij)hkhhm}r"I(ho]hp]hq]hr]ht]uhvMhb]r#IhX>The delete operation failed because the object does not exist.r$Ir%I}r&I(hgj!IhhjIubaubehkhubahkj;#ubj#)r'I}r(I(hgUhm}r)I(ho]hp]hq]hr]ht]uhhjHhb]r*Ih)r+I}r,I(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4962)hm}r-I(ho]hp]hq]hr]ht]uhhj'Ihb]r.I(j)r/I}r0I(hgUhm}r1I(Ureftypej#j"U reftargetXExceptions.ServiceFailurer2IU refdomainjGhr]hq]U refexplicitho]hp]ht]uhhj+Ihb]r3Ij")r4I}r5I(hgj2Ihm}r6I(ho]hp]hq]hr]ht]uhhj/Ihb]r7IhXExceptions.ServiceFailurer8Ir9I}r:I(hgUhhj4Iubahkj"ubahkjubhX -- r;IrI}r?I(hgX$``(errorCode=500, detailCode=4962)``hm}r@I(ho]hp]hq]hr]ht]uhhj+Ihb]rAIhX (errorCode=500, detailCode=4962)rBIrCI}rDI(hgUhhj>Iubahkjubehkhubahkj;#ubj#)rEI}rFI(hgUhm}rGI(ho]hp]hq]hr]ht]uhhjHhb]rHIh)rII}rJI(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4963)hm}rKI(ho]hp]hq]hr]ht]uhhjEIhb]rLI(j)rMI}rNI(hgUhm}rOI(Ureftypej#j"U reftargetXExceptions.InvalidTokenrPIU refdomainjGhr]hq]U refexplicitho]hp]ht]uhhjIIhb]rQIj")rRI}rSI(hgjPIhm}rTI(ho]hp]hq]hr]ht]uhhjMIhb]rUIhXExceptions.InvalidTokenrVIrWI}rXI(hgUhhjRIubahkj"ubahkjubhX -- rYIrZI}r[I(hgUhhjIIubj)r\I}r]I(hgX$``(errorCode=401, detailCode=4963)``hm}r^I(ho]hp]hq]hr]ht]uhhjIIhb]r_IhX (errorCode=401, detailCode=4963)r`IraI}rbI(hgUhhj\Iubahkjubehkhubahkj;#ubj#)rcI}rdI(hgUhm}reI(ho]hp]hq]hr]ht]uhhjHhb]rfIh)rgI}rhI(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4964)hm}riI(ho]hp]hq]hr]ht]uhhjcIhb]rjI(j)rkI}rlI(hgUhm}rmI(Ureftypej#j"U reftargetXExceptions.NotImplementedrnIU refdomainjGhr]hq]U refexplicitho]hp]ht]uhhjgIhb]roIj")rpI}rqI(hgjnIhm}rrI(ho]hp]hq]hr]ht]uhhjkIhb]rsIhXExceptions.NotImplementedrtIruI}rvI(hgUhhjpIubahkj"ubahkjubhX -- rwIrxI}ryI(hgUhhjgIubj)rzI}r{I(hgX$``(errorCode=501, detailCode=4964)``hm}r|I(ho]hp]hq]hr]ht]uhhjgIhb]r}IhX (errorCode=501, detailCode=4964)r~IrI}rI(hgUhhjzIubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rI}rI(hgUhhj)hiNhkjhm}rI(hr]hq]ho]hp]ht]Uentries]rI(jXarchive() (in module CNCore)h7UNtrIauhvNhwhhb]ubj!)rI}rI(hgUhhj)hiNhkj!hm}rI(j"j"XpyrIhr]hq]ho]hp]ht]j"XfunctionrIj"jIuhvNhwhhb]rI(j")rI}rI(hgX!archive(session,id) -> IdentifierhhjIhij)hkj "hm}rI(hr]rIh7aj"j0)hq]ho]hp]ht]rIh7aj"XarchiverIj"Uj"uhvMhwhhb]rI(j")rI}rI(hgXCNCore.hhjIhij)hkj"hm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rIhXCNCore.rIrI}rI(hgUhhjIubaubj")rI}rI(hgjIhhjIhij)hkj!"hm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rIhXarchiverIrI}rI(hgUhhjIubaubj'")rI}rI(hgX session, idhhjIhij)hkj*"hm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rI(j-")rI}rI(hgXsessionhm}rI(ho]hp]hq]hr]ht]uhhjIhb]rIhXsessionrIrI}rI(hgUhhjIubahkj5"ubj-")rI}rI(hgXidhm}rI(ho]hp]hq]hr]ht]uhhjIhb]rIhXidrIrI}rI(hgUhhjIubahkj5"ubeubj6")rI}rI(hgX IdentifierhhjIhij)hkj9"hm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rIhX IdentifierrIrI}rI(hgUhhjIubaubeubj?")rI}rI(hgUhhjIhij)hkjB"hm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rI(h)rI}rI(hgXyHides an object managed by DataONE from search operations, effectively preventing its discovery during normal operations.rIhhjIhij)hkhhm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rIhXyHides an object managed by DataONE from search operations, effectively preventing its discovery during normal operations.rIrI}rI(hgjIhhjIubaubh)rI}rI(hgXThe operation does not delete the object bytes, but instead sets the :attr:`Types.SystemMetadata.archived` flag to True. This ensures that the object can still be resolved (and hence remain valid for existing citations and cross references), though will not appear in searches.hhjIhij)hkhhm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rI(hXEThe operation does not delete the object bytes, but instead sets the rIrI}rI(hgXEThe operation does not delete the object bytes, but instead sets the hhjIubj)rI}rI(hgX%:attr:`Types.SystemMetadata.archived`rIhhjIhij)hkjhm}rI(UreftypeXattrjjXTypes.SystemMetadata.archivedU refdomainXpyrIhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rIj)rI}rI(hgjIhm}rI(ho]hp]rI(jjIXpy-attrrIehq]hr]ht]uhhjIhb]rIhXTypes.SystemMetadata.archivedrIrI}rI(hgUhhjIubahkjubaubhX flag to True. This ensures that the object can still be resolved (and hence remain valid for existing citations and cross references), though will not appear in searches.rIrI}rI(hgX flag to True. This ensures that the object can still be resolved (and hence remain valid for existing citations and cross references), though will not appear in searches.hhjIubeubh)rI}rI(hgX\Objects that are archived can not be updated through the :func:`MNStorage.update` operation.hhjIhij)hkhhm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rI(hX9Objects that are archived can not be updated through the rIrI}rI(hgX9Objects that are archived can not be updated through the hhjIubj)rI}rI(hgX:func:`MNStorage.update`rIhhjIhij)hkjhm}rI(UreftypeXfuncjjXMNStorage.updateU refdomainXpyrIhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rIj)rI}rI(hgjIhm}rI(ho]hp]rI(jjIXpy-funcrIehq]hr]ht]uhhjIhb]rIhXMNStorage.update()rIrI}rI(hgUhhjIubahkjubaubhX operation.rIrI}rI(hgX operation.hhjIubeubh)rI}rI(hgXhArchived objects can not be un-archived. This behavior may change in future versions of the DataONE API.rIhhjIhij)hkhhm}rI(ho]hp]hq]hr]ht]uhvMhwhhb]rIhXhArchived objects can not be un-archived. This behavior may change in future versions of the DataONE API.rIrI}rI(hgjIhhjIubaubh)rJ}rJ(hgXThe CN should ensure that all MNs holding a copy of the object are informed of the change so that they may update their information about the object.rJhhjIhij)hkhhm}rJ(ho]hp]hq]hr]ht]uhvMhwhhb]rJhXThe CN should ensure that all MNs holding a copy of the object are informed of the change so that they may update their information about the object.rJrJ}rJ(hgjJhhjJubaubh)rJ}r J(hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhjIhij)hkhhm}r J(ho]hp]hq]hr]ht]uhvMhwhhb]r J(hX'v2.0: The supplied identifier may be a r Jr J}rJ(hgX'v2.0: The supplied identifier may be a hhjJubj)rJ}rJ(hgX :term:`PID`rJhhjJhij)hkjhm}rJ(UreftypeXtermjjXpidU refdomainXstdrJhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rJj`2)rJ}rJ(hgjJhm}rJ(ho]hp]rJ(jjJXstd-termrJehq]hr]ht]uhhjJhb]rJhXPIDrJrJ}rJ(hgUhhjJubahkji2ubaubhX or a rJrJ}r J(hgX or a hhjJubj)r!J}r"J(hgX :term:`SID`r#JhhjJhij)hkjhm}r$J(UreftypeXtermjjXsidU refdomainXstdr%Jhr]hq]U refexplicitho]hp]ht]jjuhvMhb]r&Jj`2)r'J}r(J(hgj#Jhm}r)J(ho]hp]r*J(jj%JXstd-termr+Jehq]hr]ht]uhhj!Jhb]r,JhXSIDr-Jr.J}r/J(hgUhhj'Jubahkji2ubaubhX.r0J}r1J(hgX.hhjJubeubh)r2J}r3J(hgUhhjIhiNhkhhm}r4J(ho]hp]hq]hr]ht]uhvNhwhhb]r5J(h)r6J}r7J(hgUhhj2Jhij)hkhhm}r8J(ho]hp]hq]hr]ht]uhvMhwhhb]r9J(h)r:J}r;J(hgXVersionhhj6Jhij)hkhhm}rJr?J}r@J(hgUhhj:Jubaubh)rAJ}rBJ(hgX1.0, 2.0rCJhm}rDJ(ho]hp]hq]hr]ht]uhhj6Jhb]rEJh)rFJ}rGJ(hgjCJhhjAJhij)hkhhm}rHJ(ho]hp]hq]hr]ht]uhvMhb]rIJhX1.0, 2.0rJJrKJ}rLJ(hgjCJhhjFJubaubahkhubeubh)rMJ}rNJ(hgUhhj2Jhij)hkhhm}rOJ(ho]hp]hq]hr]ht]uhvMhwhhb]rPJ(h)rQJ}rRJ(hgXREST URLhhjMJhij)hkhhm}rSJ(ho]hp]hq]hr]ht]uhvKhb]rTJhXREST URLrUJrVJ}rWJ(hgUhhjQJubaubh)rXJ}rYJ(hgX``PUT /archive/{id}``rZJhm}r[J(ho]hp]hq]hr]ht]uhhjMJhb]r\Jh)r]J}r^J(hgjZJhhjXJhij)hkhhm}r_J(ho]hp]hq]hr]ht]uhvMhb]r`Jj)raJ}rbJ(hgjZJhm}rcJ(ho]hp]hq]hr]ht]uhhj]Jhb]rdJhXPUT /archive/{id}reJrfJ}rgJ(hgUhhjaJubahkjubaubahkhubeubh)rhJ}riJ(hgUhm}rjJ(ho]hp]hq]hr]ht]uhhj2Jhb]rkJ(h)rlJ}rmJ(hgX ParametershhjhJhij)hkhhm}rnJ(ho]hp]hq]hr]ht]uhvKhb]roJhX ParametersrpJrqJ}rrJ(hgUhhjlJubaubh)rsJ}rtJ(hgUhm}ruJ(ho]hp]hq]hr]ht]uhhjhJhb]rvJj #)rwJ}rxJ(hgUhm}ryJ(ho]hp]hq]hr]ht]uhhjsJhb]rzJ(j#)r{J}r|J(hgUhm}r}J(ho]hp]hq]hr]ht]uhhjwJhb]r~Jh)rJ}rJ(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rJ(ho]hp]hq]hr]ht]uhhj{Jhb]rJ(j")rJ}rJ(hgXsessionhm}rJ(hr]hq]j"ho]hp]ht]uhhjJhb]rJhXsessionrJrJ}rJ(hgUhhjJubahkj"ubhX (rJrJ}rJ(hgUhhjJubj)rJ}rJ(hgX:class:`Types.Session`rJhhjJhij)hkjhm}rJ(UreftypeXclassjjX Types.SessionU refdomainXpyrJhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rJj)rJ}rJ(hgjJhm}rJ(ho]hp]rJ(jjJXpy-classrJehq]hr]ht]uhhjJhb]rJhX Types.SessionrJrJ}rJ(hgUhhjJubahkjubaubhX)rJ}rJ(hgUhhjJubhX -- rJrJ}rJ(hgUhhjJubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rJrJ}rJ(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjJubj)rJ}rJ(hgX:term:`public user`rJhhjJhij)hkjhm}rJ(UreftypeXtermjjX public userU refdomainXstdrJhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rJj`2)rJ}rJ(hgjJhm}rJ(ho]hp]rJ(jjJXstd-termrJehq]hr]ht]uhhjJhb]rJhX public userrJrJ}rJ(hgUhhjJubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rJrJ}rJ(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjJubehkhubahkj;#ubj#)rJ}rJ(hgUhm}rJ(ho]hp]hq]hr]ht]uhhjwJhb]rJh)rJ}rJ(hgXid (Types.Identifier) -- The identifier of the object to be archived. May be either a PID or a SID, the latter will act on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}rJ(ho]hp]hq]hr]ht]uhhjJhb]rJ(j")rJ}rJ(hgXidhm}rJ(hr]hq]j"ho]hp]ht]uhhjJhb]rJhXidrJrJ}rJ(hgUhhjJubahkj"ubhX (rJrJ}rJ(hgUhhjJubj)rJ}rJ(hgX:class:`Types.Identifier`rJhhjJhij)hkjhm}rJ(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrJhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rJj)rJ}rJ(hgjJhm}rJ(ho]hp]rJ(jjJXpy-classrJehq]hr]ht]uhhjJhb]rJhXTypes.IdentifierrJrJ}rJ(hgUhhjJubahkjubaubhX)rJ}rJ(hgUhhjJubhX -- rJrJ}rJ(hgUhhjJubhXThe identifier of the object to be archived. May be either a PID or a SID, the latter will act on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.rJrJ}rJ(hgXThe identifier of the object to be archived. May be either a PID or a SID, the latter will act on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjJubehkhubahkj;#ubehkj#ubahkhubehkhubh)rJ}rJ(hgUhm}rJ(ho]hp]hq]hr]ht]uhhj2Jhb]rJ(h)rJ}rJ(hgXReturnshhjJhij)hkhhm}rJ(ho]hp]hq]hr]ht]uhvKhb]rJhXReturnsrJrJ}rJ(hgUhhjJubaubh)rJ}rJ(hgUhm}rJ(ho]hp]hq]hr]ht]uhhjJhb]rJh)rJ}rJ(hgX/The identifier of the object that was archived.hm}rJ(ho]hp]hq]hr]ht]uhhjJhb]rJhX/The identifier of the object that was archived.rJrJ}rJ(hgX/The identifier of the object that was archived.hhjJubahkhubahkhubehkhubh)rJ}rJ(hgUhm}rJ(ho]hp]hq]hr]ht]uhhj2Jhb]rJ(h)rJ}rJ(hgX Return typehhjJhij)hkhhm}rJ(ho]hp]hq]hr]ht]uhvKhb]rJhX Return typerJrJ}rJ(hgUhhjJubaubh)rK}rK(hgUhm}rK(ho]hp]hq]hr]ht]uhhjJhb]rKh)rK}rK(hgXTypes.Identifierhm}rK(ho]hp]hq]hr]ht]uhhjKhb]rKj)rK}r K(hgX:class:`Types.Identifier`r KhhjKhij)hkjhm}r K(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr Khr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r Kj)rK}rK(hgj Khm}rK(ho]hp]rK(jj KXpy-classrKehq]hr]ht]uhhjKhb]rKhXTypes.IdentifierrKrK}rK(hgUhhjKubahkjubaubahkhubahkhubehkhubh)rK}rK(hgUhm}rK(ho]hp]hq]hr]ht]uhhj2Jhb]rK(h)rK}rK(hgXRaiseshhjKhij)hkhhm}rK(ho]hp]hq]hr]ht]uhvKhb]rKhXRaisesrKr K}r!K(hgUhhjKubaubh)r"K}r#K(hgUhm}r$K(ho]hp]hq]hr]ht]uhhjKhb]r%Kj #)r&K}r'K(hgUhm}r(K(ho]hp]hq]hr]ht]uhhj"Khb]r)K(j#)r*K}r+K(hgUhm}r,K(ho]hp]hq]hr]ht]uhhj&Khb]r-Kh)r.K}r/K(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4970)hm}r0K(ho]hp]hq]hr]ht]uhhj*Khb]r1K(j)r2K}r3K(hgUhm}r4K(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr5KU refdomainjIhr]hq]U refexplicitho]hp]ht]uhhj.Khb]r6Kj")r7K}r8K(hgj5Khm}r9K(ho]hp]hq]hr]ht]uhhj2Khb]r:KhXExceptions.NotAuthorizedr;KrKr?K}r@K(hgUhhj.Kubj)rAK}rBK(hgX$``(errorCode=401, detailCode=4970)``hm}rCK(ho]hp]hq]hr]ht]uhhj.Khb]rDKhX (errorCode=401, detailCode=4970)rEKrFK}rGK(hgUhhjAKubahkjubehkhubahkj;#ubj#)rHK}rIK(hgUhm}rJK(ho]hp]hq]hr]ht]uhhj&Khb]rKKh)rLK}rMK(hgXvExceptions.NotFound -- (errorCode=404, detailCode=4971)The archive operation failed because the object does not exist.hm}rNK(ho]hp]hq]hr]ht]uhhjHKhb]rOK(j)rPK}rQK(hgUhm}rRK(Ureftypej#j"U reftargetXExceptions.NotFoundrSKU refdomainjIhr]hq]U refexplicitho]hp]ht]uhhjLKhb]rTKj")rUK}rVK(hgjSKhm}rWK(ho]hp]hq]hr]ht]uhhjPKhb]rXKhXExceptions.NotFoundrYKrZK}r[K(hgUhhjUKubahkj"ubahkjubhX -- r\Kr]K}r^K(hgUhhjLKubh)r_K}r`K(hgX$``(errorCode=404, detailCode=4971)``raKhhjLKhij)hkhhm}rbK(ho]hp]hq]hr]ht]uhvM hb]rcKj)rdK}reK(hgjaKhm}rfK(ho]hp]hq]hr]ht]uhhj_Khb]rgKhX (errorCode=404, detailCode=4971)rhKriK}rjK(hgUhhjdKubahkjubaubh)rkK}rlK(hgX?The archive operation failed because the object does not exist.rmKhhjLKhij)hkhhm}rnK(ho]hp]hq]hr]ht]uhvM hb]roKhX?The archive operation failed because the object does not exist.rpKrqK}rrK(hgjmKhhjkKubaubehkhubahkj;#ubj#)rsK}rtK(hgUhm}ruK(ho]hp]hq]hr]ht]uhhj&Khb]rvKh)rwK}rxK(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4972)hm}ryK(ho]hp]hq]hr]ht]uhhjsKhb]rzK(j)r{K}r|K(hgUhm}r}K(Ureftypej#j"U reftargetXExceptions.ServiceFailurer~KU refdomainjIhr]hq]U refexplicitho]hp]ht]uhhjwKhb]rKj")rK}rK(hgj~Khm}rK(ho]hp]hq]hr]ht]uhhj{Khb]rKhXExceptions.ServiceFailurerKrK}rK(hgUhhjKubahkj"ubahkjubhX -- rKrK}rK(hgUhhjwKubj)rK}rK(hgX$``(errorCode=500, detailCode=4972)``hm}rK(ho]hp]hq]hr]ht]uhhjwKhb]rKhX (errorCode=500, detailCode=4972)rKrK}rK(hgUhhjKubahkjubehkhubahkj;#ubj#)rK}rK(hgUhm}rK(ho]hp]hq]hr]ht]uhhj&Khb]rKh)rK}rK(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4973)hm}rK(ho]hp]hq]hr]ht]uhhjKhb]rK(j)rK}rK(hgUhm}rK(Ureftypej#j"U reftargetXExceptions.InvalidTokenrKU refdomainjIhr]hq]U refexplicitho]hp]ht]uhhjKhb]rKj")rK}rK(hgjKhm}rK(ho]hp]hq]hr]ht]uhhjKhb]rKhXExceptions.InvalidTokenrKrK}rK(hgUhhjKubahkj"ubahkjubhX -- rKrK}rK(hgUhhjKubj)rK}rK(hgX$``(errorCode=401, detailCode=4973)``hm}rK(ho]hp]hq]hr]ht]uhhjKhb]rKhX (errorCode=401, detailCode=4973)rKrK}rK(hgUhhjKubahkjubehkhubahkj;#ubj#)rK}rK(hgUhm}rK(ho]hp]hq]hr]ht]uhhj&Khb]rKh)rK}rK(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4974)hm}rK(ho]hp]hq]hr]ht]uhhjKhb]rK(j)rK}rK(hgUhm}rK(Ureftypej#j"U reftargetXExceptions.NotImplementedrKU refdomainjIhr]hq]U refexplicitho]hp]ht]uhhjKhb]rKj")rK}rK(hgjKhm}rK(ho]hp]hq]hr]ht]uhhjKhb]rKhXExceptions.NotImplementedrKrK}rK(hgUhhjKubahkj"ubahkjubhX -- rKrK}rK(hgUhhjKubj)rK}rK(hgX$``(errorCode=501, detailCode=4974)``hm}rK(ho]hp]hq]hr]ht]uhhjKhb]rKhX (errorCode=501, detailCode=4974)rKrK}rK(hgUhhjKubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rK}rK(hgUhhj)hiNhkjhm}rK(hr]hq]ho]hp]ht]Uentries]rK(jXlistNodes() (in module CNCore)hUNtrKauhvNhwhhb]ubj!)rK}rK(hgUhhj)hiNhkj!hm}rK(j"j"XpyrKhr]hq]ho]hp]ht]j"XfunctionrKj"jKuhvNhwhhb]rK(j")rK}rK(hgXlistNodes() -> NodeListhhjKhij)hkj "hm}rK(hr]rKhaj"j0)hq]ho]hp]ht]rKhaj"X listNodesrKj"Uj"uhvM+hwhhb]rK(j")rK}rK(hgXCNCore.hhjKhij)hkj"hm}rK(ho]hp]hq]hr]ht]uhvM+hwhhb]rKhXCNCore.rKrK}rK(hgUhhjKubaubj")rK}rK(hgjKhhjKhij)hkj!"hm}rK(ho]hp]hq]hr]ht]uhvM+hwhhb]rKhX listNodesrKrK}rK(hgUhhjKubaubj'")rK}rK(hgUhhjKhij)hkj*"hm}rK(ho]hp]hq]hr]ht]uhvM+hwhhb]ubj6")rK}rK(hgXNodeListhhjKhij)hkj9"hm}rK(ho]hp]hq]hr]ht]uhvM+hwhhb]rKhXNodeListrKrK}rK(hgUhhjKubaubeubj?")rK}rK(hgUhhjKhij)hkjB"hm}rK(ho]hp]hq]hr]ht]uhvM+hwhhb]rK(h)rK}rK(hgXRReturns a list of nodes that have been registered with the DataONE infrastructure.rKhhjKhij)hkhhm}rK(ho]hp]hq]hr]ht]uhvMhwhhb]rKhXRReturns a list of nodes that have been registered with the DataONE infrastructure.rLrL}rL(hgjKhhjKubaubh)rL}rL(hgX<v2.0: The structure of :class:`v2_0.Types.Node` has changed.hhjKhij)hkhhm}rL(ho]hp]hq]hr]ht]uhvMhwhhb]rL(hXv2.0: The structure of rLrL}r L(hgXv2.0: The structure of hhjLubj)r L}r L(hgX:class:`v2_0.Types.Node`r LhhjLhij)hkjhm}r L(UreftypeXclassjjXv2_0.Types.NodeU refdomainXpyrLhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rLj)rL}rL(hgj Lhm}rL(ho]hp]rL(jjLXpy-classrLehq]hr]ht]uhhj Lhb]rLhXv2_0.Types.NoderLrL}rL(hgUhhjLubahkjubaubhX has changed.rLrL}rL(hgX has changed.hhjLubeubh)rL}rL(hgUhhjKhiNhkhhm}rL(ho]hp]hq]hr]ht]uhvNhwhhb]rL(h)r L}r!L(hgUhhjLhij)hkhhm}r"L(ho]hp]hq]hr]ht]uhvMhwhhb]r#L(h)r$L}r%L(hgXVersionhhj Lhij)hkhhm}r&L(ho]hp]hq]hr]ht]uhvKhb]r'LhXVersionr(Lr)L}r*L(hgUhhj$Lubaubh)r+L}r,L(hgX1.0, 2.0r-Lhm}r.L(ho]hp]hq]hr]ht]uhhj Lhb]r/Lh)r0L}r1L(hgj-Lhhj+Lhij)hkhhm}r2L(ho]hp]hq]hr]ht]uhvMhb]r3LhX1.0, 2.0r4Lr5L}r6L(hgj-Lhhj0Lubaubahkhubeubh)r7L}r8L(hgUhhjLhij)hkhhm}r9L(ho]hp]hq]hr]ht]uhvMhwhhb]r:L(h)r;L}rLhX Use Casesr?Lr@L}rAL(hgUhhj;Lubaubh)rBL}rCL(hgX$:doc:`UC39 `rDLhm}rEL(ho]hp]hq]hr]ht]uhhj7Lhb]rFLh)rGL}rHL(hgjDLhhjBLhij)hkhhm}rIL(ho]hp]hq]hr]ht]uhvM hb]rJLj)rKL}rLL(hgjDLhhjGLhij)hkjhm}rML(UreftypeXdocrNLjjX/design/UseCases/39_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvM hb]rOLj`2)rPL}rQL(hgjDLhm}rRL(ho]hp]rSL(jjNLehq]hr]ht]uhhjKLhb]rTLhXUC39rULrVL}rWL(hgUhhjPLubahkji2ubaubaubahkhubeubh)rXL}rYL(hgUhhjLhij)hkhhm}rZL(ho]hp]hq]hr]ht]uhvM!hwhhb]r[L(h)r\L}r]L(hgXREST URLhhjXLhij)hkhhm}r^L(ho]hp]hq]hr]ht]uhvKhb]r_LhXREST URLr`LraL}rbL(hgUhhj\Lubaubh)rcL}rdL(hgX ``GET /node``reLhm}rfL(ho]hp]hq]hr]ht]uhhjXLhb]rgLh)rhL}riL(hgjeLhhjcLhij)hkhhm}rjL(ho]hp]hq]hr]ht]uhvM!hb]rkLj)rlL}rmL(hgjeLhm}rnL(ho]hp]hq]hr]ht]uhhjhLhb]roLhX GET /noderpLrqL}rrL(hgUhhjlLubahkjubaubahkhubeubh)rsL}rtL(hgUhm}ruL(ho]hp]hq]hr]ht]uhhjLhb]rvL(h)rwL}rxL(hgXReturnshhjsLhij)hkhhm}ryL(ho]hp]hq]hr]ht]uhvKhb]rzLhXReturnsr{Lr|L}r}L(hgUhhjwLubaubh)r~L}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjsLhb]rLh)rL}rL(hgXList of nodes from the registryhm}rL(ho]hp]hq]hr]ht]uhhj~Lhb]rLhXList of nodes from the registryrLrL}rL(hgXList of nodes from the registryhhjLubahkhubahkhubehkhubh)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rL(h)rL}rL(hgX Return typehhjLhij)hkhhm}rL(ho]hp]hq]hr]ht]uhvKhb]rLhX Return typerLrL}rL(hgUhhjLubaubh)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLh)rL}rL(hgXTypes.NodeListhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLj)rL}rL(hgX:class:`Types.NodeList`rLhhjLhij)hkjhm}rL(UreftypeXclassjjXTypes.NodeListU refdomainXpyrLhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM#hb]rLj)rL}rL(hgjLhm}rL(ho]hp]rL(jjLXpy-classrLehq]hr]ht]uhhjLhb]rLhXTypes.NodeListrLrL}rL(hgUhhjLubahkjubaubahkhubahkhubehkhubh)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rL(h)rL}rL(hgXRaiseshhjLhij)hkhhm}rL(ho]hp]hq]hr]ht]uhvKhb]rLhXRaisesrLrL}rL(hgUhhjLubaubh)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLj #)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rL(j#)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLh)rL}rL(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4800)hm}rL(ho]hp]hq]hr]ht]uhhjLhb]rL(j)rL}rL(hgUhm}rL(Ureftypej#j"U reftargetXExceptions.NotImplementedrLU refdomainjKhr]hq]U refexplicitho]hp]ht]uhhjLhb]rLj")rL}rL(hgjLhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLhXExceptions.NotImplementedrLrL}rL(hgUhhjLubahkj"ubahkjubhX -- rLrL}rL(hgUhhjLubj)rL}rL(hgX$``(errorCode=501, detailCode=4800)``hm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLhX (errorCode=501, detailCode=4800)rLrL}rL(hgUhhjLubahkjubehkhubahkj;#ubj#)rL}rL(hgUhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLh)rL}rL(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4801)hm}rL(ho]hp]hq]hr]ht]uhhjLhb]rL(j)rL}rL(hgUhm}rL(Ureftypej#j"U reftargetXExceptions.ServiceFailurerLU refdomainjKhr]hq]U refexplicitho]hp]ht]uhhjLhb]rLj")rL}rL(hgjLhm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLhXExceptions.ServiceFailurerLrL}rL(hgUhhjLubahkj"ubahkjubhX -- rLrL}rL(hgUhhjLubj)rL}rL(hgX$``(errorCode=500, detailCode=4801)``hm}rL(ho]hp]hq]hr]ht]uhhjLhb]rLhX (errorCode=500, detailCode=4801)rLrL}rL(hgUhhjLubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rL}rL(hgUhhj)hiNhkjhm}rL(hr]hq]ho]hp]ht]Uentries]rL(jX$getCapabilities() (in module CNCore)hUNtrLauhvNhwhhb]ubj!)rL}rM(hgUhhj)hiNhkj!hm}rM(j"j"XpyrMhr]hq]ho]hp]ht]j"XfunctionrMj"jMuhvNhwhhb]rM(j")rM}rM(hgXgetCapabilities() -> NodehhjLhij)hkj "hm}rM(hr]rMhaj"j0)hq]ho]hp]ht]r Mhaj"XgetCapabilitiesr Mj"Uj"uhvM=hwhhb]r M(j")r M}r M(hgXCNCore.hhjMhij)hkj"hm}rM(ho]hp]hq]hr]ht]uhvM=hwhhb]rMhXCNCore.rMrM}rM(hgUhhj Mubaubj")rM}rM(hgj MhhjMhij)hkj!"hm}rM(ho]hp]hq]hr]ht]uhvM=hwhhb]rMhXgetCapabilitiesrMrM}rM(hgUhhjMubaubj'")rM}rM(hgUhhjMhij)hkj*"hm}rM(ho]hp]hq]hr]ht]uhvM=hwhhb]ubj6")rM}rM(hgXNodehhjMhij)hkj9"hm}rM(ho]hp]hq]hr]ht]uhvM=hwhhb]r MhXNoder!Mr"M}r#M(hgUhhjMubaubeubj?")r$M}r%M(hgUhhjLhij)hkjB"hm}r&M(ho]hp]hq]hr]ht]uhvM=hwhhb]r'M(h)r(M}r)M(hgXHReturns a document describing the capabilities of the Coordinating Node.r*Mhhj$Mhij)hkhhm}r+M(ho]hp]hq]hr]ht]uhvM.hwhhb]r,MhXHReturns a document describing the capabilities of the Coordinating Node.r-Mr.M}r/M(hgj*Mhhj(Mubaubh)r0M}r1M(hgX<v2.0: The structure of :class:`v2_0.Types.Node` has changed.hhj$Mhij)hkhhm}r2M(ho]hp]hq]hr]ht]uhvM0hwhhb]r3M(hXv2.0: The structure of r4Mr5M}r6M(hgXv2.0: The structure of hhj0Mubj)r7M}r8M(hgX:class:`v2_0.Types.Node`r9Mhhj0Mhij)hkjhm}r:M(UreftypeXclassjjXv2_0.Types.NodeU refdomainXpyr;Mhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM0hb]rM(hgj9Mhm}r?M(ho]hp]r@M(jj;MXpy-classrAMehq]hr]ht]uhhj7Mhb]rBMhXv2_0.Types.NoderCMrDM}rEM(hgUhhj=MubahkjubaubhX has changed.rFMrGM}rHM(hgX has changed.hhj0Mubeubh)rIM}rJM(hgUhhj$MhiNhkhhm}rKM(ho]hp]hq]hr]ht]uhvNhwhhb]rLM(h)rMM}rNM(hgUhhjIMhij)hkhhm}rOM(ho]hp]hq]hr]ht]uhvM2hwhhb]rPM(h)rQM}rRM(hgXVersionhhjMMhij)hkhhm}rSM(ho]hp]hq]hr]ht]uhvKhb]rTMhXVersionrUMrVM}rWM(hgUhhjQMubaubh)rXM}rYM(hgX1.0, 2.0rZMhm}r[M(ho]hp]hq]hr]ht]uhhjMMhb]r\Mh)r]M}r^M(hgjZMhhjXMhij)hkhhm}r_M(ho]hp]hq]hr]ht]uhvM2hb]r`MhX1.0, 2.0raMrbM}rcM(hgjZMhhj]Mubaubahkhubeubh)rdM}reM(hgUhhjIMhij)hkhhm}rfM(ho]hp]hq]hr]ht]uhvM3hwhhb]rgM(h)rhM}riM(hgXREST URLhhjdMhij)hkhhm}rjM(ho]hp]hq]hr]ht]uhvKhb]rkMhXREST URLrlMrmM}rnM(hgUhhjhMubaubh)roM}rpM(hgX ``GET /``rqMhm}rrM(ho]hp]hq]hr]ht]uhhjdMhb]rsMh)rtM}ruM(hgjqMhhjoMhij)hkhhm}rvM(ho]hp]hq]hr]ht]uhvM3hb]rwMj)rxM}ryM(hgjqMhm}rzM(ho]hp]hq]hr]ht]uhhjtMhb]r{MhXGET /r|Mr}M}r~M(hgUhhjxMubahkjubaubahkhubeubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjIMhb]rM(h)rM}rM(hgXReturnshhjMhij)hkhhm}rM(ho]hp]hq]hr]ht]uhvKhb]rMhXReturnsrMrM}rM(hgUhhjMubaubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMh)rM}rM(hgX3The technical capabilities of the Coordinating Nodehm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMhX3The technical capabilities of the Coordinating NoderMrM}rM(hgX3The technical capabilities of the Coordinating NodehhjMubahkhubahkhubehkhubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjIMhb]rM(h)rM}rM(hgX Return typehhjMhij)hkhhm}rM(ho]hp]hq]hr]ht]uhvKhb]rMhX Return typerMrM}rM(hgUhhjMubaubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMh)rM}rM(hgX Types.Nodehm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMj)rM}rM(hgX:class:`Types.Node`rMhhjMhij)hkjhm}rM(UreftypeXclassjjX Types.NodeU refdomainXpyrMhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvM5hb]rMj)rM}rM(hgjMhm}rM(ho]hp]rM(jjMXpy-classrMehq]hr]ht]uhhjMhb]rMhX Types.NoderMrM}rM(hgUhhjMubahkjubaubahkhubahkhubehkhubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjIMhb]rM(h)rM}rM(hgXRaiseshhjMhij)hkhhm}rM(ho]hp]hq]hr]ht]uhvKhb]rMhXRaisesrMrM}rM(hgUhhjMubaubh)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMj #)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rM(j#)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMh)rM}rM(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4802)hm}rM(ho]hp]hq]hr]ht]uhhjMhb]rM(j)rM}rM(hgUhm}rM(Ureftypej#j"U reftargetXExceptions.NotImplementedrMU refdomainjMhr]hq]U refexplicitho]hp]ht]uhhjMhb]rMj")rM}rM(hgjMhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMhXExceptions.NotImplementedrMrM}rM(hgUhhjMubahkj"ubahkjubhX -- rMrM}rM(hgUhhjMubj)rM}rM(hgX$``(errorCode=501, detailCode=4802)``hm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMhX (errorCode=501, detailCode=4802)rMrM}rM(hgUhhjMubahkjubehkhubahkj;#ubj#)rM}rM(hgUhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMh)rM}rM(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4803)hm}rM(ho]hp]hq]hr]ht]uhhjMhb]rM(j)rM}rM(hgUhm}rM(Ureftypej#j"U reftargetXExceptions.ServiceFailurerMU refdomainjMhr]hq]U refexplicitho]hp]ht]uhhjMhb]rMj")rM}rM(hgjMhm}rM(ho]hp]hq]hr]ht]uhhjMhb]rMhXExceptions.ServiceFailurerMrM}rM(hgUhhjMubahkj"ubahkjubhX -- rMrM}rM(hgUhhjMubj)rM}rN(hgX$``(errorCode=500, detailCode=4803)``hm}rN(ho]hp]hq]hr]ht]uhhjMhb]rNhX (errorCode=500, detailCode=4803)rNrN}rN(hgUhhjMubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rN}rN(hgUhhj)hiNhkjhm}rN(hr]hq]ho]hp]ht]Uentries]r N(jX+registerSystemMetadata() (in module CNCore)hUNtr NauhvNhwhhb]ubj!)r N}r N(hgUhhj)hiNhkj!hm}r N(j"j"XpyrNhr]hq]ho]hp]ht]j"XfunctionrNj"jNuhvNhwhhb]rN(j")rN}rN(hgX9registerSystemMetadata(session,pid,sysmeta) -> Identifierhhj Nhij)hkj "hm}rN(hr]rNhaj"j0)hq]ho]hp]ht]rNhaj"XregisterSystemMetadatarNj"Uj"uhvMbhwhhb]rN(j")rN}rN(hgXCNCore.hhjNhij)hkj"hm}rN(ho]hp]hq]hr]ht]uhvMbhwhhb]rNhXCNCore.rNrN}rN(hgUhhjNubaubj")rN}r N(hgjNhhjNhij)hkj!"hm}r!N(ho]hp]hq]hr]ht]uhvMbhwhhb]r"NhXregisterSystemMetadatar#Nr$N}r%N(hgUhhjNubaubj'")r&N}r'N(hgXsession, pid, sysmetahhjNhij)hkj*"hm}r(N(ho]hp]hq]hr]ht]uhvMbhwhhb]r)N(j-")r*N}r+N(hgXsessionhm}r,N(ho]hp]hq]hr]ht]uhhj&Nhb]r-NhXsessionr.Nr/N}r0N(hgUhhj*Nubahkj5"ubj-")r1N}r2N(hgXpidhm}r3N(ho]hp]hq]hr]ht]uhhj&Nhb]r4NhXpidr5Nr6N}r7N(hgUhhj1Nubahkj5"ubj-")r8N}r9N(hgXsysmetahm}r:N(ho]hp]hq]hr]ht]uhhj&Nhb]r;NhXsysmetarN(hgUhhj8Nubahkj5"ubeubj6")r?N}r@N(hgX IdentifierhhjNhij)hkj9"hm}rAN(ho]hp]hq]hr]ht]uhvMbhwhhb]rBNhX IdentifierrCNrDN}rEN(hgUhhj?Nubaubeubj?")rFN}rGN(hgUhhj Nhij)hkjB"hm}rHN(ho]hp]hq]hr]ht]uhvMbhwhhb]rIN(h)rJN}rKN(hgXProvides a mechanism for adding system metadata independently of its associated object, such as when adding system metadata for data objects.rLNhhjFNhij)hkhhm}rMN(ho]hp]hq]hr]ht]uhvM@hwhhb]rNNhXProvides a mechanism for adding system metadata independently of its associated object, such as when adding system metadata for data objects.rONrPN}rQN(hgjLNhhjJNubaubh)rRN}rSN(hgX5This method is used internally by Coordinating Nodes.rTNhhjFNhij)hkhhm}rUN(ho]hp]hq]hr]ht]uhvMBhwhhb]rVNhX5This method is used internally by Coordinating Nodes.rWNrXN}rYN(hgjTNhhjRNubaubh)rZN}r[N(hgXFv2.0: The structure of :class:`v2_0.Types.SystemMetadata` has changed.hhjFNhij)hkhhm}r\N(ho]hp]hq]hr]ht]uhvMDhwhhb]r]N(hXv2.0: The structure of r^Nr_N}r`N(hgXv2.0: The structure of hhjZNubj)raN}rbN(hgX":class:`v2_0.Types.SystemMetadata`rcNhhjZNhij)hkjhm}rdN(UreftypeXclassjjXv2_0.Types.SystemMetadataU refdomainXpyreNhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMDhb]rfNj)rgN}rhN(hgjcNhm}riN(ho]hp]rjN(jjeNXpy-classrkNehq]hr]ht]uhhjaNhb]rlNhXv2_0.Types.SystemMetadatarmNrnN}roN(hgUhhjgNubahkjubaubhX has changed.rpNrqN}rrN(hgX has changed.hhjZNubeubh)rsN}rtN(hgUhhjFNhiNhkhhm}ruN(ho]hp]hq]hr]ht]uhvNhwhhb]rvN(h)rwN}rxN(hgUhhjsNhij)hkhhm}ryN(ho]hp]hq]hr]ht]uhvMFhwhhb]rzN(h)r{N}r|N(hgXVersionhhjwNhij)hkhhm}r}N(ho]hp]hq]hr]ht]uhvKhb]r~NhXVersionrNrN}rN(hgUhhj{Nubaubh)rN}rN(hgX1.0, 2.0rNhm}rN(ho]hp]hq]hr]ht]uhhjwNhb]rNh)rN}rN(hgjNhhjNhij)hkhhm}rN(ho]hp]hq]hr]ht]uhvMFhb]rNhX1.0, 2.0rNrN}rN(hgjNhhjNubaubahkhubeubh)rN}rN(hgUhhjsNhij)hkhhm}rN(ho]hp]hq]hr]ht]uhvMGhwhhb]rN(h)rN}rN(hgXREST URLhhjNhij)hkhhm}rN(ho]hp]hq]hr]ht]uhvKhb]rNhXREST URLrNrN}rN(hgUhhjNubaubh)rN}rN(hgX``POST /meta``rNhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rNh)rN}rN(hgjNhhjNhij)hkhhm}rN(ho]hp]hq]hr]ht]uhvMGhb]rNj)rN}rN(hgjNhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rNhX POST /metarNrN}rN(hgUhhjNubahkjubaubahkhubeubh)rN}rN(hgUhm}rN(ho]hp]hq]hr]ht]uhhjsNhb]rN(h)rN}rN(hgX ParametershhjNhij)hkhhm}rN(ho]hp]hq]hr]ht]uhvKhb]rNhX ParametersrNrN}rN(hgUhhjNubaubh)rN}rN(hgUhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rNj #)rN}rN(hgUhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rN(j#)rN}rN(hgUhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rNh)rN}rN(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rN(ho]hp]hq]hr]ht]uhhjNhb]rN(j")rN}rN(hgXsessionhm}rN(hr]hq]j"ho]hp]ht]uhhjNhb]rNhXsessionrNrN}rN(hgUhhjNubahkj"ubhX (rNrN}rN(hgUhhjNubj)rN}rN(hgX:class:`Types.Session`rNhhjNhij)hkjhm}rN(UreftypeXclassjjX Types.SessionU refdomainXpyrNhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMIhb]rNj)rN}rN(hgjNhm}rN(ho]hp]rN(jjNXpy-classrNehq]hr]ht]uhhjNhb]rNhX Types.SessionrNrN}rN(hgUhhjNubahkjubaubhX)rN}rN(hgUhhjNubhX -- rNrN}rN(hgUhhjNubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rNrN}rN(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjNubj)rN}rN(hgX:term:`public user`rNhhjNhij)hkjhm}rN(UreftypeXtermjjX public userU refdomainXstdrNhr]hq]U refexplicitho]hp]ht]jjuhvMHhb]rNj`2)rN}rN(hgjNhm}rN(ho]hp]rN(jjNXstd-termrNehq]hr]ht]uhhjNhb]rNhX public userrNrN}rN(hgUhhjNubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rNrN}rN(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjNubehkhubahkj;#ubj#)rN}rN(hgUhm}rN(ho]hp]hq]hr]ht]uhhjNhb]rNh)rN}rN(hgXlpid (Types.Identifier) -- Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rN(ho]hp]hq]hr]ht]uhhjNhb]rN(j")rN}rO(hgXpidhm}rO(hr]hq]j"ho]hp]ht]uhhjNhb]rOhXpidrOrO}rO(hgUhhjNubahkj"ubhX (rOrO}rO(hgUhhjNubj)r O}r O(hgX:class:`Types.Identifier`r OhhjNhij)hkjhm}r O(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr Ohr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMLhb]rOj)rO}rO(hgj Ohm}rO(ho]hp]rO(jj OXpy-classrOehq]hr]ht]uhhj Ohb]rOhXTypes.IdentifierrOrO}rO(hgUhhjOubahkjubaubhX)rO}rO(hgUhhjNubhX -- rOrO}rO(hgUhhjNubhX#Transmitted as a UTF-8 String as a rOrO}rO(hgX#Transmitted as a UTF-8 String as a hhjNubj$)r O}r!O(hgX *Param part*hm}r"O(ho]hp]hq]hr]ht]uhhjNhb]r#OhX Param partr$Or%O}r&O(hgUhhj Oubahkj$ubhX% of the MIME multipart/mixed message.r'Or(O}r)O(hgX% of the MIME multipart/mixed message.hhjNubehkhubahkj;#ubj#)r*O}r+O(hgUhm}r,O(ho]hp]hq]hr]ht]uhhjNhb]r-Oh)r.O}r/O(hgXsysmeta (Types.SystemMetadata) -- Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r0O(ho]hp]hq]hr]ht]uhhj*Ohb]r1O(j")r2O}r3O(hgXsysmetahm}r4O(hr]hq]j"ho]hp]ht]uhhj.Ohb]r5OhXsysmetar6Or7O}r8O(hgUhhj2Oubahkj"ubhX (r9Or:O}r;O(hgUhhj.Oubj)rOhhj.Ohij)hkjhm}r?O(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr@Ohr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMOhb]rAOj)rBO}rCO(hgj>Ohm}rDO(ho]hp]rEO(jj@OXpy-classrFOehq]hr]ht]uhhjP}r?P(hgUhm}r@P(ho]hp]hq]hr]ht]uhhjOhb]rAPh)rBP}rCP(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4865)hm}rDP(ho]hp]hq]hr]ht]uhhj>Phb]rEP(j)rFP}rGP(hgUhm}rHP(Ureftypej#j"U reftargetXExceptions.InvalidTokenrIPU refdomainjNhr]hq]U refexplicitho]hp]ht]uhhjBPhb]rJPj")rKP}rLP(hgjIPhm}rMP(ho]hp]hq]hr]ht]uhhjFPhb]rNPhXExceptions.InvalidTokenrOPrPP}rQP(hgUhhjKPubahkj"ubahkjubhX -- rRPrSP}rTP(hgUhhjBPubj)rUP}rVP(hgX$``(errorCode=401, detailCode=4865)``hm}rWP(ho]hp]hq]hr]ht]uhhjBPhb]rXPhX (errorCode=401, detailCode=4865)rYPrZP}r[P(hgUhhjUPubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r\P}r]P(hgUhhj)hiNhkjhm}r^P(hr]hq]ho]hp]ht]Uentries]r_P(jX)updateSystemMetadata() (in module CNCore)h4UNtr`PauhvNhwhhb]ubj!)raP}rbP(hgUhhj)hiNhkj!hm}rcP(j"j"XpyrdPhr]hq]ho]hp]ht]j"XfunctionrePj"jePuhvNhwhhb]rfP(j")rgP}rhP(hgX4updateSystemMetadata(session,pid,sysmeta) -> booleanhhjaPhij)hkj "hm}riP(hr]rjPh4aj"j0)hq]ho]hp]ht]rkPh4aj"XupdateSystemMetadatarlPj"Uj"uhvMhwhhb]rmP(j")rnP}roP(hgXCNCore.hhjgPhij)hkj"hm}rpP(ho]hp]hq]hr]ht]uhvMhwhhb]rqPhXCNCore.rrPrsP}rtP(hgUhhjnPubaubj")ruP}rvP(hgjlPhhjgPhij)hkj!"hm}rwP(ho]hp]hq]hr]ht]uhvMhwhhb]rxPhXupdateSystemMetadataryPrzP}r{P(hgUhhjuPubaubj'")r|P}r}P(hgXsession, pid, sysmetahhjgPhij)hkj*"hm}r~P(ho]hp]hq]hr]ht]uhvMhwhhb]rP(j-")rP}rP(hgXsessionhm}rP(ho]hp]hq]hr]ht]uhhj|Phb]rPhXsessionrPrP}rP(hgUhhjPubahkj5"ubj-")rP}rP(hgXpidhm}rP(ho]hp]hq]hr]ht]uhhj|Phb]rPhXpidrPrP}rP(hgUhhjPubahkj5"ubj-")rP}rP(hgXsysmetahm}rP(ho]hp]hq]hr]ht]uhhj|Phb]rPhXsysmetarPrP}rP(hgUhhjPubahkj5"ubeubj6")rP}rP(hgXbooleanhhjgPhij)hkj9"hm}rP(ho]hp]hq]hr]ht]uhvMhwhhb]rPhXbooleanrPrP}rP(hgUhhjPubaubeubj?")rP}rP(hgUhhjaPhij)hkjB"hm}rP(ho]hp]hq]hr]ht]uhvMhwhhb]rP(h)rP}rP(hgXYProvides a mechanism for updating system metadata for any objects held in the federation.rPhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMehwhhb]rPhXYProvides a mechanism for updating system metadata for any objects held in the federation.rPrP}rP(hgjPhhjPubaubh)rP}rP(hgXzUsage of this method SHOULD be restricted to CNs for updating the system metadata in the underlying CN storage sub-system.rPhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMghwhhb]rPhXzUsage of this method SHOULD be restricted to CNs for updating the system metadata in the underlying CN storage sub-system.rPrP}rP(hgjPhhjPubaubh)rP}rP(hgXFv2.0: The structure of :class:`v2_0.Types.SystemMetadata` has changed.hhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMihwhhb]rP(hXv2.0: The structure of rPrP}rP(hgXv2.0: The structure of hhjPubj)rP}rP(hgX":class:`v2_0.Types.SystemMetadata`rPhhjPhij)hkjhm}rP(UreftypeXclassjjXv2_0.Types.SystemMetadataU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMihb]rPj)rP}rP(hgjPhm}rP(ho]hp]rP(jjPXpy-classrPehq]hr]ht]uhhjPhb]rPhXv2_0.Types.SystemMetadatarPrP}rP(hgUhhjPubahkjubaubhX has changed.rPrP}rP(hgX has changed.hhjPubeubh)rP}rP(hgXYNote: the serial version and the replica list in the new system metadata will be ignored.rPhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMkhwhhb]rPhXYNote: the serial version and the replica list in the new system metadata will be ignored.rPrP}rP(hgjPhhjPubaubh)rP}rP(hgUhhjPhiNhkhhm}rP(ho]hp]hq]hr]ht]uhvNhwhhb]rP(h)rP}rP(hgUhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMmhwhhb]rP(h)rP}rP(hgXVersionhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvKhb]rPhXVersionrPrP}rP(hgUhhjPubaubh)rP}rP(hgX2.0rPhm}rP(ho]hp]hq]hr]ht]uhhjPhb]rPh)rP}rP(hgjPhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMmhb]rPhX2.0rPrP}rP(hgjPhhjPubaubahkhubeubh)rP}rP(hgUhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMnhwhhb]rP(h)rP}rP(hgXREST URLhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvKhb]rPhXREST URLrPrP}rP(hgUhhjPubaubh)rP}rP(hgX ``PUT /meta``rPhm}rP(ho]hp]hq]hr]ht]uhhjPhb]rPh)rP}rP(hgjPhhjPhij)hkhhm}rP(ho]hp]hq]hr]ht]uhvMnhb]rPj)rQ}rQ(hgjPhm}rQ(ho]hp]hq]hr]ht]uhhjPhb]rQhX PUT /metarQrQ}rQ(hgUhhjQubahkjubaubahkhubeubh)rQ}rQ(hgUhm}r Q(ho]hp]hq]hr]ht]uhhjPhb]r Q(h)r Q}r Q(hgX ParametershhjQhij)hkhhm}r Q(ho]hp]hq]hr]ht]uhvKhb]rQhX ParametersrQrQ}rQ(hgUhhj Qubaubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQj #)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQ(j#)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQh)rQ}rQ(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r Q(ho]hp]hq]hr]ht]uhhjQhb]r!Q(j")r"Q}r#Q(hgXsessionhm}r$Q(hr]hq]j"ho]hp]ht]uhhjQhb]r%QhXsessionr&Qr'Q}r(Q(hgUhhj"Qubahkj"ubhX (r)Qr*Q}r+Q(hgUhhjQubj)r,Q}r-Q(hgX:class:`Types.Session`r.QhhjQhij)hkjhm}r/Q(UreftypeXclassjjX Types.SessionU refdomainXpyr0Qhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMphb]r1Qj)r2Q}r3Q(hgj.Qhm}r4Q(ho]hp]r5Q(jj0QXpy-classr6Qehq]hr]ht]uhhj,Qhb]r7QhX Types.Sessionr8Qr9Q}r:Q(hgUhhj2QubahkjubaubhX)r;Q}rQ}r?Q(hgUhhjQubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r@QrAQ}rBQ(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjQubj)rCQ}rDQ(hgX:term:`public user`rEQhhjQhij)hkjhm}rFQ(UreftypeXtermjjX public userU refdomainXstdrGQhr]hq]U refexplicitho]hp]ht]jjuhvMohb]rHQj`2)rIQ}rJQ(hgjEQhm}rKQ(ho]hp]rLQ(jjGQXstd-termrMQehq]hr]ht]uhhjCQhb]rNQhX public userrOQrPQ}rQQ(hgUhhjIQubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rRQrSQ}rTQ(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjQubehkhubahkj;#ubj#)rUQ}rVQ(hgUhm}rWQ(ho]hp]hq]hr]ht]uhhjQhb]rXQh)rYQ}rZQ(hgXlpid (Types.Identifier) -- Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r[Q(ho]hp]hq]hr]ht]uhhjUQhb]r\Q(j")r]Q}r^Q(hgXpidhm}r_Q(hr]hq]j"ho]hp]ht]uhhjYQhb]r`QhXpidraQrbQ}rcQ(hgUhhj]Qubahkj"ubhX (rdQreQ}rfQ(hgUhhjYQubj)rgQ}rhQ(hgX:class:`Types.Identifier`riQhhjYQhij)hkjhm}rjQ(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrkQhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMshb]rlQj)rmQ}rnQ(hgjiQhm}roQ(ho]hp]rpQ(jjkQXpy-classrqQehq]hr]ht]uhhjgQhb]rrQhXTypes.IdentifierrsQrtQ}ruQ(hgUhhjmQubahkjubaubhX)rvQ}rwQ(hgUhhjYQubhX -- rxQryQ}rzQ(hgUhhjYQubhX#Transmitted as a UTF-8 String as a r{Qr|Q}r}Q(hgX#Transmitted as a UTF-8 String as a hhjYQubj$)r~Q}rQ(hgX *Param part*hm}rQ(ho]hp]hq]hr]ht]uhhjYQhb]rQhX Param partrQrQ}rQ(hgUhhj~Qubahkj$ubhX% of the MIME multipart/mixed message.rQrQ}rQ(hgX% of the MIME multipart/mixed message.hhjYQubehkhubahkj;#ubj#)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQh)rQ}rQ(hgXsysmeta (Types.SystemMetadata) -- Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQ(j")rQ}rQ(hgXsysmetahm}rQ(hr]hq]j"ho]hp]ht]uhhjQhb]rQhXsysmetarQrQ}rQ(hgUhhjQubahkj"ubhX (rQrQ}rQ(hgUhhjQubj)rQ}rQ(hgX:class:`Types.SystemMetadata`rQhhjQhij)hkjhm}rQ(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrQhr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMvhb]rQj)rQ}rQ(hgjQhm}rQ(ho]hp]rQ(jjQXpy-classrQehq]hr]ht]uhhjQhb]rQhXTypes.SystemMetadatarQrQ}rQ(hgUhhjQubahkjubaubhX)rQ}rQ(hgUhhjQubhX -- rQrQ}rQ(hgUhhjQubhXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rQrQ}rQ(hgXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjQubj$)rQ}rQ(hgX *File part*hm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQhX File partrQrQ}rQ(hgUhhjQubahkj$ubhX% of the MIME multipart/mixed message.rQrQ}rQ(hgX% of the MIME multipart/mixed message.hhjQubehkhubahkj;#ubehkj#ubahkhubehkhubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjPhb]rQ(h)rQ}rQ(hgXReturnshhjQhij)hkhhm}rQ(ho]hp]hq]hr]ht]uhvKhb]rQhXReturnsrQrQ}rQ(hgUhhjQubaubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQh)rQ}rQ(hgX"True if the update was successful.hm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQhX"True if the update was successful.rQrQ}rQ(hgX"True if the update was successful.hhjQubahkhubahkhubehkhubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjPhb]rQ(h)rQ}rQ(hgX Return typehhjQhij)hkhhm}rQ(ho]hp]hq]hr]ht]uhvKhb]rQhX Return typerQrQ}rQ(hgUhhjQubaubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQh)rQ}rQ(hgXbooleanhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQj)rQ}rQ(hgUhm}rQ(Ureftypej&j"U reftargetXbooleanU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhjQhb]rQhXbooleanrQrQ}rQ(hgUhhjQubahkjubahkhubahkhubehkhubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjPhb]rQ(h)rQ}rQ(hgXRaiseshhjQhij)hkhhm}rQ(ho]hp]hq]hr]ht]uhvKhb]rQhXRaisesrQrQ}rQ(hgUhhjQubaubh)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQj #)rQ}rQ(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjQhb]rQ(j#)rQ}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhjQhb]rRh)rR}rR(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4866)hm}rR(ho]hp]hq]hr]ht]uhhjQhb]rR(j)rR}rR(hgUhm}rR(Ureftypej#j"U reftargetXExceptions.NotImplementedr RU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhjRhb]r Rj")r R}r R(hgj Rhm}r R(ho]hp]hq]hr]ht]uhhjRhb]rRhXExceptions.NotImplementedrRrR}rR(hgUhhj Rubahkj"ubahkjubhX -- rRrR}rR(hgUhhjRubj)rR}rR(hgX$``(errorCode=501, detailCode=4866)``hm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhX (errorCode=501, detailCode=4866)rRrR}rR(hgUhhjRubahkjubehkhubahkj;#ubj#)rR}rR(hgUhm}rR(ho]hp]hq]hr]ht]uhhjQhb]rRh)r R}r!R(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4867)hm}r"R(ho]hp]hq]hr]ht]uhhjRhb]r#R(j)r$R}r%R(hgUhm}r&R(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr'RU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhj Rhb]r(Rj")r)R}r*R(hgj'Rhm}r+R(ho]hp]hq]hr]ht]uhhj$Rhb]r,RhXExceptions.NotAuthorizedr-Rr.R}r/R(hgUhhj)Rubahkj"ubahkjubhX -- r0Rr1R}r2R(hgUhhj Rubj)r3R}r4R(hgX$``(errorCode=401, detailCode=4867)``hm}r5R(ho]hp]hq]hr]ht]uhhj Rhb]r6RhX (errorCode=401, detailCode=4867)r7Rr8R}r9R(hgUhhj3Rubahkjubehkhubahkj;#ubj#)r:R}r;R(hgUhm}rR}r?R(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4868)hm}r@R(ho]hp]hq]hr]ht]uhhj:Rhb]rAR(j)rBR}rCR(hgUhm}rDR(Ureftypej#j"U reftargetXExceptions.ServiceFailurerERU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhj>Rhb]rFRj")rGR}rHR(hgjERhm}rIR(ho]hp]hq]hr]ht]uhhjBRhb]rJRhXExceptions.ServiceFailurerKRrLR}rMR(hgUhhjGRubahkj"ubahkjubhX -- rNRrOR}rPR(hgUhhj>Rubj)rQR}rRR(hgX$``(errorCode=500, detailCode=4868)``hm}rSR(ho]hp]hq]hr]ht]uhhj>Rhb]rTRhX (errorCode=500, detailCode=4868)rURrVR}rWR(hgUhhjQRubahkjubehkhubahkj;#ubj#)rXR}rYR(hgUhm}rZR(ho]hp]hq]hr]ht]uhhjQhb]r[Rh)r\R}r]R(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4869)hm}r^R(ho]hp]hq]hr]ht]uhhjXRhb]r_R(j)r`R}raR(hgUhm}rbR(Ureftypej#j"U reftargetXExceptions.InvalidRequestrcRU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhj\Rhb]rdRj")reR}rfR(hgjcRhm}rgR(ho]hp]hq]hr]ht]uhhj`Rhb]rhRhXExceptions.InvalidRequestriRrjR}rkR(hgUhhjeRubahkj"ubahkjubhX -- rlRrmR}rnR(hgUhhj\Rubj)roR}rpR(hgX$``(errorCode=400, detailCode=4869)``hm}rqR(ho]hp]hq]hr]ht]uhhj\Rhb]rrRhX (errorCode=400, detailCode=4869)rsRrtR}ruR(hgUhhjoRubahkjubehkhubahkj;#ubj#)rvR}rwR(hgUhm}rxR(ho]hp]hq]hr]ht]uhhjQhb]ryRh)rzR}r{R(hgXDExceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=4956)hm}r|R(ho]hp]hq]hr]ht]uhhjvRhb]r}R(j)r~R}rR(hgUhm}rR(Ureftypej#j"U reftargetX Exceptions.InvalidSystemMetadatarRU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhjzRhb]rRj")rR}rR(hgjRhm}rR(ho]hp]hq]hr]ht]uhhj~Rhb]rRhX Exceptions.InvalidSystemMetadatarRrR}rR(hgUhhjRubahkj"ubahkjubhX -- rRrR}rR(hgUhhjzRubj)rR}rR(hgX$``(errorCode=400, detailCode=4956)``hm}rR(ho]hp]hq]hr]ht]uhhjzRhb]rRhX (errorCode=400, detailCode=4956)rRrR}rR(hgUhhjRubahkjubehkhubahkj;#ubj#)rR}rR(hgUhm}rR(ho]hp]hq]hr]ht]uhhjQhb]rRh)rR}rR(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4957)hm}rR(ho]hp]hq]hr]ht]uhhjRhb]rR(j)rR}rR(hgUhm}rR(Ureftypej#j"U reftargetXExceptions.InvalidTokenrRU refdomainjdPhr]hq]U refexplicitho]hp]ht]uhhjRhb]rRj")rR}rR(hgjRhm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhXExceptions.InvalidTokenrRrR}rR(hgUhhjRubahkj"ubahkjubhX -- rRrR}rR(hgUhhjRubj)rR}rR(hgX$``(errorCode=401, detailCode=4957)``hm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhX (errorCode=401, detailCode=4957)rRrR}rR(hgUhhjRubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rR}rR(hgUhhj)hiNhkjhm}rR(hr]hq]ho]hp]ht]Uentries]rR(jX#hasReservation() (in module CNCore)h9UNtrRauhvNhwhhb]ubj!)rR}rR(hgUhhj)hiNhkj!hm}rR(j"j"XpyrRhr]hq]ho]hp]ht]j"XfunctionrRj"jRuhvNhwhhb]rR(j")rR}rR(hgX-hasReservation(session,subject,id) -> booleanhhjRhiXAinternal padding after source/apis/generated/generated_CNCore.txtrRhkj "hm}rR(hr]rRh9aj"j0)hq]ho]hp]ht]rRh9aj"XhasReservationrRj"Uj"uhvMhwhhb]rR(j")rR}rR(hgXCNCore.hhjRhijRhkj"hm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rRhXCNCore.rRrR}rR(hgUhhjRubaubj")rR}rR(hgjRhhjRhijRhkj!"hm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rRhXhasReservationrRrR}rR(hgUhhjRubaubj'")rR}rR(hgXsession, subject, idhhjRhijRhkj*"hm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rR(j-")rR}rR(hgXsessionhm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhXsessionrRrR}rR(hgUhhjRubahkj5"ubj-")rR}rR(hgXsubjecthm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhXsubjectrRrR}rR(hgUhhjRubahkj5"ubj-")rR}rR(hgXidhm}rR(ho]hp]hq]hr]ht]uhhjRhb]rRhXidrRrR}rR(hgUhhjRubahkj5"ubeubj6")rR}rR(hgXbooleanhhjRhijRhkj9"hm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rRhXbooleanrRrR}rR(hgUhhjRubaubeubj?")rR}rR(hgUhhjRhijRhkjB"hm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rR(h)rR}rR(hgXVChecks to determine if the supplied *subject* is the owner of the reservation of *id*.hhjRhij)hkhhm}rR(ho]hp]hq]hr]ht]uhvMhwhhb]rR(hX$Checks to determine if the supplied rRrR}rR(hgX$Checks to determine if the supplied hhjRubj$)rR}rR(hgX *subject*hm}rS(ho]hp]hq]hr]ht]uhhjRhb]rShXsubjectrSrS}rS(hgUhhjRubahkj$ubhX$ is the owner of the reservation of rSrS}rS(hgX$ is the owner of the reservation of hhjRubj$)rS}r S(hgX*id*hm}r S(ho]hp]hq]hr]ht]uhhjRhb]r ShXidr Sr S}rS(hgUhhjSubahkj$ubhX.rS}rS(hgX.hhjRubeubh)rS}rS(hgXyA positive response (that the *pid* is reserved and owned by *subject*) is indicated by a return of a HTTP status of 200.hhjRhij)hkhhm}rS(ho]hp]hq]hr]ht]uhvMhwhhb]rS(hXA positive response (that the rSrS}rS(hgXA positive response (that the hhjSubj$)rS}rS(hgX*pid*hm}rS(ho]hp]hq]hr]ht]uhhjShb]rShXpidrSrS}rS(hgUhhjSubahkj$ubhX is reserved and owned by rSr S}r!S(hgX is reserved and owned by hhjSubj$)r"S}r#S(hgX *subject*hm}r$S(ho]hp]hq]hr]ht]uhhjShb]r%ShXsubjectr&Sr'S}r(S(hgUhhj"Subahkj$ubhX3) is indicated by a return of a HTTP status of 200.r)Sr*S}r+S(hgX3) is indicated by a return of a HTTP status of 200.hhjSubeubh)r,S}r-S(hgXUA negative response is indicated by an exception and the associated HTTP status code.r.ShhjRhij)hkhhm}r/S(ho]hp]hq]hr]ht]uhvMhwhhb]r0ShXUA negative response is indicated by an exception and the associated HTTP status code.r1Sr2S}r3S(hgj.Shhj,Subaubh)r4S}r5S(hgX9v2.0: The identifier may be a :term:`PID` or :term:`SID`.hhjRhij)hkhhm}r6S(ho]hp]hq]hr]ht]uhvMhwhhb]r7S(hXv2.0: The identifier may be a r8Sr9S}r:S(hgXv2.0: The identifier may be a hhj4Subj)r;S}rS(UreftypeXtermjjXpidU refdomainXstdr?Shr]hq]U refexplicitho]hp]ht]jjuhvMhb]r@Sj`2)rAS}rBS(hgj=Shm}rCS(ho]hp]rDS(jj?SXstd-termrESehq]hr]ht]uhhj;Shb]rFShXPIDrGSrHS}rIS(hgUhhjASubahkji2ubaubhX or rJSrKS}rLS(hgX or hhj4Subj)rMS}rNS(hgX :term:`SID`rOShhj4Shij)hkjhm}rPS(UreftypeXtermjjXsidU refdomainXstdrQShr]hq]U refexplicitho]hp]ht]jjuhvMhb]rRSj`2)rSS}rTS(hgjOShm}rUS(ho]hp]rVS(jjQSXstd-termrWSehq]hr]ht]uhhjMShb]rXShXSIDrYSrZS}r[S(hgUhhjSSubahkji2ubaubhX.r\S}r]S(hgX.hhj4Subeubh)r^S}r_S(hgUhhjRhiNhkhhm}r`S(ho]hp]hq]hr]ht]uhvNhwhhb]raS(h)rbS}rcS(hgUhhj^Shij)hkhhm}rdS(ho]hp]hq]hr]ht]uhvMhwhhb]reS(h)rfS}rgS(hgXVersionhhjbShij)hkhhm}rhS(ho]hp]hq]hr]ht]uhvKhb]riShXVersionrjSrkS}rlS(hgUhhjfSubaubh)rmS}rnS(hgX1.0, 2.0roShm}rpS(ho]hp]hq]hr]ht]uhhjbShb]rqSh)rrS}rsS(hgjoShhjmShij)hkhhm}rtS(ho]hp]hq]hr]ht]uhvMhb]ruShX1.0, 2.0rvSrwS}rxS(hgjoShhjrSubaubahkhubeubh)ryS}rzS(hgUhhj^Shij)hkhhm}r{S(ho]hp]hq]hr]ht]uhvMhwhhb]r|S(h)r}S}r~S(hgXREST URLhhjyShij)hkhhm}rS(ho]hp]hq]hr]ht]uhvKhb]rShXREST URLrSrS}rS(hgUhhj}Subaubh)rS}rS(hgX'``GET /reserve/{id}?subject={subject}``rShm}rS(ho]hp]hq]hr]ht]uhhjyShb]rSh)rS}rS(hgjShhjShij)hkhhm}rS(ho]hp]hq]hr]ht]uhvMhb]rSj)rS}rS(hgjShm}rS(ho]hp]hq]hr]ht]uhhjShb]rShX#GET /reserve/{id}?subject={subject}rSrS}rS(hgUhhjSubahkjubaubahkhubeubh)rS}rS(hgUhm}rS(ho]hp]hq]hr]ht]uhhj^Shb]rS(h)rS}rS(hgX ParametershhjShijRhkhhm}rS(ho]hp]hq]hr]ht]uhvKhb]rShX ParametersrSrS}rS(hgUhhjSubaubh)rS}rS(hgUhm}rS(ho]hp]hq]hr]ht]uhhjShb]rSj #)rS}rS(hgUhm}rS(ho]hp]hq]hr]ht]uhhjShb]rS(j#)rS}rS(hgUhm}rS(ho]hp]hq]hr]ht]uhhjShb]rSh)rS}rS(hgX session (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to an authority trusted by the DataONE Coordinating Nodes. Transmitted as part of the SSL handshake process.hm}rS(ho]hp]hq]hr]ht]uhhjShb]rS(j")rS}rS(hgXsessionhm}rS(hr]hq]j"ho]hp]ht]uhhjShb]rShXsessionrSrS}rS(hgUhhjSubahkj"ubhX (rSrS}rS(hgUhhjSubj)rS}rS(hgX:class:`Types.Session`rShhjShij)hkjhm}rS(UreftypeXclassjjX Types.SessionU refdomainXpyrShr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rSj)rS}rS(hgjShm}rS(ho]hp]rS(jjSXpy-classrSehq]hr]ht]uhhjShb]rShX Types.SessionrSrS}rS(hgUhhjSubahkjubaubhX)rS}rS(hgUhhjSubhX -- rSrS}rS(hgUhhjSubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to an authority trusted by the DataONE Coordinating Nodes. Transmitted as part of the SSL handshake process.rSrS}rS(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to an authority trusted by the DataONE Coordinating Nodes. Transmitted as part of the SSL handshake process.hhjSubehkhubahkj;#ubj#)rS}rS(hgUhm}rS(ho]hp]hq]hr]ht]uhhjShb]rSh)rS}rS(hgXsubject (Types.Subject) -- The subject of the principal (user) that made the reservation. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rS(ho]hp]hq]hr]ht]uhhjShb]rS(j")rS}rS(hgXsubjecthm}rS(hr]hq]j"ho]hp]ht]uhhjShb]rShXsubjectrSrS}rS(hgUhhjSubahkj"ubhX (rSrS}rS(hgUhhjSubj)rS}rS(hgX:class:`Types.Subject`rShhjShij)hkjhm}rS(UreftypeXclassjjX Types.SubjectU refdomainXpyrShr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]rSj)rS}rS(hgjShm}rS(ho]hp]rS(jjSXpy-classrSehq]hr]ht]uhhjShb]rShX Types.SubjectrSrS}rS(hgUhhjSubahkjubaubhX)rS}rS(hgUhhjSubhX -- rSrS}rS(hgUhhjSubhXThe subject of the rSrS}rS(hgXThe subject of the hhjSubj)rS}rS(hgX:term:`principal`rShhjShij)hkjhm}rS(UreftypeXtermjjX principalU refdomainXstdrShr]hq]U refexplicitho]hp]ht]jjuhvMhb]rSj`2)rS}rT(hgjShm}rT(ho]hp]rT(jjSXstd-termrTehq]hr]ht]uhhjShb]rThX principalrTrT}rT(hgUhhjSubahkji2ubaubhXm (user) that made the reservation. Transmitted as a URL query parameter, and so must be escaped accordingly.rTr T}r T(hgXm (user) that made the reservation. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjSubehkhubahkj;#ubj#)r T}r T(hgUhm}r T(ho]hp]hq]hr]ht]uhhjShb]rTh)rT}rT(hgXid (Types.Identifier) -- The identifier that is being checked for existing as a reserved identifier or is in use as an identifier for an existing object. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hm}rT(ho]hp]hq]hr]ht]uhhj Thb]rT(j")rT}rT(hgXidhm}rT(hr]hq]j"ho]hp]ht]uhhjThb]rThXidrTrT}rT(hgUhhjTubahkj"ubhX (rTrT}rT(hgUhhjTubj)rT}rT(hgX:class:`Types.Identifier`rThhjThij)hkjhm}r T(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr!Thr]hq]U refexplicitho]hp]ht]jjjNjj0)uhvMhb]r"Tj)r#T}r$T(hgjThm}r%T(ho]hp]r&T(jj!TXpy-classr'Tehq]hr]ht]uhhjThb]r(ThXTypes.Identifierr)Tr*T}r+T(hgUhhj#TubahkjubaubhX)r,T}r-T(hgUhhjTubhX -- r.Tr/T}r0T(hgUhhjTubhXThe identifier that is being checked for existing as a reserved identifier or is in use as an identifier for an existing object. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.r1Tr2T}r3T(hgXThe identifier that is being checked for existing as a reserved identifier or is in use as an identifier for an existing object. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hhjTubehkhubahkj;#ubehkj#ubahkhubehkhubh)r4T}r5T(hgUhm}r6T(ho]hp]hq]hr]ht]uhhj^Shb]r7T(h)r8T}r9T(hgXReturnshhj4ThijRhkhhm}r:T(ho]hp]hq]hr]ht]uhvKhb]r;ThXReturnsrT(hgUhhj8Tubaubh)r?T}r@T(hgUhm}rAT(ho]hp]hq]hr]ht]uhhj4Thb]rBTh)rCT}rDT(hgXTrue - subject has the reservation on the PID; False - the PID does not exist; False - the PID is already in use; False - the PID is reserved by somone else.hm}rET(ho]hp]hq]hr]ht]uhhj?Thb]rFThXTrue - subject has the reservation on the PID; False - the PID does not exist; False - the PID is already in use; False - the PID is reserved by somone else.rGTrHT}rIT(hgXTrue - subject has the reservation on the PID; False - the PID does not exist; False - the PID is already in use; False - the PID is reserved by somone else.hhjCTubahkhubahkhubehkhubh)rJT}rKT(hgUhm}rLT(ho]hp]hq]hr]ht]uhhj^Shb]rMT(h)rNT}rOT(hgX Return typehhjJThijRhkhhm}rPT(ho]hp]hq]hr]ht]uhvKhb]rQThX Return typerRTrST}rTT(hgUhhjNTubaubh)rUT}rVT(hgUhm}rWT(ho]hp]hq]hr]ht]uhhjJThb]rXTh)rYT}rZT(hgXbooleanhm}r[T(ho]hp]hq]hr]ht]uhhjUThb]r\Tj)r]T}r^T(hgUhm}r_T(Ureftypej&j"U reftargetXbooleanU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhjYThb]r`ThXbooleanraTrbT}rcT(hgUhhj]Tubahkjubahkhubahkhubehkhubh)rdT}reT(hgUhm}rfT(ho]hp]hq]hr]ht]uhhj^Shb]rgT(h)rhT}riT(hgXRaiseshhjdThijRhkhhm}rjT(ho]hp]hq]hr]ht]uhvKhb]rkThXRaisesrlTrmT}rnT(hgUhhjhTubaubh)roT}rpT(hgUhm}rqT(ho]hp]hq]hr]ht]uhhjdThb]rrTj #)rsT}rtT(hgUhm}ruT(ho]hp]hq]hr]ht]uhhjoThb]rvT(j#)rwT}rxT(hgUhm}ryT(ho]hp]hq]hr]ht]uhhjsThb]rzTh)r{T}r|T(hgXiExceptions.NotImplemented -- (errorCode=501, detailCode=4920)The method functionality is not implemented.hm}r}T(ho]hp]hq]hr]ht]uhhjwThb]r~T(j)rT}rT(hgUhm}rT(Ureftypej#j"U reftargetXExceptions.NotImplementedrTU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhj{Thb]rTj")rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThXExceptions.NotImplementedrTrT}rT(hgUhhjTubahkj"ubahkjubhX -- rTrT}rT(hgUhhj{Tubh)rT}rT(hgX$``(errorCode=501, detailCode=4920)``rThhj{Thij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rTj)rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThX (errorCode=501, detailCode=4920)rTrT}rT(hgUhhjTubahkjubaubh)rT}rT(hgX,The method functionality is not implemented.rThhj{Thij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rThX,The method functionality is not implemented.rTrT}rT(hgjThhjTubaubehkhubahkj;#ubj#)rT}rT(hgUhm}rT(ho]hp]hq]hr]ht]uhhjsThb]rTh)rT}rT(hgX_Exceptions.ServiceFailure -- (errorCode=500, detailCode=4921)An internal server error occurred.hm}rT(ho]hp]hq]hr]ht]uhhjThb]rT(j)rT}rT(hgUhm}rT(Ureftypej#j"U reftargetXExceptions.ServiceFailurerTU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhjThb]rTj")rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThXExceptions.ServiceFailurerTrT}rT(hgUhhjTubahkj"ubahkjubhX -- rTrT}rT(hgUhhjTubh)rT}rT(hgX$``(errorCode=500, detailCode=4921)``rThhjThij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rTj)rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThX (errorCode=500, detailCode=4921)rTrT}rT(hgUhhjTubahkjubaubh)rT}rT(hgX"An internal server error occurred.rThhjThij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rThX"An internal server error occurred.rTrT}rT(hgjThhjTubaubehkhubahkj;#ubj#)rT}rT(hgUhm}rT(ho]hp]hq]hr]ht]uhhjsThb]rTh)rT}rT(hgX^Exceptions.InvalidToken -- (errorCode=401, detailCode=4922)The session information is invalid.hm}rT(ho]hp]hq]hr]ht]uhhjThb]rT(j)rT}rT(hgUhm}rT(Ureftypej#j"U reftargetXExceptions.InvalidTokenrTU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhjThb]rTj")rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThXExceptions.InvalidTokenrTrT}rT(hgUhhjTubahkj"ubahkjubhX -- rTrT}rT(hgUhhjTubh)rT}rT(hgX$``(errorCode=401, detailCode=4922)``rThhjThij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rTj)rT}rT(hgjThm}rT(ho]hp]hq]hr]ht]uhhjThb]rThX (errorCode=401, detailCode=4922)rTrT}rT(hgUhhjTubahkjubaubh)rT}rT(hgX#The session information is invalid.rThhjThij)hkhhm}rT(ho]hp]hq]hr]ht]uhvMhb]rThX#The session information is invalid.rTrT}rT(hgjThhjTubaubehkhubahkj;#ubj#)rT}rT(hgUhm}rT(ho]hp]hq]hr]ht]uhhjsThb]rTh)rT}rT(hgXExceptions.NotFound -- (errorCode=404, detailCode=4923)The PID does not exist as a reservation or an existing object and is not in use as an identifier.hm}rT(ho]hp]hq]hr]ht]uhhjThb]rT(j)rU}rU(hgUhm}rU(Ureftypej#j"U reftargetXExceptions.NotFoundrUU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhjThb]rUj")rU}rU(hgjUhm}rU(ho]hp]hq]hr]ht]uhhjUhb]rUhXExceptions.NotFoundr Ur U}r U(hgUhhjUubahkj"ubahkjubhX -- r Ur U}rU(hgUhhjTubh)rU}rU(hgX$``(errorCode=404, detailCode=4923)``rUhhjThij)hkhhm}rU(ho]hp]hq]hr]ht]uhvMhb]rUj)rU}rU(hgjUhm}rU(ho]hp]hq]hr]ht]uhhjUhb]rUhX (errorCode=404, detailCode=4923)rUrU}rU(hgUhhjUubahkjubaubh)rU}rU(hgXaThe PID does not exist as a reservation or an existing object and is not in use as an identifier.rUhhjThij)hkhhm}rU(ho]hp]hq]hr]ht]uhvMhb]rUhXaThe PID does not exist as a reservation or an existing object and is not in use as an identifier.r Ur!U}r"U(hgjUhhjUubaubehkhubahkj;#ubj#)r#U}r$U(hgUhm}r%U(ho]hp]hq]hr]ht]uhhjsThb]r&Uh)r'U}r(U(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4924)The PID is reserved but the owner is not the principal identified by the subjectInfo OR the provide session does not have authority to access this service.hm}r)U(ho]hp]hq]hr]ht]uhhj#Uhb]r*U(j)r+U}r,U(hgUhm}r-U(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr.UU refdomainjRhr]hq]U refexplicitho]hp]ht]uhhj'Uhb]r/Uj")r0U}r1U(hgj.Uhm}r2U(ho]hp]hq]hr]ht]uhhj+Uhb]r3UhXExceptions.NotAuthorizedr4Ur5U}r6U(hgUhhj0Uubahkj"ubahkjubhX -- r7Ur8U}r9U(hgUhhj'Uubh)r:U}r;U(hgX$``(errorCode=401, detailCode=4924)``rUj)r?U}r@U(hgj)rV}rV(hgUhm}rV(hr]hq]ho]hp]ht]UcolwidthKuhhjUhb]hkjBubj>)rV}rV(hgUhm}rV(hr]hq]ho]hp]ht]UcolwidthKuhhjUhb]hkjBubj>)rV}rV(hgUhm}rV(hr]hq]ho]hp]ht]UcolwidthK uhhjUhb]hkjBubj>)r V}r V(hgUhm}r V(hr]hq]ho]hp]ht]UcolwidthK uhhjUhb]hkjBubj>)r V}r V(hgUhm}rV(hr]hq]ho]hp]ht]UcolwidthKuhhjUhb]hkjBubjO)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjUhb]rVjT)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjVhb]rV(jY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjVhb]rVh)rV}rV(hgXTierrVhhjVhijUhkhhm}rV(ho]hp]hq]hr]ht]uhvK hb]rVhXTierr Vr!V}r"V(hgjVhhjVubaubahkjfubjY)r#V}r$V(hgUhm}r%V(ho]hp]hq]hr]ht]uhhjVhb]r&Vh)r'V}r(V(hgXVersionr)Vhhj#VhijUhkhhm}r*V(ho]hp]hq]hr]ht]uhvK hb]r+VhXVersionr,Vr-V}r.V(hgj)Vhhj'VubaubahkjfubjY)r/V}r0V(hgUhm}r1V(ho]hp]hq]hr]ht]uhhjVhb]r2Vh)r3V}r4V(hgXRESTr5Vhhj/VhijUhkhhm}r6V(ho]hp]hq]hr]ht]uhvK hb]r7VhXRESTr8Vr9V}r:V(hgj5Vhhj3VubaubahkjfubjY)r;V}rVh)r?V}r@V(hgXFunctionrAVhhj;VhijUhkhhm}rBV(ho]hp]hq]hr]ht]uhvK hb]rCVhXFunctionrDVrEV}rFV(hgjAVhhj?VubaubahkjfubjY)rGV}rHV(hgUhm}rIV(ho]hp]hq]hr]ht]uhhjVhb]rJVh)rKV}rLV(hgX ParametersrMVhhjGVhijUhkhhm}rNV(ho]hp]hq]hr]ht]uhvK hb]rOVhX ParametersrPVrQV}rRV(hgjMVhhjKVubaubahkjfubehkjubahkjubj)rSV}rTV(hgUhm}rUV(ho]hp]hq]hr]ht]uhhjUhb]rVV(jT)rWV}rXV(hgUhm}rYV(ho]hp]hq]hr]ht]uhhjSVhb]rZV(jY)r[V}r\V(hgUhm}r]V(ho]hp]hq]hr]ht]uhhjWVhb]r^Vh)r_V}r`V(hgXTier 1raVhhj[VhijUhkhhm}rbV(ho]hp]hq]hr]ht]uhvKhb]rcVhXTier 1rdVreV}rfV(hgjaVhhj_VubaubahkjfubjY)rgV}rhV(hgUhm}riV(ho]hp]hq]hr]ht]uhhjWVhb]rjVh)rkV}rlV(hgX1.0, 2.0rmVhhjgVhijUhkhhm}rnV(ho]hp]hq]hr]ht]uhvKhb]roVhX1.0, 2.0rpVrqV}rrV(hgjmVhhjkVubaubahkjfubjY)rsV}rtV(hgUhm}ruV(ho]hp]hq]hr]ht]uhhjWVhb]rvVh)rwV}rxV(hgX``GET /object/{id}``ryVhhjsVhijUhkhhm}rzV(ho]hp]hq]hr]ht]uhvKhb]r{Vj)r|V}r}V(hgjyVhm}r~V(ho]hp]hq]hr]ht]uhhjwVhb]rVhXGET /object/{id}rVrV}rV(hgUhhj|VubahkjubaubahkjfubjY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjWVhb]rVh)rV}rV(hgX :func:`get`rVhhjVhijUhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rVj)rV}rV(hgjVhhjVhijUhkjhm}rV(UreftypeXfuncjjXgetU refdomainXpyrVhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rVj)rV}rV(hgjVhm}rV(ho]hp]rV(jjVXpy-funcrVehq]hr]ht]uhhjVhb]rVhXget()rVrV}rV(hgUhhjVubahkjubaubaubahkjfubjY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjWVhb]rVh)rV}rV(hgXb(:class:`session`, :class:`id`) ``->`` :class:`Types.OctetStream`rVhhjVhijUhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rV(hX(rV}rV(hgX(hhjVubj)rV}rV(hgX:class:`session`rVhhjVhijUhkjhm}rV(UreftypeXclassjjX Types.SessionU refdomainXpyrVhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rVj)rV}rV(hgjVhm}rV(ho]hp]rV(jjVXpy-classrVehq]hr]ht]uhhjVhb]rVhXsessionrVrV}rV(hgUhhjVubahkjubaubhX, rVrV}rV(hgX, hhjVubj)rV}rV(hgX:class:`id`rVhhjVhijUhkjhm}rV(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrVhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rVj)rV}rV(hgjVhm}rV(ho]hp]rV(jjVXpy-classrVehq]hr]ht]uhhjVhb]rVhXidrVrV}rV(hgUhhjVubahkjubaubhX) rVrV}rV(hgX) hhjVubj)rV}rV(hgX``->``hm}rV(ho]hp]hq]hr]ht]uhhjVhb]rVhX->rVrV}rV(hgUhhjVubahkjubhX rV}rV(hgX hhjVubj)rV}rV(hgX:class:`Types.OctetStream`rVhhjVhijUhkjhm}rV(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrVhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rVj)rV}rV(hgjVhm}rV(ho]hp]rV(jjVXpy-classrVehq]hr]ht]uhhjVhb]rVhXTypes.OctetStreamrVrV}rV(hgUhhjVubahkjubaubeubahkjfubehkjubjT)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjSVhb]rV(jY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjVhb]rVh)rV}rV(hgXTier 1rVhhjVhijUhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rVhXTier 1rVrV}rV(hgjVhhjVubaubahkjfubjY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjVhb]rVh)rV}rV(hgX1.0, 2.0rVhhjVhijUhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rVhX1.0, 2.0rVrV}rV(hgjVhhjVubaubahkjfubjY)rV}rV(hgUhm}rV(ho]hp]hq]hr]ht]uhhjVhb]rWh)rW}rW(hgX``GET /meta/{id}``rWhhjVhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]hq]hr]ht]uhhjWhb]r WhXGET /meta/{id}r Wr W}r W(hgUhhjWubahkjubaubahkjfubjY)r W}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjVhb]rWh)rW}rW(hgX:func:`getSystemMetadata`rWhhj WhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rWj)rW}rW(hgjWhhjWhijUhkjhm}rW(UreftypeXfuncjjXgetSystemMetadataU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]rW(jjWXpy-funcrWehq]hr]ht]uhhjWhb]r WhXgetSystemMetadata()r!Wr"W}r#W(hgUhhjWubahkjubaubaubahkjfubjY)r$W}r%W(hgUhm}r&W(ho]hp]hq]hr]ht]uhhjVhb]r'Wh)r(W}r)W(hgXe(:class:`session`, :class:`id`) ``->`` :class:`Types.SystemMetadata`r*Whhj$WhijUhkhhm}r+W(ho]hp]hq]hr]ht]uhvKhb]r,W(hX(r-W}r.W(hgX(hhj(Wubj)r/W}r0W(hgX:class:`session`r1Whhj(WhijUhkjhm}r2W(UreftypeXclassjjX Types.SessionU refdomainXpyr3Whr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r4Wj)r5W}r6W(hgj1Whm}r7W(ho]hp]r8W(jj3WXpy-classr9Wehq]hr]ht]uhhj/Whb]r:WhXsessionr;WrWr?W}r@W(hgX, hhj(Wubj)rAW}rBW(hgX:class:`id`rCWhhj(WhijUhkjhm}rDW(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrEWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rFWj)rGW}rHW(hgjCWhm}rIW(ho]hp]rJW(jjEWXpy-classrKWehq]hr]ht]uhhjAWhb]rLWhXidrMWrNW}rOW(hgUhhjGWubahkjubaubhX) rPWrQW}rRW(hgX) hhj(Wubj)rSW}rTW(hgX``->``hm}rUW(ho]hp]hq]hr]ht]uhhj(Whb]rVWhX->rWWrXW}rYW(hgUhhjSWubahkjubhX rZW}r[W(hgX hhj(Wubj)r\W}r]W(hgX:class:`Types.SystemMetadata`r^Whhj(WhijUhkjhm}r_W(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr`Whr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]raWj)rbW}rcW(hgj^Whm}rdW(ho]hp]reW(jj`WXpy-classrfWehq]hr]ht]uhhj\Whb]rgWhXTypes.SystemMetadatarhWriW}rjW(hgUhhjbWubahkjubaubeubahkjfubehkjubjT)rkW}rlW(hgUhm}rmW(ho]hp]hq]hr]ht]uhhjSVhb]rnW(jY)roW}rpW(hgUhm}rqW(ho]hp]hq]hr]ht]uhhjkWhb]rrWh)rsW}rtW(hgXTier 1ruWhhjoWhijUhkhhm}rvW(ho]hp]hq]hr]ht]uhvKhb]rwWhXTier 1rxWryW}rzW(hgjuWhhjsWubaubahkjfubjY)r{W}r|W(hgUhm}r}W(ho]hp]hq]hr]ht]uhhjkWhb]r~Wh)rW}rW(hgX1.0, 2.0rWhhj{WhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rWhX1.0, 2.0rWrW}rW(hgjWhhjWubaubahkjfubjY)rW}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjkWhb]rWh)rW}rW(hgX``HEAD /object/{id}``rWhhjWhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]hq]hr]ht]uhhjWhb]rWhXHEAD /object/{id}rWrW}rW(hgUhhjWubahkjubaubahkjfubjY)rW}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjkWhb]rWh)rW}rW(hgX:func:`describe`rWhhjWhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rWj)rW}rW(hgjWhhjWhijUhkjhm}rW(UreftypeXfuncjjXdescribeU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]rW(jjWXpy-funcrWehq]hr]ht]uhhjWhb]rWhX describe()rWrW}rW(hgUhhjWubahkjubaubaubahkjfubjY)rW}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjkWhb]rWh)rW}rW(hgXg(:class:`session`, :class:`id`) ``->`` :class:`Types.DescribeResponse`rWhhjWhijUhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rW(hX(rW}rW(hgX(hhjWubj)rW}rW(hgX:class:`session`rWhhjWhijUhkjhm}rW(UreftypeXclassjjX Types.SessionU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]rW(jjWXpy-classrWehq]hr]ht]uhhjWhb]rWhXsessionrWrW}rW(hgUhhjWubahkjubaubhX, rWrW}rW(hgX, hhjWubj)rW}rW(hgX:class:`id`rWhhjWhijUhkjhm}rW(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]rW(jjWXpy-classrWehq]hr]ht]uhhjWhb]rWhXidrWrW}rW(hgUhhjWubahkjubaubhX) rWrW}rW(hgX) hhjWubj)rW}rW(hgX``->``hm}rW(ho]hp]hq]hr]ht]uhhjWhb]rWhX->rWrW}rW(hgUhhjWubahkjubhX rW}rW(hgX hhjWubj)rW}rW(hgX:class:`Types.DescribeResponse`rWhhjWhijUhkjhm}rW(UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyrWhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rWj)rW}rW(hgjWhm}rW(ho]hp]rW(jjWXpy-classrWehq]hr]ht]uhhjWhb]rWhXTypes.DescribeResponserWrW}rW(hgUhhjWubahkjubaubeubahkjfubehkjubjT)rW}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjSVhb]rW(jY)rW}rW(hgUhm}rW(ho]hp]hq]hr]ht]uhhjWhb]rWh)rW}rW(hgXTier 1rWhhjWhijUhkhhm}rX(ho]hp]hq]hr]ht]uhvKhb]rXhXTier 1rXrX}rX(hgjWhhjWubaubahkjfubjY)rX}rX(hgUhm}rX(ho]hp]hq]hr]ht]uhhjWhb]rXh)r X}r X(hgX1.0, 2.0r XhhjXhijUhkhhm}r X(ho]hp]hq]hr]ht]uhvKhb]r XhX1.0, 2.0rXrX}rX(hgj Xhhj XubaubahkjfubjY)rX}rX(hgUhm}rX(ho]hp]hq]hr]ht]uhhjWhb]rXh)rX}rX(hgX``GET /resolve/{id}``rXhhjXhijUhkhhm}rX(ho]hp]hq]hr]ht]uhvKhb]rXj)rX}rX(hgjXhm}rX(ho]hp]hq]hr]ht]uhhjXhb]rXhXGET /resolve/{id}rXrX}r X(hgUhhjXubahkjubaubahkjfubjY)r!X}r"X(hgUhm}r#X(ho]hp]hq]hr]ht]uhhjWhb]r$Xh)r%X}r&X(hgX:func:`resolve`r'Xhhj!XhijUhkhhm}r(X(ho]hp]hq]hr]ht]uhvK hb]r)Xj)r*X}r+X(hgj'Xhhj%XhijUhkjhm}r,X(UreftypeXfuncjjXresolveU refdomainXpyr-Xhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK hb]r.Xj)r/X}r0X(hgj'Xhm}r1X(ho]hp]r2X(jj-XXpy-funcr3Xehq]hr]ht]uhhj*Xhb]r4XhX resolve()r5Xr6X}r7X(hgUhhj/XubahkjubaubaubahkjfubjY)r8X}r9X(hgUhm}r:X(ho]hp]hq]hr]ht]uhhjWhb]r;Xh)r`, :class:`id`) ``->`` :class:`Types.ObjectLocationList`r>Xhhj8XhijUhkhhm}r?X(ho]hp]hq]hr]ht]uhvK!hb]r@X(hX(rAX}rBX(hgX(hhj`rEXhhj`rWXhhj``hm}riX(ho]hp]hq]hr]ht]uhhjrkXrlX}rmX(hgUhhjgXubahkjubhX rnX}roX(hgX hhj`, :class:`pid`) ``->`` :class:`Types.Checksum`rXhhjXhijUhkhhm}rX(ho]hp]hq]hr]ht]uhvK&hb]rX(hX(rX}rX(hgX(hhjXubj)rX}rX(hgX:class:`session`rXhhjXhijUhkjhm}rX(UreftypeXclassjjX Types.SessionU refdomainXpyrXhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK&hb]rXj)rX}rX(hgjXhm}rX(ho]hp]rX(jjXXpy-classrXehq]hr]ht]uhhjXhb]rXhXsessionrXrX}rX(hgUhhjXubahkjubaubhX, rXrX}rX(hgX, hhjXubj)rX}rX(hgX:class:`pid`rXhhjXhijUhkjhm}rX(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrXhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK&hb]rXj)rX}rX(hgjXhm}rX(ho]hp]rX(jjXXpy-classrXehq]hr]ht]uhhjXhb]rXhXpidrXrX}rX(hgUhhjXubahkjubaubhX) rXrX}rX(hgX) hhjXubj)rX}rX(hgX``->``hm}rX(ho]hp]hq]hr]ht]uhhjXhb]rXhX->rXrX}rX(hgUhhjXubahkjubhX rX}rX(hgX hhjXubj)rX}rX(hgX:class:`Types.Checksum`rXhhjXhijUhkjhm}rX(UreftypeXclassjjXTypes.ChecksumU refdomainXpyrXhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK&hb]rXj)rY}rY(hgjXhm}rY(ho]hp]rY(jjXXpy-classrYehq]hr]ht]uhhjXhb]rYhXTypes.ChecksumrYrY}rY(hgUhhjYubahkjubaubeubahkjfubehkjubjT)r Y}r Y(hgUhm}r Y(ho]hp]hq]hr]ht]uhhjSVhb]r Y(jY)r Y}rY(hgUhm}rY(ho]hp]hq]hr]ht]uhhj Yhb]rYh)rY}rY(hgXTier 1rYhhj YhijUhkhhm}rY(ho]hp]hq]hr]ht]uhvK'hb]rYhXTier 1rYrY}rY(hgjYhhjYubaubahkjfubjY)rY}rY(hgUhm}rY(ho]hp]hq]hr]ht]uhhj Yhb]rYh)rY}rY(hgX 1.0, (2.0)rYhhjYhijUhkhhm}r Y(ho]hp]hq]hr]ht]uhvK(hb]r!YhX 1.0, (2.0)r"Yr#Y}r$Y(hgjYhhjYubaubahkjfubjY)r%Y}r&Y(hgUhm}r'Y(ho]hp]hq]hr]ht]uhhj Yhb]r(Yh)r)Y}r*Y(hgX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]``r+Yhhj%YhijUhkhhm}r,Y(ho]hp]hq]hr]ht]uhvK)hb]r-Yj)r.Y}r/Y(hgj+Yhm}r0Y(ho]hp]hq]hr]ht]uhhj)Yhb]r1YhXGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]r2Yr3Y}r4Y(hgUhhj.YubahkjubaubahkjfubjY)r5Y}r6Y(hgUhm}r7Y(ho]hp]hq]hr]ht]uhhj Yhb]r8Yh)r9Y}r:Y(hgX:func:`listObjects`r;Yhhj5YhijUhkhhm}rY}r?Y(hgj;Yhhj9YhijUhkjhm}r@Y(UreftypeXfuncjjX listObjectsU refdomainXpyrAYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK*hb]rBYj)rCY}rDY(hgj;Yhm}rEY(ho]hp]rFY(jjAYXpy-funcrGYehq]hr]ht]uhhj>Yhb]rHYhX listObjects()rIYrJY}rKY(hgUhhjCYubahkjubaubaubahkjfubjY)rLY}rMY(hgUhm}rNY(ho]hp]hq]hr]ht]uhhj Yhb]rOYh)rPY}rQY(hgX/(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[formatId]`, :class:`[identifier]`, ``[start=0]``, ``[count=1000]``, :class:`[nodeId]`) ``->`` :class:`Types.ObjectList`rRYhhjLYhijUhkhhm}rSY(ho]hp]hq]hr]ht]uhvK+hb]rTY(hX(rUY}rVY(hgX(hhjPYubj)rWY}rXY(hgX:class:`session`rYYhhjPYhijUhkjhm}rZY(UreftypeXclassjjX Types.SessionU refdomainXpyr[Yhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]r\Yj)r]Y}r^Y(hgjYYhm}r_Y(ho]hp]r`Y(jj[YXpy-classraYehq]hr]ht]uhhjWYhb]rbYhXsessionrcYrdY}reY(hgUhhj]YubahkjubaubhX, rfYrgY}rhY(hgX, hhjPYubj)riY}rjY(hgX#:class:`[fromDate]`rkYhhjPYhijUhkjhm}rlY(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrmYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rnYj)roY}rpY(hgjkYhm}rqY(ho]hp]rrY(jjmYXpy-classrsYehq]hr]ht]uhhjiYhb]rtYhX [fromDate]ruYrvY}rwY(hgUhhjoYubahkjubaubhX, rxYryY}rzY(hgX, hhjPYubj)r{Y}r|Y(hgX!:class:`[toDate]`r}YhhjPYhijUhkjhm}r~Y(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rYj)rY}rY(hgj}Yhm}rY(ho]hp]rY(jjYXpy-classrYehq]hr]ht]uhhj{Yhb]rYhX[toDate]rYrY}rY(hgUhhjYubahkjubaubhX, rYrY}rY(hgX, hhjPYubj)rY}rY(hgX1:class:`[formatId]`rYhhjPYhijUhkjhm}rY(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rYj)rY}rY(hgjYhm}rY(ho]hp]rY(jjYXpy-classrYehq]hr]ht]uhhjYhb]rYhX [formatId]rYrY}rY(hgUhhjYubahkjubaubhX, rYrY}rY(hgX, hhjPYubj)rY}rY(hgX':class:`[identifier]`rYhhjPYhijUhkjhm}rY(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rYj)rY}rY(hgjYhm}rY(ho]hp]rY(jjYXpy-classrYehq]hr]ht]uhhjYhb]rYhX [identifier]rYrY}rY(hgUhhjYubahkjubaubhX, rYrY}rY(hgX, hhjPYubj)rY}rY(hgX ``[start=0]``hm}rY(ho]hp]hq]hr]ht]uhhjPYhb]rYhX [start=0]rYrY}rY(hgUhhjYubahkjubhX, rYrY}rY(hgX, hhjPYubj)rY}rY(hgX``[count=1000]``hm}rY(ho]hp]hq]hr]ht]uhhjPYhb]rYhX [count=1000]rYrY}rY(hgUhhjYubahkjubhX, rYrY}rY(hgX, hhjPYubj)rY}rY(hgX&:class:`[nodeId]`rYhhjPYhijUhkjhm}rY(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rYj)rY}rY(hgjYhm}rY(ho]hp]rY(jjYXpy-classrYehq]hr]ht]uhhjYhb]rYhX[nodeId]rYrY}rY(hgUhhjYubahkjubaubhX) rYrY}rY(hgX) hhjPYubj)rY}rY(hgX``->``hm}rY(ho]hp]hq]hr]ht]uhhjPYhb]rYhX->rYrY}rY(hgUhhjYubahkjubhX rY}rY(hgX hhjPYubj)rY}rY(hgX:class:`Types.ObjectList`rYhhjPYhijUhkjhm}rY(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrYhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK+hb]rYj)rY}rY(hgjYhm}rY(ho]hp]rY(jjYXpy-classrYehq]hr]ht]uhhjYhb]rYhXTypes.ObjectListrYrY}rY(hgUhhjYubahkjubaubeubahkjfubehkjubjT)rY}rY(hgUhm}rY(ho]hp]hq]hr]ht]uhhjSVhb]rY(jY)rY}rY(hgUhm}rY(ho]hp]hq]hr]ht]uhhjYhb]rYh)rY}rY(hgXTier 1rYhhjYhijUhkhhm}rY(ho]hp]hq]hr]ht]uhvK,hb]rYhXTier 1rYrY}rY(hgjYhhjYubaubahkjfubjY)rY}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhjYhb]rZh)rZ}rZ(hgX 1.0, (2.0)rZhhjYhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK-hb]rZhX 1.0, (2.0)rZr Z}r Z(hgjZhhjZubaubahkjfubjY)r Z}r Z(hgUhm}r Z(ho]hp]hq]hr]ht]uhhjYhb]rZh)rZ}rZ(hgX#``GET /search/{queryType}/{query}``rZhhj ZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK.hb]rZj)rZ}rZ(hgjZhm}rZ(ho]hp]hq]hr]ht]uhhjZhb]rZhXGET /search/{queryType}/{query}rZrZ}rZ(hgUhhjZubahkjubaubahkjfubjY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhjYhb]rZh)rZ}r Z(hgX:func:`search`r!ZhhjZhijUhkhhm}r"Z(ho]hp]hq]hr]ht]uhvK/hb]r#Zj)r$Z}r%Z(hgj!ZhhjZhijUhkjhm}r&Z(UreftypeXfuncjjXsearchU refdomainXpyr'Zhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK/hb]r(Zj)r)Z}r*Z(hgj!Zhm}r+Z(ho]hp]r,Z(jj'ZXpy-funcr-Zehq]hr]ht]uhhj$Zhb]r.ZhXsearch()r/Zr0Z}r1Z(hgUhhj)ZubahkjubaubaubahkjfubjY)r2Z}r3Z(hgUhm}r4Z(ho]hp]hq]hr]ht]uhhjYhb]r5Zh)r6Z}r7Z(hgX\(:class:`session`, ``queryType``, ``query``) ``->`` :class:`Types.ObjectList`r8Zhhj2ZhijUhkhhm}r9Z(ho]hp]hq]hr]ht]uhvK0hb]r:Z(hX(r;Z}rZ(hgX:class:`session`r?Zhhj6ZhijUhkjhm}r@Z(UreftypeXclassjjX Types.SessionU refdomainXpyrAZhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK0hb]rBZj)rCZ}rDZ(hgj?Zhm}rEZ(ho]hp]rFZ(jjAZXpy-classrGZehq]hr]ht]uhhj=Zhb]rHZhXsessionrIZrJZ}rKZ(hgUhhjCZubahkjubaubhX, rLZrMZ}rNZ(hgX, hhj6Zubj)rOZ}rPZ(hgX ``queryType``hm}rQZ(ho]hp]hq]hr]ht]uhhj6Zhb]rRZhX queryTyperSZrTZ}rUZ(hgUhhjOZubahkjubhX, rVZrWZ}rXZ(hgX, hhj6Zubj)rYZ}rZZ(hgX ``query``hm}r[Z(ho]hp]hq]hr]ht]uhhj6Zhb]r\ZhXqueryr]Zr^Z}r_Z(hgUhhjYZubahkjubhX) r`ZraZ}rbZ(hgX) hhj6Zubj)rcZ}rdZ(hgX``->``hm}reZ(ho]hp]hq]hr]ht]uhhj6Zhb]rfZhX->rgZrhZ}riZ(hgUhhjcZubahkjubhX rjZ}rkZ(hgX hhj6Zubj)rlZ}rmZ(hgX:class:`Types.ObjectList`rnZhhj6ZhijUhkjhm}roZ(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrpZhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK0hb]rqZj)rrZ}rsZ(hgjnZhm}rtZ(ho]hp]ruZ(jjpZXpy-classrvZehq]hr]ht]uhhjlZhb]rwZhXTypes.ObjectListrxZryZ}rzZ(hgUhhjrZubahkjubaubeubahkjfubehkjubjT)r{Z}r|Z(hgUhm}r}Z(ho]hp]hq]hr]ht]uhhjSVhb]r~Z(jY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj{Zhb]rZh)rZ}rZ(hgXTier 1rZhhjZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK1hb]rZhXTier 1rZrZ}rZ(hgjZhhjZubaubahkjfubjY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj{Zhb]rZh)rZ}rZ(hgX 1.1, (2.0)rZhhjZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK2hb]rZhX 1.1, (2.0)rZrZ}rZ(hgjZhhjZubaubahkjfubjY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj{Zhb]rZh)rZ}rZ(hgX$``GET /query/{queryEngine}/{query}``rZhhjZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK3hb]rZj)rZ}rZ(hgjZhm}rZ(ho]hp]hq]hr]ht]uhhjZhb]rZhX GET /query/{queryEngine}/{query}rZrZ}rZ(hgUhhjZubahkjubaubahkjfubjY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj{Zhb]rZh)rZ}rZ(hgX :func:`query`rZhhjZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK4hb]rZj)rZ}rZ(hgjZhhjZhijUhkjhm}rZ(UreftypeXfuncjjXqueryU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK4hb]rZj)rZ}rZ(hgjZhm}rZ(ho]hp]rZ(jjZXpy-funcrZehq]hr]ht]uhhjZhb]rZhXquery()rZrZ}rZ(hgUhhjZubahkjubaubaubahkjfubjY)rZ}rZ(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj{Zhb]rZh)rZ}rZ(hgX_(:class:`session`, ``queryEngine``, ``query``) ``->`` :class:`Types.OctetStream`rZhhjZhijUhkhhm}rZ(ho]hp]hq]hr]ht]uhvK5hb]rZ(hX(rZ}rZ(hgX(hhjZubj)rZ}rZ(hgX:class:`session`rZhhjZhijUhkjhm}rZ(UreftypeXclassjjX Types.SessionU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK5hb]rZj)rZ}rZ(hgjZhm}rZ(ho]hp]rZ(jjZXpy-classrZehq]hr]ht]uhhjZhb]rZhXsessionrZrZ}rZ(hgUhhjZubahkjubaubhX, rZrZ}rZ(hgX, hhjZubj)rZ}rZ(hgX``queryEngine``hm}rZ(ho]hp]hq]hr]ht]uhhjZhb]rZhX queryEnginerZrZ}rZ(hgUhhjZubahkjubhX, rZrZ}rZ(hgX, hhjZubj)rZ}rZ(hgX ``query``hm}rZ(ho]hp]hq]hr]ht]uhhjZhb]rZhXqueryrZrZ}rZ(hgUhhjZubahkjubhX) rZrZ}rZ(hgX) hhjZubj)rZ}rZ(hgX``->``hm}rZ(ho]hp]hq]hr]ht]uhhjZhb]rZhX->rZrZ}rZ(hgUhhjZubahkjubhX rZ}rZ(hgX hhjZubj)rZ}rZ(hgX:class:`Types.OctetStream`rZhhjZhijUhkjhm}rZ(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrZhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK5hb]rZj)rZ}rZ(hgjZhm}r[(ho]hp]r[(jjZXpy-classr[ehq]hr]ht]uhhjZhb]r[hXTypes.OctetStreamr[r[}r[(hgUhhjZubahkjubaubeubahkjfubehkjubjT)r[}r[(hgUhm}r [(ho]hp]hq]hr]ht]uhhjSVhb]r [(jY)r [}r [(hgUhm}r [(ho]hp]hq]hr]ht]uhhj[hb]r[h)r[}r[(hgXTier 1r[hhj [hijUhkhhm}r[(ho]hp]hq]hr]ht]uhvK6hb]r[hXTier 1r[r[}r[(hgj[hhj[ubaubahkjfubjY)r[}r[(hgUhm}r[(ho]hp]hq]hr]ht]uhhj[hb]r[h)r[}r[(hgX 1.1, (2.0)r[hhj[hijUhkhhm}r[(ho]hp]hq]hr]ht]uhvK7hb]r[hX 1.1, (2.0)r [r![}r"[(hgj[hhjbaubahkjfubjY)r#[}r$[(hgUhm}r%[(ho]hp]hq]hr]ht]uhhj[hb]r&[h)r'[}r([(hgX``GET /query/{queryType}``r)[hhj#[hijUhkhhm}r*[(ho]hp]hq]hr]ht]uhvK8hb]r+[j)r,[}r-[(hgj)[hm}r.[(ho]hp]hq]hr]ht]uhhj'[hb]r/[hXGET /query/{queryType}r0[r1[}r2[(hgUhhj,[ubahkjubaubahkjfubjY)r3[}r4[(hgUhm}r5[(ho]hp]hq]hr]ht]uhhj[hb]r6[h)r7[}r8[(hgX!:func:`getQueryEngineDescription`r9[hhj3[hijUhkhhm}r:[(ho]hp]hq]hr]ht]uhvK9hb]r;[j)r<[}r=[(hgj9[hhj7[hijUhkjhm}r>[(UreftypeXfuncjjXgetQueryEngineDescriptionU refdomainXpyr?[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK9hb]r@[j)rA[}rB[(hgj9[hm}rC[(ho]hp]rD[(jj?[Xpy-funcrE[ehq]hr]ht]uhhj<[hb]rF[hXgetQueryEngineDescription()rG[rH[}rI[(hgUhhjA[ubahkjubaubaubahkjfubjY)rJ[}rK[(hgUhm}rL[(ho]hp]hq]hr]ht]uhhj[hb]rM[h)rN[}rO[(hgX_(:class:`session`, ``queryEngine``) ``->`` :class:`Types.QueryEngineDescription`rP[hhjJ[hijUhkhhm}rQ[(ho]hp]hq]hr]ht]uhvK:hb]rR[(hX(rS[}rT[(hgX(hhjN[ubj)rU[}rV[(hgX:class:`session`rW[hhjN[hijUhkjhm}rX[(UreftypeXclassjjX Types.SessionU refdomainXpyrY[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK:hb]rZ[j)r[[}r\[(hgjW[hm}r][(ho]hp]r^[(jjY[Xpy-classr_[ehq]hr]ht]uhhjU[hb]r`[hXsessionra[rb[}rc[(hgUhhj[[ubahkjubaubhX, rd[re[}rf[(hgX, hhjN[ubj)rg[}rh[(hgX``queryEngine``hm}ri[(ho]hp]hq]hr]ht]uhhjN[hb]rj[hX queryEnginerk[rl[}rm[(hgUhhjg[ubahkjubhX) rn[ro[}rp[(hgX) hhjN[ubj)rq[}rr[(hgX``->``hm}rs[(ho]hp]hq]hr]ht]uhhjN[hb]rt[hX->ru[rv[}rw[(hgUhhjq[ubahkjubhX rx[}ry[(hgX hhjN[ubj)rz[}r{[(hgX%:class:`Types.QueryEngineDescription`r|[hhjN[hijUhkjhm}r}[(UreftypeXclassjjXTypes.QueryEngineDescriptionU refdomainXpyr~[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK:hb]r[j)r[}r[(hgj|[hm}r[(ho]hp]r[(jj~[Xpy-classr[ehq]hr]ht]uhhjz[hb]r[hXTypes.QueryEngineDescriptionr[r[}r[(hgUhhj[ubahkjubaubeubahkjfubehkjubjT)r[}r[(hgUhm}r[(ho]hp]hq]hr]ht]uhhjSVhb]r[(jY)r[}r[(hgUhm}r[(ho]hp]hq]hr]ht]uhhj[hb]r[h)r[}r[(hgXTier 1r[hhj[hijUhkhhm}r[(ho]hp]hq]hr]ht]uhvK;hb]r[hXTier 1r[r[}r[(hgj[hhj[ubaubahkjfubjY)r[}r[(hgUhm}r[(ho]hp]hq]hr]ht]uhhj[hb]r[h)r[}r[(hgX 1.1, (2.0)r[hhj[hijUhkhhm}r[(ho]hp]hq]hr]ht]uhvKhb]r[j)r[}r[(hgj[hhj[hijUhkjhm}r[(UreftypeXfuncjjXlistQueryEnginesU refdomainXpyr[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK>hb]r[j)r[}r[(hgj[hm}r[(ho]hp]r[(jj[Xpy-funcr[ehq]hr]ht]uhhj[hb]r[hXlistQueryEngines()r[r[}r[(hgUhhj[ubahkjubaubaubahkjfubjY)r[}r[(hgUhm}r[(ho]hp]hq]hr]ht]uhhj[hb]r[h)r[}r[(hgXG(:class:`session`) ``->`` :class:`Types.QueryEngineList`r[hhj[hijUhkhhm}r[(ho]hp]hq]hr]ht]uhvK?hb]r[(hX(r[}r[(hgX(hhj[ubj)r[}r[(hgX:class:`session`r[hhj[hijUhkjhm}r[(UreftypeXclassjjX Types.SessionU refdomainXpyr[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK?hb]r[j)r[}r[(hgj[hm}r[(ho]hp]r[(jj[Xpy-classr[ehq]hr]ht]uhhj[hb]r[hXsessionr[r[}r[(hgUhhj[ubahkjubaubhX) r[r[}r[(hgX) hhj[ubj)r[}r[(hgX``->``hm}r[(ho]hp]hq]hr]ht]uhhj[hb]r[hX->r[r[}r[(hgUhhj[ubahkjubhX r[}r[(hgX hhj[ubj)r[}r[(hgX:class:`Types.QueryEngineList`r[hhj[hijUhkjhm}r[(UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyr[hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK?hb]r[j)r[}r[(hgj[hm}r[(ho]hp]r[(jj[Xpy-classr[ehq]hr]ht]uhhj[hb]r[hXTypes.QueryEngineListr[r[}r\(hgUhhj[ubahkjubaubeubahkjfubehkjubjT)r\}r\(hgUhm}r\(ho]hp]hq]hr]ht]uhhjSVhb]r\(jY)r\}r\(hgUhm}r\(ho]hp]hq]hr]ht]uhhj\hb]r\h)r \}r \(hgXTier 1r \hhj\hijUhkhhm}r \(ho]hp]hq]hr]ht]uhvK@hb]r \hXTier 1r\r\}r\(hgj \hhj \ubaubahkjfubjY)r\}r\(hgUhm}r\(ho]hp]hq]hr]ht]uhhj\hb]r\h)r\}r\(hgX2.0r\hhj\hijUhkhhm}r\(ho]hp]hq]hr]ht]uhvKAhb]r\hX2.0r\r\}r\(hgj\hhj\ubaubahkjfubjY)r\}r\(hgUhm}r\(ho]hp]hq]hr]ht]uhhj\hb]r \h)r!\}r"\(hgX``POST /synchronize``r#\hhj\hijUhkhhm}r$\(ho]hp]hq]hr]ht]uhvKBhb]r%\j)r&\}r'\(hgj#\hm}r(\(ho]hp]hq]hr]ht]uhhj!\hb]r)\hXPOST /synchronizer*\r+\}r,\(hgUhhj&\ubahkjubaubahkjfubjY)r-\}r.\(hgUhm}r/\(ho]hp]hq]hr]ht]uhhj\hb]r0\h)r1\}r2\(hgX:func:`synchronize`r3\hhj-\hijUhkhhm}r4\(ho]hp]hq]hr]ht]uhvKChb]r5\j)r6\}r7\(hgj3\hhj1\hijUhkjhm}r8\(UreftypeXfuncjjX synchronizeU refdomainXpyr9\hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKChb]r:\j)r;\}r<\(hgj3\hm}r=\(ho]hp]r>\(jj9\Xpy-funcr?\ehq]hr]ht]uhhj6\hb]r@\hX synchronize()rA\rB\}rC\(hgUhhj;\ubahkjubaubaubahkjfubjY)rD\}rE\(hgUhm}rF\(ho]hp]hq]hr]ht]uhhj\hb]rG\h)rH\}rI\(hgXP(:class:`session`, :class:`pid`) ``->`` booleanrJ\hhjD\hijUhkhhm}rK\(ho]hp]hq]hr]ht]uhvKDhb]rL\(hX(rM\}rN\(hgX(hhjH\ubj)rO\}rP\(hgX:class:`session`rQ\hhjH\hijUhkjhm}rR\(UreftypeXclassjjX Types.SessionU refdomainXpyrS\hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKDhb]rT\j)rU\}rV\(hgjQ\hm}rW\(ho]hp]rX\(jjS\Xpy-classrY\ehq]hr]ht]uhhjO\hb]rZ\hXsessionr[\r\\}r]\(hgUhhjU\ubahkjubaubhX, r^\r_\}r`\(hgX, hhjH\ubj)ra\}rb\(hgX:class:`pid`rc\hhjH\hijUhkjhm}rd\(UreftypeXclassjjXTypes.IdentifierU refdomainXpyre\hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKDhb]rf\j)rg\}rh\(hgjc\hm}ri\(ho]hp]rj\(jje\Xpy-classrk\ehq]hr]ht]uhhja\hb]rl\hXpidrm\rn\}ro\(hgUhhjg\ubahkjubaubhX) rp\rq\}rr\(hgX) hhjH\ubj)rs\}rt\(hgX``->``hm}ru\(ho]hp]hq]hr]ht]uhhjH\hb]rv\hX->rw\rx\}ry\(hgUhhjs\ubahkjubhX booleanrz\r{\}r|\(hgX booleanhhjH\ubeubahkjfubehkjubehkjubehkjubeubj)r}\}r~\(hgUhhjUhiNhkjhm}r\(hr]hq]ho]hp]ht]Uentries]r\(jXget() (in module CNRead)hUNtr\auhvNhwhhb]ubj!)r\}r\(hgUhhjUhiNhkj!hm}r\(j"j"Xpyr\hr]hq]ho]hp]ht]j"Xfunctionr\j"j\uhvNhwhhb]r\(j")r\}r\(hgXget(session,id) -> OctetStreamhhj\hijUhkj "hm}r\(hr]r\haj"jUhq]ho]hp]ht]r\haj"Xgetr\j"Uj"uhvKhhwhhb]r\(j")r\}r\(hgXCNRead.hhj\hijUhkj"hm}r\(ho]hp]hq]hr]ht]uhvKhhwhhb]r\hXCNRead.r\r\}r\(hgUhhj\ubaubj")r\}r\(hgj\hhj\hijUhkj!"hm}r\(ho]hp]hq]hr]ht]uhvKhhwhhb]r\hXgetr\r\}r\(hgUhhj\ubaubj'")r\}r\(hgX session, idhhj\hijUhkj*"hm}r\(ho]hp]hq]hr]ht]uhvKhhwhhb]r\(j-")r\}r\(hgXsessionhm}r\(ho]hp]hq]hr]ht]uhhj\hb]r\hXsessionr\r\}r\(hgUhhj\ubahkj5"ubj-")r\}r\(hgXidhm}r\(ho]hp]hq]hr]ht]uhhj\hb]r\hXidr\r\}r\(hgUhhj\ubahkj5"ubeubj6")r\}r\(hgX OctetStreamhhj\hijUhkj9"hm}r\(ho]hp]hq]hr]ht]uhvKhhwhhb]r\hX OctetStreamr\r\}r\(hgUhhj\ubaubeubj?")r\}r\(hgUhhj\hijUhkjB"hm}r\(ho]hp]hq]hr]ht]uhvKhhwhhb]r\(h)r\}r\(hgXRetrieves the object identified by *id* from the node. If the object is not present on the node, then an :exc:`Exceptions.NotFound` error is raised, regardless of whether the object exists on another node in the DataONE system.hhj\hijUhkhhm}r\(ho]hp]hq]hr]ht]uhvKKhwhhb]r\(hX#Retrieves the object identified by r\r\}r\(hgX#Retrieves the object identified by hhj\ubj$)r\}r\(hgX*id*hm}r\(ho]hp]hq]hr]ht]uhhj\hb]r\hXidr\r\}r\(hgUhhj\ubahkj$ubhXB from the node. If the object is not present on the node, then an r\r\}r\(hgXB from the node. If the object is not present on the node, then an hhj\ubj)r\}r\(hgX:exc:`Exceptions.NotFound`r\hhj\hijUhkjhm}r\(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyr\hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKKhb]r\j)r\}r\(hgj\hm}r\(ho]hp]r\(jj\Xpy-excr\ehq]hr]ht]uhhj\hb]r\hXExceptions.NotFoundr\r\}r\(hgUhhj\ubahkjubaubhX` error is raised, regardless of whether the object exists on another node in the DataONE system.r\r\}r\(hgX` error is raised, regardless of whether the object exists on another node in the DataONE system.hhj\ubeubh)r\}r\(hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhj\hijUhkhhm}r\(ho]hp]hq]hr]ht]uhvKMhwhhb]r\(hX'v2.0: The supplied identifier may be a r\r\}r\(hgX'v2.0: The supplied identifier may be a hhj\ubj)r\}r\(hgX :term:`PID`r\hhj\hijUhkjhm}r\(UreftypeXtermjjXpidU refdomainXstdr\hr]hq]U refexplicitho]hp]ht]jjuhvKMhb]r\j`2)r\}r\(hgj\hm}r\(ho]hp]r\(jj\Xstd-termr\ehq]hr]ht]uhhj\hb]r\hXPIDr\r\}r\(hgUhhj\ubahkji2ubaubhX or a r\r\}r\(hgX or a hhj\ubj)r\}r\(hgX :term:`SID`r\hhj\hijUhkjhm}r\(UreftypeXtermjjXsidU refdomainXstdr\hr]hq]U refexplicitho]hp]ht]jjuhvKMhb]r\j`2)r\}r\(hgj\hm}r\(ho]hp]r\(jj\Xstd-termr]ehq]hr]ht]uhhj\hb]r]hXSIDr]r]}r](hgUhhj\ubahkji2ubaubhX.r]}r](hgX.hhj\ubeubh)r]}r](hgUhhj\hiNhkhhm}r ](ho]hp]hq]hr]ht]uhvNhwhhb]r ](h)r ]}r ](hgUhhj]hijUhkhhm}r ](ho]hp]hq]hr]ht]uhvKOhwhhb]r](h)r]}r](hgXVersionhhj ]hijUhkhhm}r](ho]hp]hq]hr]ht]uhvKhb]r]hXVersionr]r]}r](hgUhhj]ubaubh)r]}r](hgX1.0, 2.0r]hm}r](ho]hp]hq]hr]ht]uhhj ]hb]r]h)r]}r](hgj]hhj]hijUhkhhm}r](ho]hp]hq]hr]ht]uhvKOhb]r]hX1.0, 2.0r]r ]}r!](hgj]hhj]ubaubahkhubeubh)r"]}r#](hgUhhj]hijUhkhhm}r$](ho]hp]hq]hr]ht]uhvKPhwhhb]r%](h)r&]}r'](hgX Use Caseshhj"]hijUhkhhm}r(](ho]hp]hq]hr]ht]uhvKhb]r)]hX Use Casesr*]r+]}r,](hgUhhj&]ubaubh)r-]}r.](hgXp:doc:`UC01 `, :doc:`UC16 `, :doc:`UC09 `r/]hm}r0](ho]hp]hq]hr]ht]uhhj"]hb]r1]h)r2]}r3](hgj/]hhj-]hijUhkhhm}r4](ho]hp]hq]hr]ht]uhvKQhb]r5](j)r6]}r7](hgX$:doc:`UC01 `r8]hhj2]hijUhkjhm}r9](UreftypeXdocr:]jjX/design/UseCases/01_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKQhb]r;]j`2)r<]}r=](hgj8]hm}r>](ho]hp]r?](jj:]ehq]hr]ht]uhhj6]hb]r@]hXUC01rA]rB]}rC](hgUhhj<]ubahkji2ubaubhX, rD]rE]}rF](hgX, hhj2]ubj)rG]}rH](hgX$:doc:`UC16 `rI]hhj2]hijUhkjhm}rJ](UreftypeXdocrK]jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKQhb]rL]j`2)rM]}rN](hgjI]hm}rO](ho]hp]rP](jjK]ehq]hr]ht]uhhjG]hb]rQ]hXUC16rR]rS]}rT](hgUhhjM]ubahkji2ubaubhX, rU]rV]}rW](hgX, hhj2]ubj)rX]}rY](hgX$:doc:`UC09 `rZ]hhj2]hijUhkjhm}r[](UreftypeXdocr\]jjX/design/UseCases/09_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKQhb]r]]j`2)r^]}r_](hgjZ]hm}r`](ho]hp]ra](jj\]ehq]hr]ht]uhhjX]hb]rb]hXUC09rc]rd]}re](hgUhhj^]ubahkji2ubaubeubahkhubeubh)rf]}rg](hgUhhj]hijUhkhhm}rh](ho]hp]hq]hr]ht]uhvKRhwhhb]ri](h)rj]}rk](hgXREST URLhhjf]hijUhkhhm}rl](ho]hp]hq]hr]ht]uhvKhb]rm]hXREST URLrn]ro]}rp](hgUhhjj]ubaubh)rq]}rr](hgX``GET /object/{id}``rs]hm}rt](ho]hp]hq]hr]ht]uhhjf]hb]ru]h)rv]}rw](hgjs]hhjq]hijUhkhhm}rx](ho]hp]hq]hr]ht]uhvKRhb]ry]j)rz]}r{](hgjs]hm}r|](ho]hp]hq]hr]ht]uhhjv]hb]r}]hXGET /object/{id}r~]r]}r](hgUhhjz]ubahkjubaubahkhubeubh)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r](h)r]}r](hgX Parametershhj]hijUhkhhm}r](ho]hp]hq]hr]ht]uhvKhb]r]hX Parametersr]r]}r](hgUhhj]ubaubh)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r]j #)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r](j#)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r]h)r]}r](hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r](ho]hp]hq]hr]ht]uhhj]hb]r](j")r]}r](hgXsessionhm}r](hr]hq]j"ho]hp]ht]uhhj]hb]r]hXsessionr]r]}r](hgUhhj]ubahkj"ubhX (r]r]}r](hgUhhj]ubj)r]}r](hgX:class:`Types.Session`r]hhj]hijUhkjhm}r](UreftypeXclassjjX Types.SessionU refdomainXpyr]hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKThb]r]j)r]}r](hgj]hm}r](ho]hp]r](jj]Xpy-classr]ehq]hr]ht]uhhj]hb]r]hX Types.Sessionr]r]}r](hgUhhj]ubahkjubaubhX)r]}r](hgUhhj]ubhX -- r]r]}r](hgUhhj]ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r]r]}r](hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj]ubj)r]}r](hgX:term:`public user`r]hhj]hijUhkjhm}r](UreftypeXtermjjX public userU refdomainXstdr]hr]hq]U refexplicitho]hp]ht]jjuhvKShb]r]j`2)r]}r](hgj]hm}r](ho]hp]r](jj]Xstd-termr]ehq]hr]ht]uhhj]hb]r]hX public userr]r]}r](hgUhhj]ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r]r]}r](hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj]ubehkhubahkj;#ubj#)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r]h)r]}r](hgXid (Types.Identifier) -- Identifier of the object to be retrieved. May be either a PID or a SID, the latter acting as if called using the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r](ho]hp]hq]hr]ht]uhhj]hb]r](j")r]}r](hgXidhm}r](hr]hq]j"ho]hp]ht]uhhj]hb]r]hXidr]r]}r](hgUhhj]ubahkj"ubhX (r]r]}r](hgUhhj]ubj)r]}r](hgX:class:`Types.Identifier`r]hhj]hijUhkjhm}r](UreftypeXclassjjXTypes.IdentifierU refdomainXpyr]hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKWhb]r]j)r]}r](hgj]hm}r](ho]hp]r](jj]Xpy-classr]ehq]hr]ht]uhhj]hb]r]hXTypes.Identifierr]r]}r](hgUhhj]ubahkjubaubhX)r]}r](hgUhhj]ubhX -- r]r]}r](hgUhhj]ubhXIdentifier of the object to be retrieved. May be either a PID or a SID, the latter acting as if called using the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r]r]}r](hgXIdentifier of the object to be retrieved. May be either a PID or a SID, the latter acting as if called using the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhj]ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r]}r](hgUhm}r](ho]hp]hq]hr]ht]uhhj]hb]r](h)r]}r](hgXReturnshhj]hijUhkhhm}r](ho]hp]hq]hr]ht]uhvKhb]r]hXReturnsr^r^}r^(hgUhhj]ubaubh)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj]hb]r^h)r^}r^(hgXFor science metadata objects, this will be the exact byte stream of the science metadata object as it was original ingested. Note that additional object types may in the future be returned by the get method.hm}r ^(ho]hp]hq]hr]ht]uhhj^hb]r ^hXFor science metadata objects, this will be the exact byte stream of the science metadata object as it was original ingested. Note that additional object types may in the future be returned by the get method.r ^r ^}r ^(hgXFor science metadata objects, this will be the exact byte stream of the science metadata object as it was original ingested. Note that additional object types may in the future be returned by the get method.hhj^ubahkhubahkhubehkhubh)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj]hb]r^(h)r^}r^(hgX Return typehhj^hijUhkhhm}r^(ho]hp]hq]hr]ht]uhvKhb]r^hX Return typer^r^}r^(hgUhhj^ubaubh)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^h)r^}r^(hgXTypes.OctetStreamhm}r^(ho]hp]hq]hr]ht]uhhj^hb]r ^j)r!^}r"^(hgX:class:`Types.OctetStream`r#^hhj^hijUhkjhm}r$^(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr%^hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKZhb]r&^j)r'^}r(^(hgj#^hm}r)^(ho]hp]r*^(jj%^Xpy-classr+^ehq]hr]ht]uhhj!^hb]r,^hXTypes.OctetStreamr-^r.^}r/^(hgUhhj'^ubahkjubaubahkhubahkhubehkhubh)r0^}r1^(hgUhm}r2^(ho]hp]hq]hr]ht]uhhj]hb]r3^(h)r4^}r5^(hgXRaiseshhj0^hijUhkhhm}r6^(ho]hp]hq]hr]ht]uhvKhb]r7^hXRaisesr8^r9^}r:^(hgUhhj4^ubaubh)r;^}r<^(hgUhm}r=^(ho]hp]hq]hr]ht]uhhj0^hb]r>^j #)r?^}r@^(hgUhm}rA^(ho]hp]hq]hr]ht]uhhj;^hb]rB^(j#)rC^}rD^(hgUhm}rE^(ho]hp]hq]hr]ht]uhhj?^hb]rF^h)rG^}rH^(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1000)hm}rI^(ho]hp]hq]hr]ht]uhhjC^hb]rJ^(j)rK^}rL^(hgUhm}rM^(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrN^U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjG^hb]rO^j")rP^}rQ^(hgjN^hm}rR^(ho]hp]hq]hr]ht]uhhjK^hb]rS^hXExceptions.NotAuthorizedrT^rU^}rV^(hgUhhjP^ubahkj"ubahkjubhX -- rW^rX^}rY^(hgUhhjG^ubj)rZ^}r[^(hgX$``(errorCode=401, detailCode=1000)``hm}r\^(ho]hp]hq]hr]ht]uhhjG^hb]r]^hX (errorCode=401, detailCode=1000)r^^r_^}r`^(hgUhhjZ^ubahkjubehkhubahkj;#ubj#)ra^}rb^(hgUhm}rc^(ho]hp]hq]hr]ht]uhhj?^hb]rd^h)re^}rf^(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1001)hm}rg^(ho]hp]hq]hr]ht]uhhja^hb]rh^(j)ri^}rj^(hgUhm}rk^(Ureftypej#j"U reftargetXExceptions.NotImplementedrl^U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhje^hb]rm^j")rn^}ro^(hgjl^hm}rp^(ho]hp]hq]hr]ht]uhhji^hb]rq^hXExceptions.NotImplementedrr^rs^}rt^(hgUhhjn^ubahkj"ubahkjubhX -- ru^rv^}rw^(hgUhhje^ubj)rx^}ry^(hgX$``(errorCode=501, detailCode=1001)``hm}rz^(ho]hp]hq]hr]ht]uhhje^hb]r{^hX (errorCode=501, detailCode=1001)r|^r}^}r~^(hgUhhjx^ubahkjubehkhubahkj;#ubj#)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj?^hb]r^h)r^}r^(hgXExceptions.NotFound -- (errorCode=404, detailCode=1020)The object specified by the identifier is not present on this (or any) CN. The response body should contain a reference to CNRead.resolve().hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^(j)r^}r^(hgUhm}r^(Ureftypej#j"U reftargetXExceptions.NotFoundr^U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhj^hb]r^j")r^}r^(hgj^hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hXExceptions.NotFoundr^r^}r^(hgUhhj^ubahkj"ubahkjubhX -- r^r^}r^(hgUhhj^ubh)r^}r^(hgX$``(errorCode=404, detailCode=1020)``r^hhj^hijUhkhhm}r^(ho]hp]hq]hr]ht]uhvK`hb]r^j)r^}r^(hgj^hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hX (errorCode=404, detailCode=1020)r^r^}r^(hgUhhj^ubahkjubaubh)r^}r^(hgXThe object specified by the identifier is not present on this (or any) CN. The response body should contain a reference to :func:`CNRead.resolve`.hhj^hijUhkhhm}r^(ho]hp]hq]hr]ht]uhvKbhb]r^(hX{The object specified by the identifier is not present on this (or any) CN. The response body should contain a reference to r^r^}r^(hgX{The object specified by the identifier is not present on this (or any) CN. The response body should contain a reference to hhj^ubj)r^}r^(hgX:func:`CNRead.resolve`r^hhj^hijUhkjhm}r^(UreftypeXfuncjjXCNRead.resolveU refdomainXpyr^hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKbhb]r^j)r^}r^(hgj^hm}r^(ho]hp]r^(jj^Xpy-funcr^ehq]hr]ht]uhhj^hb]r^hXCNRead.resolve()r^r^}r^(hgUhhj^ubahkjubaubhX.r^}r^(hgX.hhj^ubeubehkhubahkj;#ubj#)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj?^hb]r^h)r^}r^(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1030)hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^(j)r^}r^(hgUhm}r^(Ureftypej#j"U reftargetXExceptions.ServiceFailurer^U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhj^hb]r^j")r^}r^(hgj^hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hXExceptions.ServiceFailurer^r^}r^(hgUhhj^ubahkj"ubahkjubhX -- r^r^}r^(hgUhhj^ubj)r^}r^(hgX$``(errorCode=500, detailCode=1030)``hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hX (errorCode=500, detailCode=1030)r^r^}r^(hgUhhj^ubahkjubehkhubahkj;#ubj#)r^}r^(hgUhm}r^(ho]hp]hq]hr]ht]uhhj?^hb]r^h)r^}r^(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1010)hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^(j)r^}r^(hgUhm}r^(Ureftypej#j"U reftargetXExceptions.InvalidTokenr^U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhj^hb]r^j")r^}r^(hgj^hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hXExceptions.InvalidTokenr^r^}r^(hgUhhj^ubahkj"ubahkjubhX -- r^r^}r^(hgUhhj^ubj)r^}r^(hgX$``(errorCode=401, detailCode=1010)``hm}r^(ho]hp]hq]hr]ht]uhhj^hb]r^hX (errorCode=401, detailCode=1010)r^r^}r^(hgUhhj^ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubh)r^}r^(hgX **Example**r^hhjUhijXsource/apis/examples/cn_get.txtr^r^}r^bhkhhm}r^(ho]hp]hq]hr]ht]uhvKhwhhb]r^jG3)r^}r^(hgj^hm}r_(ho]hp]hq]hr]ht]uhhj^hb]r_hXExampler_r_}r_(hgUhhj^ubahkjO3ubaubh)r_}r_(hgX;See :func:`MNRead.get` for additional details and examples.r_hhjUhij^hkhhm}r_(ho]hp]hq]hr]ht]uhvKhwhhb]r _(hXSee r _r _}r _(hgXSee hhj_ubj)r _}r_(hgX:func:`MNRead.get`r_hhj_hij^hkjhm}r_(UreftypeXfuncjjX MNRead.getU refdomainXpyr_hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r_j)r_}r_(hgj_hm}r_(ho]hp]r_(jj_Xpy-funcr_ehq]hr]ht]uhhj _hb]r_hX MNRead.get()r_r_}r_(hgUhhj_ubahkjubaubhX% for additional details and examples.r_r_}r_(hgX% for additional details and examples.hhj_ubeubj)r_}r _(hgUhhjUhiNhkjhm}r!_(hr]hq]ho]hp]ht]Uentries]r"_(jX&getSystemMetadata() (in module CNRead)h UNtr#_auhvNhwhhb]ubj!)r$_}r%_(hgUhhjUhiNhkj!hm}r&_(j"j"Xpyr'_hr]hq]ho]hp]ht]j"Xfunctionr(_j"j(_uhvNhwhhb]r)_(j")r*_}r+_(hgX/getSystemMetadata(session,id) -> SystemMetadatahhj$_hijUhkj "hm}r,_(hr]r-_h aj"jUhq]ho]hp]ht]r._h aj"XgetSystemMetadatar/_j"Uj"uhvKhwhhb]r0_(j")r1_}r2_(hgXCNRead.hhj*_hijUhkj"hm}r3_(ho]hp]hq]hr]ht]uhvKhwhhb]r4_hXCNRead.r5_r6_}r7_(hgUhhj1_ubaubj")r8_}r9_(hgj/_hhj*_hijUhkj!"hm}r:_(ho]hp]hq]hr]ht]uhvKhwhhb]r;_hXgetSystemMetadatar<_r=_}r>_(hgUhhj8_ubaubj'")r?_}r@_(hgX session, idhhj*_hijUhkj*"hm}rA_(ho]hp]hq]hr]ht]uhvKhwhhb]rB_(j-")rC_}rD_(hgXsessionhm}rE_(ho]hp]hq]hr]ht]uhhj?_hb]rF_hXsessionrG_rH_}rI_(hgUhhjC_ubahkj5"ubj-")rJ_}rK_(hgXidhm}rL_(ho]hp]hq]hr]ht]uhhj?_hb]rM_hXidrN_rO_}rP_(hgUhhjJ_ubahkj5"ubeubj6")rQ_}rR_(hgXSystemMetadatahhj*_hijUhkj9"hm}rS_(ho]hp]hq]hr]ht]uhvKhwhhb]rT_hXSystemMetadatarU_rV_}rW_(hgUhhjQ_ubaubeubj?")rX_}rY_(hgUhhj$_hijUhkjB"hm}rZ_(ho]hp]hq]hr]ht]uhvKhwhhb]r[_(h)r\_}r]_(hgXReturns the :term:`system metadata` that contains DataONE specific information about the object identified by *id*. Authoritative copies of system metadata are only available from the Coordinating Nodes.hhjX_hijUhkhhm}r^_(ho]hp]hq]hr]ht]uhvKphwhhb]r__(hX Returns the r`_ra_}rb_(hgX Returns the hhj\_ubj)rc_}rd_(hgX:term:`system metadata`re_hhj\_hijUhkjhm}rf_(UreftypeXtermjjXsystem metadataU refdomainXstdrg_hr]hq]U refexplicitho]hp]ht]jjuhvKphb]rh_j`2)ri_}rj_(hgje_hm}rk_(ho]hp]rl_(jjg_Xstd-termrm_ehq]hr]ht]uhhjc_hb]rn_hXsystem metadataro_rp_}rq_(hgUhhji_ubahkji2ubaubhXK that contains DataONE specific information about the object identified by rr_rs_}rt_(hgXK that contains DataONE specific information about the object identified by hhj\_ubj$)ru_}rv_(hgX*id*hm}rw_(ho]hp]hq]hr]ht]uhhj\_hb]rx_hXidry_rz_}r{_(hgUhhju_ubahkj$ubhXY. Authoritative copies of system metadata are only available from the Coordinating Nodes.r|_r}_}r~_(hgXY. Authoritative copies of system metadata are only available from the Coordinating Nodes.hhj\_ubeubh)r_}r_(hgXv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID` and the returned :class:`v2_0.Types.SystemMetadata` structure has changed.hhjX_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKrhwhhb]r_(hX'v2.0: The supplied identifier may be a r_r_}r_(hgX'v2.0: The supplied identifier may be a hhj_ubj)r_}r_(hgX :term:`PID`r_hhj_hijUhkjhm}r_(UreftypeXtermjjXpidU refdomainXstdr_hr]hq]U refexplicitho]hp]ht]jjuhvKrhb]r_j`2)r_}r_(hgj_hm}r_(ho]hp]r_(jj_Xstd-termr_ehq]hr]ht]uhhj_hb]r_hXPIDr_r_}r_(hgUhhj_ubahkji2ubaubhX or a r_r_}r_(hgX or a hhj_ubj)r_}r_(hgX :term:`SID`r_hhj_hijUhkjhm}r_(UreftypeXtermjjXsidU refdomainXstdr_hr]hq]U refexplicitho]hp]ht]jjuhvKrhb]r_j`2)r_}r_(hgj_hm}r_(ho]hp]r_(jj_Xstd-termr_ehq]hr]ht]uhhj_hb]r_hXSIDr_r_}r_(hgUhhj_ubahkji2ubaubhX and the returned r_r_}r_(hgX and the returned hhj_ubj)r_}r_(hgX":class:`v2_0.Types.SystemMetadata`r_hhj_hijUhkjhm}r_(UreftypeXclassjjXv2_0.Types.SystemMetadataU refdomainXpyr_hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKrhb]r_j)r_}r_(hgj_hm}r_(ho]hp]r_(jj_Xpy-classr_ehq]hr]ht]uhhj_hb]r_hXv2_0.Types.SystemMetadatar_r_}r_(hgUhhj_ubahkjubaubhX structure has changed.r_r_}r_(hgX structure has changed.hhj_ubeubh)r_}r_(hgUhhjX_hiNhkhhm}r_(ho]hp]hq]hr]ht]uhvNhwhhb]r_(h)r_}r_(hgUhhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKthwhhb]r_(h)r_}r_(hgXVersionhhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r_hXVersionr_r_}r_(hgUhhj_ubaubh)r_}r_(hgX1.0, 2.0r_hm}r_(ho]hp]hq]hr]ht]uhhj_hb]r_h)r_}r_(hgj_hhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKthb]r_hX1.0, 2.0r_r_}r_(hgj_hhj_ubaubahkhubeubh)r_}r_(hgUhhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKuhwhhb]r_(h)r_}r_(hgX Use Caseshhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r_hX Use Casesr_r_}r_(hgUhhj_ubaubh)r_}r_(hgXp:doc:`UC36 `, :doc:`UC37 `, :doc:`UC16 `r_hm}r_(ho]hp]hq]hr]ht]uhhj_hb]r_h)r_}r_(hgj_hhj_hijUhkhhm}r_(ho]hp]hq]hr]ht]uhvKvhb]r_(j)r_}r_(hgX$:doc:`UC36 `r_hhj_hijUhkjhm}r_(UreftypeXdocr_jjX/design/UseCases/36_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKvhb]r_j`2)r_}r_(hgj_hm}r_(ho]hp]r_(jj_ehq]hr]ht]uhhj_hb]r_hXUC36r_r_}r_(hgUhhj_ubahkji2ubaubhX, r_r_}r_(hgX, hhj_ubj)r_}r_(hgX$:doc:`UC37 `r_hhj_hijUhkjhm}r_(UreftypeXdocr`jjX/design/UseCases/37_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKvhb]r`j`2)r`}r`(hgj_hm}r`(ho]hp]r`(jj`ehq]hr]ht]uhhj_hb]r`hXUC37r`r`}r `(hgUhhj`ubahkji2ubaubhX, r `r `}r `(hgX, hhj_ubj)r `}r`(hgX$:doc:`UC16 `r`hhj_hijUhkjhm}r`(UreftypeXdocr`jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKvhb]r`j`2)r`}r`(hgj`hm}r`(ho]hp]r`(jj`ehq]hr]ht]uhhj `hb]r`hXUC16r`r`}r`(hgUhhj`ubahkji2ubaubeubahkhubeubh)r`}r`(hgUhhj_hijUhkhhm}r`(ho]hp]hq]hr]ht]uhvKwhwhhb]r`(h)r`}r `(hgXREST URLhhj`hijUhkhhm}r!`(ho]hp]hq]hr]ht]uhvKhb]r"`hXREST URLr#`r$`}r%`(hgUhhj`ubaubh)r&`}r'`(hgX``GET /meta/{id}``r(`hm}r)`(ho]hp]hq]hr]ht]uhhj`hb]r*`h)r+`}r,`(hgj(`hhj&`hijUhkhhm}r-`(ho]hp]hq]hr]ht]uhvKwhb]r.`j)r/`}r0`(hgj(`hm}r1`(ho]hp]hq]hr]ht]uhhj+`hb]r2`hXGET /meta/{id}r3`r4`}r5`(hgUhhj/`ubahkjubaubahkhubeubh)r6`}r7`(hgUhm}r8`(ho]hp]hq]hr]ht]uhhj_hb]r9`(h)r:`}r;`(hgX Parametershhj6`hijUhkhhm}r<`(ho]hp]hq]hr]ht]uhvKhb]r=`hX Parametersr>`r?`}r@`(hgUhhj:`ubaubh)rA`}rB`(hgUhm}rC`(ho]hp]hq]hr]ht]uhhj6`hb]rD`j #)rE`}rF`(hgUhm}rG`(ho]hp]hq]hr]ht]uhhjA`hb]rH`(j#)rI`}rJ`(hgUhm}rK`(ho]hp]hq]hr]ht]uhhjE`hb]rL`h)rM`}rN`(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rO`(ho]hp]hq]hr]ht]uhhjI`hb]rP`(j")rQ`}rR`(hgXsessionhm}rS`(hr]hq]j"ho]hp]ht]uhhjM`hb]rT`hXsessionrU`rV`}rW`(hgUhhjQ`ubahkj"ubhX (rX`rY`}rZ`(hgUhhjM`ubj)r[`}r\`(hgX:class:`Types.Session`r]`hhjM`hijUhkjhm}r^`(UreftypeXclassjjX Types.SessionU refdomainXpyr_`hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKyhb]r``j)ra`}rb`(hgj]`hm}rc`(ho]hp]rd`(jj_`Xpy-classre`ehq]hr]ht]uhhj[`hb]rf`hX Types.Sessionrg`rh`}ri`(hgUhhja`ubahkjubaubhX)rj`}rk`(hgUhhjM`ubhX -- rl`rm`}rn`(hgUhhjM`ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the ro`rp`}rq`(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjM`ubj)rr`}rs`(hgX:term:`public user`rt`hhjM`hijUhkjhm}ru`(UreftypeXtermjjX public userU refdomainXstdrv`hr]hq]U refexplicitho]hp]ht]jjuhvKxhb]rw`j`2)rx`}ry`(hgjt`hm}rz`(ho]hp]r{`(jjv`Xstd-termr|`ehq]hr]ht]uhhjr`hb]r}`hX public userr~`r`}r`(hgUhhjx`ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r`r`}r`(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjM`ubehkhubahkj;#ubj#)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhjE`hb]r`h)r`}r`(hgXid (Types.Identifier) -- Identifier for the object of interest. May be either a PID or a SID, the latter acts as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`(j")r`}r`(hgXidhm}r`(hr]hq]j"ho]hp]ht]uhhj`hb]r`hXidr`r`}r`(hgUhhj`ubahkj"ubhX (r`r`}r`(hgUhhj`ubj)r`}r`(hgX:class:`Types.Identifier`r`hhj`hijUhkjhm}r`(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr`hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvK|hb]r`j)r`}r`(hgj`hm}r`(ho]hp]r`(jj`Xpy-classr`ehq]hr]ht]uhhj`hb]r`hXTypes.Identifierr`r`}r`(hgUhhj`ubahkjubaubhX)r`}r`(hgUhhj`ubhX -- r`r`}r`(hgUhhj`ubhXIdentifier for the object of interest. May be either a PID or a SID, the latter acts as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r`r`}r`(hgXIdentifier for the object of interest. May be either a PID or a SID, the latter acts as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhj`ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj_hb]r`(h)r`}r`(hgXReturnshhj`hijUhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]r`hXReturnsr`r`}r`(hgUhhj`ubaubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`h)r`}r`(hgX1A system metadata document describing the object.hm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`hX1A system metadata document describing the object.r`r`}r`(hgX1A system metadata document describing the object.hhj`ubahkhubahkhubehkhubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj_hb]r`(h)r`}r`(hgX Return typehhj`hijUhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]r`hX Return typer`r`}r`(hgUhhj`ubaubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`h)r`}r`(hgXTypes.SystemMetadatahm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`j)r`}r`(hgX:class:`Types.SystemMetadata`r`hhj`hijUhkjhm}r`(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr`hr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r`j)r`}r`(hgj`hm}r`(ho]hp]r`(jj`Xpy-classr`ehq]hr]ht]uhhj`hb]r`hXTypes.SystemMetadatar`r`}r`(hgUhhj`ubahkjubaubahkhubahkhubehkhubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj_hb]r`(h)r`}r`(hgXRaiseshhj`hijUhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]r`hXRaisesr`r`}r`(hgUhhj`ubaubh)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`j #)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`(j#)r`}r`(hgUhm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`h)r`}r`(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1050)hm}r`(ho]hp]hq]hr]ht]uhhj`hb]r`(j)ra}ra(hgUhm}ra(Ureftypej#j"U reftargetXExceptions.InvalidTokenraU refdomainj'_hr]hq]U refexplicitho]hp]ht]uhhj`hb]raj")ra}ra(hgjahm}ra(ho]hp]hq]hr]ht]uhhjahb]rahXExceptions.InvalidTokenr ar a}r a(hgUhhjaubahkj"ubahkjubhX -- r ar a}ra(hgUhhj`ubj)ra}ra(hgX$``(errorCode=401, detailCode=1050)``hm}ra(ho]hp]hq]hr]ht]uhhj`hb]rahX (errorCode=401, detailCode=1050)rara}ra(hgUhhjaubahkjubehkhubahkj;#ubj#)ra}ra(hgUhm}ra(ho]hp]hq]hr]ht]uhhj`hb]rah)ra}ra(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1041)hm}ra(ho]hp]hq]hr]ht]uhhjahb]ra(j)ra}ra(hgUhm}r a(Ureftypej#j"U reftargetXExceptions.NotImplementedr!aU refdomainj'_hr]hq]U refexplicitho]hp]ht]uhhjahb]r"aj")r#a}r$a(hgj!ahm}r%a(ho]hp]hq]hr]ht]uhhjahb]r&ahXExceptions.NotImplementedr'ar(a}r)a(hgUhhj#aubahkj"ubahkjubhX -- r*ar+a}r,a(hgUhhjaubj)r-a}r.a(hgX$``(errorCode=501, detailCode=1041)``hm}r/a(ho]hp]hq]hr]ht]uhhjahb]r0ahX (errorCode=501, detailCode=1041)r1ar2a}r3a(hgUhhj-aubahkjubehkhubahkj;#ubj#)r4a}r5a(hgUhm}r6a(ho]hp]hq]hr]ht]uhhj`hb]r7ah)r8a}r9a(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1090)hm}r:a(ho]hp]hq]hr]ht]uhhj4ahb]r;a(j)ra(Ureftypej#j"U reftargetXExceptions.ServiceFailurer?aU refdomainj'_hr]hq]U refexplicitho]hp]ht]uhhj8ahb]r@aj")rAa}rBa(hgj?ahm}rCa(ho]hp]hq]hr]ht]uhhj DescribeResponsehhjahijUhkj "hm}ra(hr]rahaj"jUhq]ho]hp]ht]rahaj"Xdescriberaj"Uj"uhvKhwhhb]ra(j")ra}ra(hgXCNRead.hhjahijUhkj"hm}ra(ho]hp]hq]hr]ht]uhvKhwhhb]rahXCNRead.rara}ra(hgUhhjaubaubj")ra}ra(hgjahhjahijUhkj!"hm}ra(ho]hp]hq]hr]ht]uhvKhwhhb]rahXdescriberara}ra(hgUhhjaubaubj'")ra}ra(hgX session, idhhjahijUhkj*"hm}ra(ho]hp]hq]hr]ht]uhvKhwhhb]ra(j-")ra}ra(hgXsessionhm}rb(ho]hp]hq]hr]ht]uhhjahb]rbhXsessionrbrb}rb(hgUhhjaubahkj5"ubj-")rb}rb(hgXidhm}rb(ho]hp]hq]hr]ht]uhhjahb]rbhXidr br b}r b(hgUhhjbubahkj5"ubeubj6")r b}r b(hgXDescribeResponsehhjahijUhkj9"hm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rbhXDescribeResponserbrb}rb(hgUhhj bubaubeubj?")rb}rb(hgUhhjahijUhkjB"hm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(h)rb}rb(hgXdThis method provides a lighter weight mechanism than :func:`CNRead.getSystemMetadata` for a client to determine basic properties of the referenced object. The response should indicate properties that are typically returned in a HTTP HEAD request: the date late modified, the size of the object, the type of the object (the :attr:`SystemMetadata.formatId`).hhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(hX5This method provides a lighter weight mechanism than rbrb}rb(hgX5This method provides a lighter weight mechanism than hhjbubj)rb}rb(hgX :func:`CNRead.getSystemMetadata`r bhhjbhijUhkjhm}r!b(UreftypeXfuncjjXCNRead.getSystemMetadataU refdomainXpyr"bhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r#bj)r$b}r%b(hgj bhm}r&b(ho]hp]r'b(jj"bXpy-funcr(behq]hr]ht]uhhjbhb]r)bhXCNRead.getSystemMetadata()r*br+b}r,b(hgUhhj$bubahkjubaubhX for a client to determine basic properties of the referenced object. The response should indicate properties that are typically returned in a HTTP HEAD request: the date late modified, the size of the object, the type of the object (the r-br.b}r/b(hgX for a client to determine basic properties of the referenced object. The response should indicate properties that are typically returned in a HTTP HEAD request: the date late modified, the size of the object, the type of the object (the hhjbubj)r0b}r1b(hgX:attr:`SystemMetadata.formatId`r2bhhjbhijUhkjhm}r3b(UreftypeXattrjjXSystemMetadata.formatIdU refdomainXpyr4bhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r5bj)r6b}r7b(hgj2bhm}r8b(ho]hp]r9b(jj4bXpy-attrr:behq]hr]ht]uhhj0bhb]r;bhXSystemMetadata.formatIdrb(hgUhhj6bubahkjubaubhX).r?br@b}rAb(hgX).hhjbubeubh)rBb}rCb(hgXThe principal indicated by *token* must have read privileges on the object, otherwise :exc:`Exceptions.NotAuthorized` is raised.hhjbhijUhkhhm}rDb(ho]hp]hq]hr]ht]uhvKhwhhb]rEb(hXThe principal indicated by rFbrGb}rHb(hgXThe principal indicated by hhjBbubj$)rIb}rJb(hgX*token*hm}rKb(ho]hp]hq]hr]ht]uhhjBbhb]rLbhXtokenrMbrNb}rOb(hgUhhjIbubahkj$ubhX4 must have read privileges on the object, otherwise rPbrQb}rRb(hgX4 must have read privileges on the object, otherwise hhjBbubj)rSb}rTb(hgX:exc:`Exceptions.NotAuthorized`rUbhhjBbhijUhkjhm}rVb(UreftypeXexcjjXExceptions.NotAuthorizedU refdomainXpyrWbhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rXbj)rYb}rZb(hgjUbhm}r[b(ho]hp]r\b(jjWbXpy-excr]behq]hr]ht]uhhjSbhb]r^bhXExceptions.NotAuthorizedr_br`b}rab(hgUhhjYbubahkjubaubhX is raised.rbbrcb}rdb(hgX is raised.hhjBbubeubh)reb}rfb(hgXIf the object does not exist on the node servicing the request, then :exc:`Exceptions.NotFound` must be raised even if the object exists on another node in the DataONE system.hhjbhijUhkhhm}rgb(ho]hp]hq]hr]ht]uhvKhwhhb]rhb(hXEIf the object does not exist on the node servicing the request, then ribrjb}rkb(hgXEIf the object does not exist on the node servicing the request, then hhjebubj)rlb}rmb(hgX:exc:`Exceptions.NotFound`rnbhhjebhijUhkjhm}rob(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyrpbhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rqbj)rrb}rsb(hgjnbhm}rtb(ho]hp]rub(jjpbXpy-excrvbehq]hr]ht]uhhjlbhb]rwbhXExceptions.NotFoundrxbryb}rzb(hgUhhjrbubahkjubaubhXP must be raised even if the object exists on another node in the DataONE system.r{br|b}r}b(hgXP must be raised even if the object exists on another node in the DataONE system.hhjebubeubh)r~b}rb(hgXNote that this method is likely to be called frequently and so efficiency should be taken into consideration during implementation.rbhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rbhXNote that this method is likely to be called frequently and so efficiency should be taken into consideration during implementation.rbrb}rb(hgjbhhj~bubaubh)rb}rb(hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(hX'v2.0: The supplied identifier may be a rbrb}rb(hgX'v2.0: The supplied identifier may be a hhjbubj)rb}rb(hgX :term:`PID`rbhhjbhijUhkjhm}rb(UreftypeXtermjjXpidU refdomainXstdrbhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rbj`2)rb}rb(hgjbhm}rb(ho]hp]rb(jjbXstd-termrbehq]hr]ht]uhhjbhb]rbhXPIDrbrb}rb(hgUhhjbubahkji2ubaubhX or a rbrb}rb(hgX or a hhjbubj)rb}rb(hgX :term:`SID`rbhhjbhijUhkjhm}rb(UreftypeXtermjjXsidU refdomainXstdrbhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rbj`2)rb}rb(hgjbhm}rb(ho]hp]rb(jjbXstd-termrbehq]hr]ht]uhhjbhb]rbhXSIDrbrb}rb(hgUhhjbubahkji2ubaubhX.rb}rb(hgX.hhjbubeubh)rb}rb(hgUhhjbhiNhkhhm}rb(ho]hp]hq]hr]ht]uhvNhwhhb]rb(h)rb}rb(hgUhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(h)rb}rb(hgXVersionhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbhXVersionrbrb}rb(hgUhhjbubaubh)rb}rb(hgX1.0, 2.0rbhm}rb(ho]hp]hq]hr]ht]uhhjbhb]rbh)rb}rb(hgjbhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbhX1.0, 2.0rbrb}rb(hgjbhhjbubaubahkhubeubh)rb}rb(hgUhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(h)rb}rb(hgX Use CaseshhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbhX Use Casesrbrb}rb(hgUhhjbubaubh)rb}rb(hgX$:doc:`UC16 `rbhm}rb(ho]hp]hq]hr]ht]uhhjbhb]rbh)rb}rb(hgjbhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbj)rb}rb(hgjbhhjbhijUhkjhm}rb(UreftypeXdocrbjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rbj`2)rb}rb(hgjbhm}rb(ho]hp]rb(jjbehq]hr]ht]uhhjbhb]rbhXUC16rbrb}rb(hgUhhjbubahkji2ubaubaubahkhubeubh)rb}rb(hgUhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhwhhb]rb(h)rb}rb(hgXREST URLhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbhXREST URLrbrb}rb(hgUhhjbubaubh)rb}rb(hgX``HEAD /object/{id}``rbhm}rb(ho]hp]hq]hr]ht]uhhjbhb]rbh)rb}rb(hgjbhhjbhijUhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rbj)rc}rc(hgjbhm}rc(ho]hp]hq]hr]ht]uhhjbhb]rchXHEAD /object/{id}rcrc}rc(hgUhhjcubahkjubaubahkhubeubh)rc}rc(hgUhm}r c(ho]hp]hq]hr]ht]uhhjbhb]r c(h)r c}r c(hgX ParametershhjchijUhkhhm}r c(ho]hp]hq]hr]ht]uhvKhb]rchX Parametersrcrc}rc(hgUhhj cubaubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rcj #)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rc(j#)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rch)rc}rc(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r c(ho]hp]hq]hr]ht]uhhjchb]r!c(j")r"c}r#c(hgXsessionhm}r$c(hr]hq]j"ho]hp]ht]uhhjchb]r%chXsessionr&cr'c}r(c(hgUhhj"cubahkj"ubhX (r)cr*c}r+c(hgUhhjcubj)r,c}r-c(hgX:class:`Types.Session`r.chhjchijUhkjhm}r/c(UreftypeXclassjjX Types.SessionU refdomainXpyr0chr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]r1cj)r2c}r3c(hgj.chm}r4c(ho]hp]r5c(jj0cXpy-classr6cehq]hr]ht]uhhj,chb]r7chX Types.Sessionr8cr9c}r:c(hgUhhj2cubahkjubaubhX)r;c}rc}r?c(hgUhhjcubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r@crAc}rBc(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjcubj)rCc}rDc(hgX:term:`public user`rEchhjchijUhkjhm}rFc(UreftypeXtermjjX public userU refdomainXstdrGchr]hq]U refexplicitho]hp]ht]jjuhvKhb]rHcj`2)rIc}rJc(hgjEchm}rKc(ho]hp]rLc(jjGcXstd-termrMcehq]hr]ht]uhhjCchb]rNchX public userrOcrPc}rQc(hgUhhjIcubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rRcrSc}rTc(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjcubehkhubahkj;#ubj#)rUc}rVc(hgUhm}rWc(ho]hp]hq]hr]ht]uhhjchb]rXch)rYc}rZc(hgXid (Types.Identifier) -- Identifier for the object in question. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r[c(ho]hp]hq]hr]ht]uhhjUchb]r\c(j")r]c}r^c(hgXidhm}r_c(hr]hq]j"ho]hp]ht]uhhjYchb]r`chXidracrbc}rcc(hgUhhj]cubahkj"ubhX (rdcrec}rfc(hgUhhjYcubj)rgc}rhc(hgX:class:`Types.Identifier`richhjYchijUhkjhm}rjc(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrkchr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rlcj)rmc}rnc(hgjichm}roc(ho]hp]rpc(jjkcXpy-classrqcehq]hr]ht]uhhjgchb]rrchXTypes.Identifierrscrtc}ruc(hgUhhjmcubahkjubaubhX)rvc}rwc(hgUhhjYcubhX -- rxcryc}rzc(hgUhhjYcubhXIdentifier for the object in question. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r{cr|c}r}c(hgXIdentifier for the object in question. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjYcubehkhubahkj;#ubehkj#ubahkhubehkhubh)r~c}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjbhb]rc(h)rc}rc(hgXReturnshhj~chijUhkhhm}rc(ho]hp]hq]hr]ht]uhvKhb]rchXReturnsrcrc}rc(hgUhhjcubaubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhj~chb]rch)rc}rc(hgX<A set of values providing a basic description of the object.hm}rc(ho]hp]hq]hr]ht]uhhjchb]rchX<A set of values providing a basic description of the object.rcrc}rc(hgX<A set of values providing a basic description of the object.hhjcubahkhubahkhubehkhubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjbhb]rc(h)rc}rc(hgX Return typehhjchijUhkhhm}rc(ho]hp]hq]hr]ht]uhvKhb]rchX Return typercrc}rc(hgUhhjcubaubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rch)rc}rc(hgXTypes.DescribeResponsehm}rc(ho]hp]hq]hr]ht]uhhjchb]rcj)rc}rc(hgX:class:`Types.DescribeResponse`rchhjchijUhkjhm}rc(UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyrchr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rcj)rc}rc(hgjchm}rc(ho]hp]rc(jjcXpy-classrcehq]hr]ht]uhhjchb]rchXTypes.DescribeResponsercrc}rc(hgUhhjcubahkjubaubahkhubahkhubehkhubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjbhb]rc(h)rc}rc(hgXRaiseshhjchijUhkhhm}rc(ho]hp]hq]hr]ht]uhvKhb]rchXRaisesrcrc}rc(hgUhhjcubaubh)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rcj #)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rc(j#)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rch)rc}rc(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4930)hm}rc(ho]hp]hq]hr]ht]uhhjchb]rc(j)rc}rc(hgUhm}rc(Ureftypej#j"U reftargetXExceptions.NotImplementedrcU refdomainjahr]hq]U refexplicitho]hp]ht]uhhjchb]rcj")rc}rc(hgjchm}rc(ho]hp]hq]hr]ht]uhhjchb]rchXExceptions.NotImplementedrcrc}rc(hgUhhjcubahkj"ubahkjubhX -- rcrc}rc(hgUhhjcubj)rc}rc(hgX$``(errorCode=501, detailCode=4930)``hm}rc(ho]hp]hq]hr]ht]uhhjchb]rchX (errorCode=501, detailCode=4930)rcrc}rc(hgUhhjcubahkjubehkhubahkj;#ubj#)rc}rc(hgUhm}rc(ho]hp]hq]hr]ht]uhhjchb]rch)rc}rc(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4931)hm}rc(ho]hp]hq]hr]ht]uhhjchb]rc(j)rc}rc(hgUhm}rc(Ureftypej#j"U reftargetXExceptions.ServiceFailurercU refdomainjahr]hq]U refexplicitho]hp]ht]uhhjchb]rcj")rc}rc(hgjchm}rc(ho]hp]hq]hr]ht]uhhjchb]rchXExceptions.ServiceFailurercrc}rc(hgUhhjcubahkj"ubahkjubhX -- rcrc}rc(hgUhhjcubj)rc}rc(hgX$``(errorCode=500, detailCode=4931)``hm}rd(ho]hp]hq]hr]ht]uhhjchb]rdhX (errorCode=500, detailCode=4931)rdrd}rd(hgUhhjcubahkjubehkhubahkj;#ubj#)rd}rd(hgUhm}rd(ho]hp]hq]hr]ht]uhhjchb]rdh)r d}r d(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4932)hm}r d(ho]hp]hq]hr]ht]uhhjdhb]r d(j)r d}rd(hgUhm}rd(Ureftypej#j"U reftargetXExceptions.InvalidTokenrdU refdomainjahr]hq]U refexplicitho]hp]ht]uhhj dhb]rdj")rd}rd(hgjdhm}rd(ho]hp]hq]hr]ht]uhhj dhb]rdhXExceptions.InvalidTokenrdrd}rd(hgUhhjdubahkj"ubahkjubhX -- rdrd}rd(hgUhhj dubj)rd}rd(hgX$``(errorCode=401, detailCode=4932)``hm}rd(ho]hp]hq]hr]ht]uhhj dhb]rdhX (errorCode=401, detailCode=4932)r dr!d}r"d(hgUhhjdubahkjubehkhubahkj;#ubj#)r#d}r$d(hgUhm}r%d(ho]hp]hq]hr]ht]uhhjchb]r&dh)r'd}r(d(hgX7Exceptions.NotFound -- (errorCode=404, detailCode=4933)hm}r)d(ho]hp]hq]hr]ht]uhhj#dhb]r*d(j)r+d}r,d(hgUhm}r-d(Ureftypej#j"U reftargetXExceptions.NotFoundr.dU refdomainjahr]hq]U refexplicitho]hp]ht]uhhj'dhb]r/dj")r0d}r1d(hgj.dhm}r2d(ho]hp]hq]hr]ht]uhhj+dhb]r3dhXExceptions.NotFoundr4dr5d}r6d(hgUhhj0dubahkj"ubahkjubhX -- r7dr8d}r9d(hgUhhj'dubj)r:d}r;d(hgX$``(errorCode=404, detailCode=4933)``hm}rdr?d}r@d(hgUhhj:dubahkjubehkhubahkj;#ubj#)rAd}rBd(hgUhm}rCd(ho]hp]hq]hr]ht]uhhjchb]rDdh)rEd}rFd(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4934)hm}rGd(ho]hp]hq]hr]ht]uhhjAdhb]rHd(j)rId}rJd(hgUhm}rKd(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrLdU refdomainjahr]hq]U refexplicitho]hp]ht]uhhjEdhb]rMdj")rNd}rOd(hgjLdhm}rPd(ho]hp]hq]hr]ht]uhhjIdhb]rQdhXExceptions.NotAuthorizedrRdrSd}rTd(hgUhhjNdubahkj"ubahkjubhX -- rUdrVd}rWd(hgUhhjEdubj)rXd}rYd(hgX$``(errorCode=401, detailCode=4934)``hm}rZd(ho]hp]hq]hr]ht]uhhjEdhb]r[dhX (errorCode=401, detailCode=4934)r\dr]d}r^d(hgUhhjXdubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubh)r_d}r`d(hgX **Examples**radhhjUhijX!source/apis/examples/describe.txtrbdrcd}rddbhkhhm}red(ho]hp]hq]hr]ht]uhvKhwhhb]rfdjG3)rgd}rhd(hgjadhm}rid(ho]hp]hq]hr]ht]uhhj_dhb]rjdhXExamplesrkdrld}rmd(hgUhhjgdubahkjO3ubaubh)rnd}rod(hgXG(HEAD) Retrieve information about the object with identifier "ABC123"::rpdhhjUhijcdhkhhm}rqd(ho]hp]hq]hr]ht]uhvKhwhhb]rrdhXF(HEAD) Retrieve information about the object with identifier "ABC123":rsdrtd}rud(hgXF(HEAD) Retrieve information about the object with identifier "ABC123":hhjndubaubj3)rvd}rwd(hgXCcurl -I http://mn1.dataone.org/mn/v1/object/ABC123 HTTP/1.1 200 OK Last-Modified: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 10400 Content-Type: application/octet-stream DataONE-ObjectFormat: eml://ecoinformatics.org/eml-2.0.1 DataONE-Checksum: SHA-1,2e01e17467891f7c933dbaa00e1459d23db3fe4f DataONE-SerialVersion: 1234hhjUhijcdhkj3hm}rxd(j#j$hr]hq]ho]hp]ht]uhvMhwhhb]rydhXCcurl -I http://mn1.dataone.org/mn/v1/object/ABC123 HTTP/1.1 200 OK Last-Modified: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 10400 Content-Type: application/octet-stream DataONE-ObjectFormat: eml://ecoinformatics.org/eml-2.0.1 DataONE-Checksum: SHA-1,2e01e17467891f7c933dbaa00e1459d23db3fe4f DataONE-SerialVersion: 1234rzdr{d}r|d(hgUhhjvdubaubh)r}d}r~d(hgXJ(HEAD) An error response to a describe() request for object "IDONTEXIST"::rdhhjUhijcdhkhhm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rdhXI(HEAD) An error response to a describe() request for object "IDONTEXIST":rdrd}rd(hgXI(HEAD) An error response to a describe() request for object "IDONTEXIST":hhj}dubaubj3)rd}rd(hgX^curl -I http://mn1.dataone.org/mn/v1/object/IDONTEXIST HTTP/1.1 404 Not Found Last-Modified: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 1182 Content-Type: text/xml DataONE-Exception-Name: NotFound DataONE-Exception-DetailCode: 1380 DataONE-Exception-Description: The specified object does not exist on this node. DataONE-Exception-PID: IDONTEXISThhjUhiX8internal padding after source/apis/examples/describe.txtrdhkj3hm}rd(j#j$hr]hq]ho]hp]ht]uhvMhwhhb]rdhX^curl -I http://mn1.dataone.org/mn/v1/object/IDONTEXIST HTTP/1.1 404 Not Found Last-Modified: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 1182 Content-Type: text/xml DataONE-Exception-Name: NotFound DataONE-Exception-DetailCode: 1380 DataONE-Exception-Description: The specified object does not exist on this node. DataONE-Exception-PID: IDONTEXISTrdrd}rd(hgUhhjdubaubj)rd}rd(hgUhhjUhiNhkjhm}rd(hr]hq]ho]hp]ht]Uentries]rd(jXresolve() (in module CNRead)h8UNtrdauhvNhwhhb]ubj!)rd}rd(hgUhhjUhiNhkj!hm}rd(j"j"Xpyrdhr]hq]ho]hp]ht]j"Xfunctionrdj"jduhvNhwhhb]rd(j")rd}rd(hgX)resolve(session,id) -> ObjectLocationListhhjdhijUhkj "hm}rd(hr]rdh8aj"jUhq]ho]hp]ht]rdh8aj"Xresolverdj"Uj"uhvKhwhhb]rd(j")rd}rd(hgXCNRead.hhjdhijUhkj"hm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rdhXCNRead.rdrd}rd(hgUhhjdubaubj")rd}rd(hgjdhhjdhijUhkj!"hm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rdhXresolverdrd}rd(hgUhhjdubaubj'")rd}rd(hgX session, idhhjdhijUhkj*"hm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rd(j-")rd}rd(hgXsessionhm}rd(ho]hp]hq]hr]ht]uhhjdhb]rdhXsessionrdrd}rd(hgUhhjdubahkj5"ubj-")rd}rd(hgXidhm}rd(ho]hp]hq]hr]ht]uhhjdhb]rdhXidrdrd}rd(hgUhhjdubahkj5"ubeubj6")rd}rd(hgXObjectLocationListhhjdhijUhkj9"hm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rdhXObjectLocationListrdrd}rd(hgUhhjdubaubeubj?")rd}rd(hgUhhjdhijUhkjB"hm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rd(h)rd}rd(hgXReturns a list of nodes (MNs or CNs) known to hold copies of the object identified by *id*. The object resolution process is intended to provide a simple mechanism for a client to discover from which node(s) a particular object may be retrieved. Details about method interfaces (i.e. REST URLs) exposed by a particular node can be determined by examining the response from the *node* collection. For convenience, the :func:`MNRead.get` URL is included in the response as is the base URL of the node REST services.hhjdhijUhkhhm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rd(hXVReturns a list of nodes (MNs or CNs) known to hold copies of the object identified by rdrd}rd(hgXVReturns a list of nodes (MNs or CNs) known to hold copies of the object identified by hhjdubj$)rd}rd(hgX*id*hm}rd(ho]hp]hq]hr]ht]uhhjdhb]rdhXidrdrd}rd(hgUhhjdubahkj$ubhX. The object resolution process is intended to provide a simple mechanism for a client to discover from which node(s) a particular object may be retrieved. Details about method interfaces (i.e. REST URLs) exposed by a particular node can be determined by examining the response from the rdrd}rd(hgX. The object resolution process is intended to provide a simple mechanism for a client to discover from which node(s) a particular object may be retrieved. Details about method interfaces (i.e. REST URLs) exposed by a particular node can be determined by examining the response from the hhjdubj$)rd}rd(hgX*node*hm}rd(ho]hp]hq]hr]ht]uhhjdhb]rdhXnoderdrd}rd(hgUhhjdubahkj$ubhX" collection. For convenience, the rdrd}rd(hgX" collection. For convenience, the hhjdubj)rd}rd(hgX:func:`MNRead.get`rdhhjdhijUhkjhm}rd(UreftypeXfuncjjX MNRead.getU refdomainXpyrdhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rdj)rd}rd(hgjdhm}rd(ho]hp]rd(jjdXpy-funcrdehq]hr]ht]uhhjdhb]rdhX MNRead.get()rdrd}rd(hgUhhjdubahkjubaubhXN URL is included in the response as is the base URL of the node REST services.rdrd}rd(hgXN URL is included in the response as is the base URL of the node REST services.hhjdubeubh)rd}rd(hgX<Note also that the same functionality as *resolve()* can be implemented by retrieving a copy of the system metadata for the object and utilizing the node registry to discover the base URL from which the client can construct the *get()* URL. Resolve is provided for efficiency since the response size is much smaller.hhjdhijUhkhhm}rd(ho]hp]hq]hr]ht]uhvKhwhhb]rd(hX)Note also that the same functionality as rdrd}rd(hgX)Note also that the same functionality as hhjdubj$)rd}rd(hgX *resolve()*hm}re(ho]hp]hq]hr]ht]uhhjdhb]rehX resolve()rere}re(hgUhhjdubahkj$ubhX can be implemented by retrieving a copy of the system metadata for the object and utilizing the node registry to discover the base URL from which the client can construct the rere}re(hgX can be implemented by retrieving a copy of the system metadata for the object and utilizing the node registry to discover the base URL from which the client can construct the hhjdubj$)re}r e(hgX*get()*hm}r e(ho]hp]hq]hr]ht]uhhjdhb]r ehXget()r er e}re(hgUhhjeubahkj$ubhXQ URL. Resolve is provided for efficiency since the response size is much smaller.rere}re(hgXQ URL. Resolve is provided for efficiency since the response size is much smaller.hhjdubeubh)re}re(hgXResolve will return a HTTP status of 303 (see other) on success. The HTTP header "Location" MUST be set, and it's value SHOULD be the full get() URL for retrieving the object from the first location in the resolve response.rehhjdhijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhwhhb]rehXResolve will return a HTTP status of 303 (see other) on success. The HTTP header "Location" MUST be set, and it's value SHOULD be the full get() URL for retrieving the object from the first location in the resolve response.rere}re(hgjehhjeubaubh)re}re(hgXv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`. If the identifier is a SID, then resolution is for the latest version of an object (i.e. the head of the obsolescence chain).hhjdhijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhwhhb]re(hX'v2.0: The supplied identifier may be a rere}r e(hgX'v2.0: The supplied identifier may be a hhjeubj)r!e}r"e(hgX :term:`PID`r#ehhjehijUhkjhm}r$e(UreftypeXtermjjXpidU refdomainXstdr%ehr]hq]U refexplicitho]hp]ht]jjuhvKhb]r&ej`2)r'e}r(e(hgj#ehm}r)e(ho]hp]r*e(jj%eXstd-termr+eehq]hr]ht]uhhj!ehb]r,ehXPIDr-er.e}r/e(hgUhhj'eubahkji2ubaubhX or a r0er1e}r2e(hgX or a hhjeubj)r3e}r4e(hgX :term:`SID`r5ehhjehijUhkjhm}r6e(UreftypeXtermjjXsidU refdomainXstdr7ehr]hq]U refexplicitho]hp]ht]jjuhvKhb]r8ej`2)r9e}r:e(hgj5ehm}r;e(ho]hp]rehXSIDr?er@e}rAe(hgUhhj9eubahkji2ubaubhX. If the identifier is a SID, then resolution is for the latest version of an object (i.e. the head of the obsolescence chain).rBerCe}rDe(hgX. If the identifier is a SID, then resolution is for the latest version of an object (i.e. the head of the obsolescence chain).hhjeubeubh)rEe}rFe(hgUhhjdhiNhkhhm}rGe(ho]hp]hq]hr]ht]uhvNhwhhb]rHe(h)rIe}rJe(hgUhhjEehijUhkhhm}rKe(ho]hp]hq]hr]ht]uhvKhwhhb]rLe(h)rMe}rNe(hgXVersionhhjIehijUhkhhm}rOe(ho]hp]hq]hr]ht]uhvKhb]rPehXVersionrQerRe}rSe(hgUhhjMeubaubh)rTe}rUe(hgX1.0, 2.0rVehm}rWe(ho]hp]hq]hr]ht]uhhjIehb]rXeh)rYe}rZe(hgjVehhjTehijUhkhhm}r[e(ho]hp]hq]hr]ht]uhvKhb]r\ehX1.0, 2.0r]er^e}r_e(hgjVehhjYeubaubahkhubeubh)r`e}rae(hgUhhjEehijUhkhhm}rbe(ho]hp]hq]hr]ht]uhvKhwhhb]rce(h)rde}ree(hgX Use Caseshhj`ehijUhkhhm}rfe(ho]hp]hq]hr]ht]uhvKhb]rgehX Use Casesrherie}rje(hgUhhjdeubaubh)rke}rle(hgXJ:doc:`UC36 `, :doc:`UC16 `rmehm}rne(ho]hp]hq]hr]ht]uhhj`ehb]roeh)rpe}rqe(hgjmehhjkehijUhkhhm}rre(ho]hp]hq]hr]ht]uhvKhb]rse(j)rte}rue(hgX$:doc:`UC36 `rvehhjpehijUhkjhm}rwe(UreftypeXdocrxejjX/design/UseCases/36_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]ryej`2)rze}r{e(hgjvehm}r|e(ho]hp]r}e(jjxeehq]hr]ht]uhhjtehb]r~ehXUC36rere}re(hgUhhjzeubahkji2ubaubhX, rere}re(hgX, hhjpeubj)re}re(hgX$:doc:`UC16 `rehhjpehijUhkjhm}re(UreftypeXdocrejjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rej`2)re}re(hgjehm}re(ho]hp]re(jjeehq]hr]ht]uhhjehb]rehXUC16rere}re(hgUhhjeubahkji2ubaubeubahkhubeubh)re}re(hgUhhjEehijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhwhhb]re(h)re}re(hgXREST URLhhjehijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rehXREST URLrere}re(hgUhhjeubaubh)re}re(hgX``GET /resolve/{id}``rehm}re(ho]hp]hq]hr]ht]uhhjehb]reh)re}re(hgjehhjehijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rej)re}re(hgjehm}re(ho]hp]hq]hr]ht]uhhjehb]rehXGET /resolve/{id}rere}re(hgUhhjeubahkjubaubahkhubeubh)re}re(hgUhm}re(ho]hp]hq]hr]ht]uhhjEehb]re(h)re}re(hgX ParametershhjehijUhkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rehX Parametersrere}re(hgUhhjeubaubh)re}re(hgUhm}re(ho]hp]hq]hr]ht]uhhjehb]rej #)re}re(hgUhm}re(ho]hp]hq]hr]ht]uhhjehb]re(j#)re}re(hgUhm}re(ho]hp]hq]hr]ht]uhhjehb]reh)re}re(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}re(ho]hp]hq]hr]ht]uhhjehb]re(j")re}re(hgXsessionhm}re(hr]hq]j"ho]hp]ht]uhhjehb]rehXsessionrere}re(hgUhhjeubahkj"ubhX (rere}re(hgUhhjeubj)re}re(hgX:class:`Types.Session`rehhjehijUhkjhm}re(UreftypeXclassjjX Types.SessionU refdomainXpyrehr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rej)re}re(hgjehm}re(ho]hp]re(jjeXpy-classreehq]hr]ht]uhhjehb]rehX Types.Sessionrere}re(hgUhhjeubahkjubaubhX)re}re(hgUhhjeubhX -- rere}re(hgUhhjeubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rere}re(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjeubj)re}re(hgX:term:`public user`rehhjehijUhkjhm}re(UreftypeXtermjjX public userU refdomainXstdrehr]hq]U refexplicitho]hp]ht]jjuhvKhb]rej`2)re}re(hgjehm}re(ho]hp]re(jjeXstd-termreehq]hr]ht]uhhjehb]rehX public userrere}re(hgUhhjeubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rere}re(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjeubehkhubahkj;#ubj#)re}re(hgUhm}re(ho]hp]hq]hr]ht]uhhjehb]reh)rf}rf(hgXid (Types.Identifier) -- Identifier being resolved. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}rf(ho]hp]hq]hr]ht]uhhjehb]rf(j")rf}rf(hgXidhm}rf(hr]hq]j"ho]hp]ht]uhhjfhb]rfhXidrfr f}r f(hgUhhjfubahkj"ubhX (r fr f}r f(hgUhhjfubj)rf}rf(hgX:class:`Types.Identifier`rfhhjfhijUhkjhm}rf(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrfhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rfj)rf}rf(hgjfhm}rf(ho]hp]rf(jjfXpy-classrfehq]hr]ht]uhhjfhb]rfhXTypes.Identifierrfrf}rf(hgUhhjfubahkjubaubhX)rf}rf(hgUhhjfubhX -- rfr f}r!f(hgUhhjfubhXIdentifier being resolved. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r"fr#f}r$f(hgXIdentifier being resolved. May be either a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjfubehkhubahkj;#ubehkj#ubahkhubehkhubh)r%f}r&f(hgUhm}r'f(ho]hp]hq]hr]ht]uhhjEehb]r(f(h)r)f}r*f(hgXReturnshhj%fhijUhkhhm}r+f(ho]hp]hq]hr]ht]uhvKhb]r,fhXReturnsr-fr.f}r/f(hgUhhj)fubaubh)r0f}r1f(hgUhm}r2f(ho]hp]hq]hr]ht]uhhj%fhb]r3fh)r4f}r5f(hgXuA list of nodes known to contain copies of the target object, plus the URLs known to resolve to the node get methods.hm}r6f(ho]hp]hq]hr]ht]uhhj0fhb]r7fhXuA list of nodes known to contain copies of the target object, plus the URLs known to resolve to the node get methods.r8fr9f}r:f(hgXuA list of nodes known to contain copies of the target object, plus the URLs known to resolve to the node get methods.hhj4fubahkhubahkhubehkhubh)r;f}rf(h)r?f}r@f(hgX Return typehhj;fhijUhkhhm}rAf(ho]hp]hq]hr]ht]uhvKhb]rBfhX Return typerCfrDf}rEf(hgUhhj?fubaubh)rFf}rGf(hgUhm}rHf(ho]hp]hq]hr]ht]uhhj;fhb]rIfh)rJf}rKf(hgXTypes.ObjectLocationListhm}rLf(ho]hp]hq]hr]ht]uhhjFfhb]rMfj)rNf}rOf(hgX!:class:`Types.ObjectLocationList`rPfhhjJfhijUhkjhm}rQf(UreftypeXclassjjXTypes.ObjectLocationListU refdomainXpyrRfhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rSfj)rTf}rUf(hgjPfhm}rVf(ho]hp]rWf(jjRfXpy-classrXfehq]hr]ht]uhhjNfhb]rYfhXTypes.ObjectLocationListrZfr[f}r\f(hgUhhjTfubahkjubaubahkhubahkhubehkhubh)r]f}r^f(hgUhm}r_f(ho]hp]hq]hr]ht]uhhjEehb]r`f(h)raf}rbf(hgXRaiseshhj]fhijUhkhhm}rcf(ho]hp]hq]hr]ht]uhvKhb]rdfhXRaisesrefrff}rgf(hgUhhjafubaubh)rhf}rif(hgUhm}rjf(ho]hp]hq]hr]ht]uhhj]fhb]rkfj #)rlf}rmf(hgUhm}rnf(ho]hp]hq]hr]ht]uhhjhfhb]rof(j#)rpf}rqf(hgUhm}rrf(ho]hp]hq]hr]ht]uhhjlfhb]rsfh)rtf}ruf(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4130)hm}rvf(ho]hp]hq]hr]ht]uhhjpfhb]rwf(j)rxf}ryf(hgUhm}rzf(Ureftypej#j"U reftargetXExceptions.InvalidTokenr{fU refdomainjdhr]hq]U refexplicitho]hp]ht]uhhjtfhb]r|fj")r}f}r~f(hgj{fhm}rf(ho]hp]hq]hr]ht]uhhjxfhb]rfhXExceptions.InvalidTokenrfrf}rf(hgUhhj}fubahkj"ubahkjubhX -- rfrf}rf(hgUhhjtfubj)rf}rf(hgX$``(errorCode=401, detailCode=4130)``hm}rf(ho]hp]hq]hr]ht]uhhjtfhb]rfhX (errorCode=401, detailCode=4130)rfrf}rf(hgUhhjfubahkjubehkhubahkj;#ubj#)rf}rf(hgUhm}rf(ho]hp]hq]hr]ht]uhhjlfhb]rfh)rf}rf(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4150)hm}rf(ho]hp]hq]hr]ht]uhhjfhb]rf(j)rf}rf(hgUhm}rf(Ureftypej#j"U reftargetXExceptions.ServiceFailurerfU refdomainjdhr]hq]U refexplicitho]hp]ht]uhhjfhb]rfj")rf}rf(hgjfhm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhXExceptions.ServiceFailurerfrf}rf(hgUhhjfubahkj"ubahkjubhX -- rfrf}rf(hgUhhjfubj)rf}rf(hgX$``(errorCode=500, detailCode=4150)``hm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhX (errorCode=500, detailCode=4150)rfrf}rf(hgUhhjfubahkjubehkhubahkj;#ubj#)rf}rf(hgUhm}rf(ho]hp]hq]hr]ht]uhhjlfhb]rfh)rf}rf(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4120)hm}rf(ho]hp]hq]hr]ht]uhhjfhb]rf(j)rf}rf(hgUhm}rf(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrfU refdomainjdhr]hq]U refexplicitho]hp]ht]uhhjfhb]rfj")rf}rf(hgjfhm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhXExceptions.NotAuthorizedrfrf}rf(hgUhhjfubahkj"ubahkjubhX -- rfrf}rf(hgUhhjfubj)rf}rf(hgX$``(errorCode=401, detailCode=4120)``hm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhX (errorCode=401, detailCode=4120)rfrf}rf(hgUhhjfubahkjubehkhubahkj;#ubj#)rf}rf(hgUhm}rf(ho]hp]hq]hr]ht]uhhjlfhb]rfh)rf}rf(hgXlExceptions.NotFound -- (errorCode=404, detailCode=4140)There is no object identified by the given identifierhm}rf(ho]hp]hq]hr]ht]uhhjfhb]rf(j)rf}rf(hgUhm}rf(Ureftypej#j"U reftargetXExceptions.NotFoundrfU refdomainjdhr]hq]U refexplicitho]hp]ht]uhhjfhb]rfj")rf}rf(hgjfhm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhXExceptions.NotFoundrfrf}rf(hgUhhjfubahkj"ubahkjubhX -- rfrf}rf(hgUhhjfubh)rf}rf(hgX$``(errorCode=404, detailCode=4140)``rfhhjfhijUhkhhm}rf(ho]hp]hq]hr]ht]uhvKhb]rfj)rf}rf(hgjfhm}rf(ho]hp]hq]hr]ht]uhhjfhb]rfhX (errorCode=404, detailCode=4140)rfrf}rf(hgUhhjfubahkjubaubh)rf}rf(hgX5There is no object identified by the given identifierrfhhjfhijUhkhhm}rf(ho]hp]hq]hr]ht]uhvKhb]rfhX5There is no object identified by the given identifierrfrf}rf(hgjfhhjfubaubehkhubahkj;#ubj#)rf}rf(hgUhm}rf(ho]hp]hq]hr]ht]uhhjlfhb]rfh)rf}rf(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4131)hm}rf(ho]hp]hq]hr]ht]uhhjfhb]rf(j)rf}rf(hgUhm}rf(Ureftypej#j"U reftargetXExceptions.NotImplementedrgU refdomainjdhr]hq]U refexplicitho]hp]ht]uhhjfhb]rgj")rg}rg(hgjghm}rg(ho]hp]hq]hr]ht]uhhjfhb]rghXExceptions.NotImplementedrgrg}rg(hgUhhjgubahkj"ubahkjubhX -- r gr g}r g(hgUhhjfubj)r g}r g(hgX$``(errorCode=501, detailCode=4131)``hm}rg(ho]hp]hq]hr]ht]uhhjfhb]rghX (errorCode=501, detailCode=4131)rgrg}rg(hgUhhj gubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubh)rg}rg(hgX **Examples**rghhjUhijX source/apis/examples/resolve.txtrgrg}rgbhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rgjG3)rg}rg(hgjghm}rg(ho]hp]hq]hr]ht]uhhjghb]rghXExamplesrgr g}r!g(hgUhhjgubahkjO3ubaubh)r"g}r#g(hgX3XML (default) in response to ``Accept: text/xml``::r$ghhjUhijghkhhm}r%g(ho]hp]hq]hr]ht]uhvKhwhhb]r&g(hXXML (default) in response to r'gr(g}r)g(hgXXML (default) in response to hhj"gubj)r*g}r+g(hgX``Accept: text/xml``hm}r,g(ho]hp]hq]hr]ht]uhhj"ghb]r-ghXAccept: text/xmlr.gr/g}r0g(hgUhhj*gubahkjubhX:r1g}r2g(hgX:hhj"gubeubj3)r3g}r4g(hgX*curl -X GET -H "Accept: text/xml" http://cn.dataone.org/object/resolve/1234 or curl -X GET -H "Accept: */*" http://cn.dataone.org/object/resolve/1234 1234 mn1 http://mn1.dataone.org/mn v1 http://mn1.dataone.org/mn/object/1234 mn2 http://mn2.dataone.org/mn v1 http://mn2.dataone.org/some_base/object/1234 cn1 http://cn1.dataone.org/mn v1 http://cn1.dataone.org/cn/object/1234 cn2 http://cn2.dataone.org/mn v1 http://cn2.dataone.org/cn/object/1234 cn3 http://cn3.dataone.org/mn v1 http://cn3.dataone.org/cn/object/1234 hhjUhiX7internal padding after source/apis/examples/resolve.txtr5ghkj3hm}r6g(j#j$hr]hq]ho]hp]ht]uhvMKhwhhb]r7ghX*curl -X GET -H "Accept: text/xml" http://cn.dataone.org/object/resolve/1234 or curl -X GET -H "Accept: */*" http://cn.dataone.org/object/resolve/1234 1234 mn1 http://mn1.dataone.org/mn v1 http://mn1.dataone.org/mn/object/1234 mn2 http://mn2.dataone.org/mn v1 http://mn2.dataone.org/some_base/object/1234 cn1 http://cn1.dataone.org/mn v1 http://cn1.dataone.org/cn/object/1234 cn2 http://cn2.dataone.org/mn v1 http://cn2.dataone.org/cn/object/1234 cn3 http://cn3.dataone.org/mn v1 http://cn3.dataone.org/cn/object/1234 r8gr9g}r:g(hgUhhj3gubaubj)r;g}rg(jX getChecksum() (in module CNRead)h UNtr?gauhvNhwhhb]ubj!)r@g}rAg(hgUhhjUhiNhkj!hm}rBg(j"j"XpyrCghr]hq]ho]hp]ht]j"XfunctionrDgj"jDguhvNhwhhb]rEg(j")rFg}rGg(hgX$getChecksum(session,pid) -> Checksumhhj@ghijUhkj "hm}rHg(hr]rIgh aj"jUhq]ho]hp]ht]rJgh aj"X getChecksumrKgj"Uj"uhvMhwhhb]rLg(j")rMg}rNg(hgXCNRead.hhjFghijUhkj"hm}rOg(ho]hp]hq]hr]ht]uhvMhwhhb]rPghXCNRead.rQgrRg}rSg(hgUhhjMgubaubj")rTg}rUg(hgjKghhjFghijUhkj!"hm}rVg(ho]hp]hq]hr]ht]uhvMhwhhb]rWghX getChecksumrXgrYg}rZg(hgUhhjTgubaubj'")r[g}r\g(hgX session, pidhhjFghijUhkj*"hm}r]g(ho]hp]hq]hr]ht]uhvMhwhhb]r^g(j-")r_g}r`g(hgXsessionhm}rag(ho]hp]hq]hr]ht]uhhj[ghb]rbghXsessionrcgrdg}reg(hgUhhj_gubahkj5"ubj-")rfg}rgg(hgXpidhm}rhg(ho]hp]hq]hr]ht]uhhj[ghb]righXpidrjgrkg}rlg(hgUhhjfgubahkj5"ubeubj6")rmg}rng(hgXChecksumhhjFghijUhkj9"hm}rog(ho]hp]hq]hr]ht]uhvMhwhhb]rpghXChecksumrqgrrg}rsg(hgUhhjmgubaubeubj?")rtg}rug(hgUhhj@ghijUhkjB"hm}rvg(ho]hp]hq]hr]ht]uhvMhwhhb]rwg(h)rxg}ryg(hgXQReturns the checksum for the specified object as reported in the system metadata.rzghhjtghijUhkhhm}r{g(ho]hp]hq]hr]ht]uhvKhwhhb]r|ghXQReturns the checksum for the specified object as reported in the system metadata.r}gr~g}rg(hgjzghhjxgubaubh)rg}rg(hgXNote that the signature of this method differs from :func:`MNRead.getChecksum` as that method takes an optional algorithm parameter.hhjtghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rg(hX4Note that the signature of this method differs from rgrg}rg(hgX4Note that the signature of this method differs from hhjgubj)rg}rg(hgX:func:`MNRead.getChecksum`rghhjghijUhkjhm}rg(UreftypeXfuncjjXMNRead.getChecksumU refdomainXpyrghr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rgj)rg}rg(hgjghm}rg(ho]hp]rg(jjgXpy-funcrgehq]hr]ht]uhhjghb]rghXMNRead.getChecksum()rgrg}rg(hgUhhjgubahkjubaubhX6 as that method takes an optional algorithm parameter.rgrg}rg(hgX6 as that method takes an optional algorithm parameter.hhjgubeubh)rg}rg(hgUhhjtghiNhkhhm}rg(ho]hp]hq]hr]ht]uhvNhwhhb]rg(h)rg}rg(hgUhhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rg(h)rg}rg(hgXVersionhhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rghXVersionrgrg}rg(hgUhhjgubaubh)rg}rg(hgX 1.0, (2.0)rghm}rg(ho]hp]hq]hr]ht]uhhjghb]rgh)rg}rg(hgjghhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rghX 1.0, (2.0)rgrg}rg(hgjghhjgubaubahkhubeubh)rg}rg(hgUhhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rg(h)rg}rg(hgX Use CaseshhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rghX Use Casesrgrg}rg(hgUhhjgubaubh)rg}rg(hgX$:doc:`UC09 `rghm}rg(ho]hp]hq]hr]ht]uhhjghb]rgh)rg}rg(hgjghhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rgj)rg}rg(hgjghhjghijUhkjhm}rg(UreftypeXdocrgjjX/design/UseCases/09_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rgj`2)rg}rg(hgjghm}rg(ho]hp]rg(jjgehq]hr]ht]uhhjghb]rghXUC09rgrg}rg(hgUhhjgubahkji2ubaubaubahkhubeubh)rg}rg(hgUhhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rg(h)rg}rg(hgXREST URLhhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rghXREST URLrgrg}rg(hgUhhjgubaubh)rg}rg(hgX``GET /checksum/{pid}``rghm}rg(ho]hp]hq]hr]ht]uhhjghb]rgh)rg}rg(hgjghhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rgj)rg}rg(hgjghm}rg(ho]hp]hq]hr]ht]uhhjghb]rghXGET /checksum/{pid}rgrg}rg(hgUhhjgubahkjubaubahkhubeubh)rg}rg(hgUhm}rg(ho]hp]hq]hr]ht]uhhjghb]rg(h)rg}rg(hgX ParametershhjghijUhkhhm}rg(ho]hp]hq]hr]ht]uhvKhb]rghX Parametersrgrg}rg(hgUhhjgubaubh)rg}rg(hgUhm}rg(ho]hp]hq]hr]ht]uhhjghb]rgj #)rg}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjghb]rh(j#)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjghb]rhh)rh}rh(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r h(ho]hp]hq]hr]ht]uhhjhhb]r h(j")r h}r h(hgXsessionhm}r h(hr]hq]j"ho]hp]ht]uhhjhhb]rhhXsessionrhrh}rh(hgUhhj hubahkj"ubhX (rhrh}rh(hgUhhjhubj)rh}rh(hgX:class:`Types.Session`rhhhjhhijUhkjhm}rh(UreftypeXclassjjX Types.SessionU refdomainXpyrhhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rhj)rh}rh(hgjhhm}rh(ho]hp]rh(jjhXpy-classrhehq]hr]ht]uhhjhhb]r hhX Types.Sessionr!hr"h}r#h(hgUhhjhubahkjubaubhX)r$h}r%h(hgUhhjhubhX -- r&hr'h}r(h(hgUhhjhubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r)hr*h}r+h(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjhubj)r,h}r-h(hgX:term:`public user`r.hhhjhhijUhkjhm}r/h(UreftypeXtermjjX public userU refdomainXstdr0hhr]hq]U refexplicitho]hp]ht]jjuhvKhb]r1hj`2)r2h}r3h(hgj.hhm}r4h(ho]hp]r5h(jj0hXstd-termr6hehq]hr]ht]uhhj,hhb]r7hhX public userr8hr9h}r:h(hgUhhj2hubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r;hrh}r?h(hgUhm}r@h(ho]hp]hq]hr]ht]uhhjghb]rAhh)rBh}rCh(hgXpid (Types.Identifier) -- Identifier of the object for which checksum is being requested Transmitted as part of the URL path and must be escaped accordingly.hm}rDh(ho]hp]hq]hr]ht]uhhj>hhb]rEh(j")rFh}rGh(hgXpidhm}rHh(hr]hq]j"ho]hp]ht]uhhjBhhb]rIhhXpidrJhrKh}rLh(hgUhhjFhubahkj"ubhX (rMhrNh}rOh(hgUhhjBhubj)rPh}rQh(hgX:class:`Types.Identifier`rRhhhjBhhijUhkjhm}rSh(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrThhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rUhj)rVh}rWh(hgjRhhm}rXh(ho]hp]rYh(jjThXpy-classrZhehq]hr]ht]uhhjPhhb]r[hhXTypes.Identifierr\hr]h}r^h(hgUhhjVhubahkjubaubhX)r_h}r`h(hgUhhjBhubhX -- rahrbh}rch(hgUhhjBhubhXIdentifier of the object for which checksum is being requested Transmitted as part of the URL path and must be escaped accordingly.rdhreh}rfh(hgXIdentifier of the object for which checksum is being requested Transmitted as part of the URL path and must be escaped accordingly.hhjBhubehkhubahkj;#ubehkj#ubahkhubehkhubh)rgh}rhh(hgUhm}rih(ho]hp]hq]hr]ht]uhhjghb]rjh(h)rkh}rlh(hgXReturnshhjghhijUhkhhm}rmh(ho]hp]hq]hr]ht]uhvKhb]rnhhXReturnsrohrph}rqh(hgUhhjkhubaubh)rrh}rsh(hgUhm}rth(ho]hp]hq]hr]ht]uhhjghhb]ruhh)rvh}rwh(hgX$The checksum of the specified objecthm}rxh(ho]hp]hq]hr]ht]uhhjrhhb]ryhhX$The checksum of the specified objectrzhr{h}r|h(hgX$The checksum of the specified objecthhjvhubahkhubahkhubehkhubh)r}h}r~h(hgUhm}rh(ho]hp]hq]hr]ht]uhhjghb]rh(h)rh}rh(hgX Return typehhj}hhijUhkhhm}rh(ho]hp]hq]hr]ht]uhvKhb]rhhX Return typerhrh}rh(hgUhhjhubaubh)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhj}hhb]rhh)rh}rh(hgXTypes.Checksumhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhj)rh}rh(hgX:class:`Types.Checksum`rhhhjhhijUhkjhm}rh(UreftypeXclassjjXTypes.ChecksumU refdomainXpyrhhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvKhb]rhj)rh}rh(hgjhhm}rh(ho]hp]rh(jjhXpy-classrhehq]hr]ht]uhhjhhb]rhhXTypes.Checksumrhrh}rh(hgUhhjhubahkjubaubahkhubahkhubehkhubh)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjghb]rh(h)rh}rh(hgXRaiseshhjhhijUhkhhm}rh(ho]hp]hq]hr]ht]uhvKhb]rhhXRaisesrhrh}rh(hgUhhjhubaubh)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhj #)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rh(j#)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhh)rh}rh(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1402)hm}rh(ho]hp]hq]hr]ht]uhhjhhb]rh(j)rh}rh(hgUhm}rh(Ureftypej#j"U reftargetXExceptions.NotImplementedrhU refdomainjCghr]hq]U refexplicitho]hp]ht]uhhjhhb]rhj")rh}rh(hgjhhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhhXExceptions.NotImplementedrhrh}rh(hgUhhjhubahkj"ubahkjubhX -- rhrh}rh(hgUhhjhubj)rh}rh(hgX$``(errorCode=501, detailCode=1402)``hm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhhX (errorCode=501, detailCode=1402)rhrh}rh(hgUhhjhubahkjubehkhubahkj;#ubj#)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhh)rh}rh(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1410)hm}rh(ho]hp]hq]hr]ht]uhhjhhb]rh(j)rh}rh(hgUhm}rh(Ureftypej#j"U reftargetXExceptions.ServiceFailurerhU refdomainjCghr]hq]U refexplicitho]hp]ht]uhhjhhb]rhj")rh}rh(hgjhhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhhXExceptions.ServiceFailurerhrh}rh(hgUhhjhubahkj"ubahkjubhX -- rhrh}rh(hgUhhjhubj)rh}rh(hgX$``(errorCode=500, detailCode=1410)``hm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhhX (errorCode=500, detailCode=1410)rhrh}rh(hgUhhjhubahkjubehkhubahkj;#ubj#)rh}rh(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhh)rh}rh(hgX7Exceptions.NotFound -- (errorCode=404, detailCode=1420)hm}rh(ho]hp]hq]hr]ht]uhhjhhb]rh(j)rh}rh(hgUhm}rh(Ureftypej#j"U reftargetXExceptions.NotFoundrhU refdomainjCghr]hq]U refexplicitho]hp]ht]uhhjhhb]rhj")rh}rh(hgjhhm}rh(ho]hp]hq]hr]ht]uhhjhhb]rhhXExceptions.NotFoundrhri}ri(hgUhhjhubahkj"ubahkjubhX -- riri}ri(hgUhhjhubj)ri}ri(hgX$``(errorCode=404, detailCode=1420)``hm}ri(ho]hp]hq]hr]ht]uhhjhhb]rihX (errorCode=404, detailCode=1420)r ir i}r i(hgUhhjiubahkjubehkhubahkj;#ubj#)r i}r i(hgUhm}ri(ho]hp]hq]hr]ht]uhhjhhb]rih)ri}ri(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1400)hm}ri(ho]hp]hq]hr]ht]uhhj ihb]ri(j)ri}ri(hgUhm}ri(Ureftypej#j"U reftargetXExceptions.NotAuthorizedriU refdomainjCghr]hq]U refexplicitho]hp]ht]uhhjihb]rij")ri}ri(hgjihm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXExceptions.NotAuthorizedriri}ri(hgUhhjiubahkj"ubahkjubhX -- r ir!i}r"i(hgUhhjiubj)r#i}r$i(hgX$``(errorCode=401, detailCode=1400)``hm}r%i(ho]hp]hq]hr]ht]uhhjihb]r&ihX (errorCode=401, detailCode=1400)r'ir(i}r)i(hgUhhj#iubahkjubehkhubahkj;#ubj#)r*i}r+i(hgUhm}r,i(ho]hp]hq]hr]ht]uhhjhhb]r-ih)r.i}r/i(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1430)hm}r0i(ho]hp]hq]hr]ht]uhhj*ihb]r1i(j)r2i}r3i(hgUhm}r4i(Ureftypej#j"U reftargetXExceptions.InvalidTokenr5iU refdomainjCghr]hq]U refexplicitho]hp]ht]uhhj.ihb]r6ij")r7i}r8i(hgj5ihm}r9i(ho]hp]hq]hr]ht]uhhj2ihb]r:ihXExceptions.InvalidTokenr;irir?i}r@i(hgUhhj.iubj)rAi}rBi(hgX$``(errorCode=401, detailCode=1430)``hm}rCi(ho]hp]hq]hr]ht]uhhj.ihb]rDihX (errorCode=401, detailCode=1430)rEirFi}rGi(hgUhhjAiubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rHi}rIi(hgUhhjUhiNhkjhm}rJi(hr]hq]ho]hp]ht]Uentries]rKi(jX listObjects() (in module CNRead)h6UNtrLiauhvNhwhhb]ubj!)rMi}rNi(hgUhhjUhiNhkj!hm}rOi(j"j"XpyrPihr]hq]ho]hp]ht]j"XfunctionrQij"jQiuhvNhwhhb]rRi(j")rSi}rTi(hgXnlistObjects(session,[fromDate],[toDate],[formatId],[identifier],[start=0],[count=1000],[nodeId]) -> ObjectListhhjMihijUhkj "hm}rUi(hr]rVih6aj"jUhq]ho]hp]ht]rWih6aj"X listObjectsrXij"Uj"uhvMBhwhhb]rYi(j")rZi}r[i(hgXCNRead.hhjSihijUhkj"hm}r\i(ho]hp]hq]hr]ht]uhvMBhwhhb]r]ihXCNRead.r^ir_i}r`i(hgUhhjZiubaubj")rai}rbi(hgjXihhjSihijUhkj!"hm}rci(ho]hp]hq]hr]ht]uhvMBhwhhb]rdihX listObjectsreirfi}rgi(hgUhhjaiubaubj'")rhi}rii(hgXZsession, [fromDate], [toDate], [formatId], [identifier], [start=0], [count=1000], [nodeId]hhjSihijUhkj*"hm}rji(ho]hp]hq]hr]ht]uhvMBhwhhb]rki(j-")rli}rmi(hgXsessionhm}rni(ho]hp]hq]hr]ht]uhhjhihb]roihXsessionrpirqi}rri(hgUhhjliubahkj5"ubj:)rsi}rti(hgX [fromDate]hm}rui(ho]hp]hq]hr]ht]uhhjhihb]rvij-")rwi}rxi(hgXfromDatehm}ryi(ho]hp]hq]hr]ht]uhhjsihb]rzihXfromDater{ir|i}r}i(hgUhhjwiubahkj5"ubahkj:ubj:)r~i}ri(hgX[toDate]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgXtoDatehm}ri(ho]hp]hq]hr]ht]uhhj~ihb]rihXtoDateriri}ri(hgUhhjiubahkj5"ubahkj:ubj:)ri}ri(hgX [formatId]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgXformatIdhm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXformatIdriri}ri(hgUhhjiubahkj5"ubahkj:ubj:)ri}ri(hgX [identifier]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgX identifierhm}ri(ho]hp]hq]hr]ht]uhhjihb]rihX identifierriri}ri(hgUhhjiubahkj5"ubahkj:ubj:)ri}ri(hgX [start=0]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgXstart=0hm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXstart=0riri}ri(hgUhhjiubahkj5"ubahkj:ubj:)ri}ri(hgX [count=1000]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgX count=1000hm}ri(ho]hp]hq]hr]ht]uhhjihb]rihX count=1000riri}ri(hgUhhjiubahkj5"ubahkj:ubj:)ri}ri(hgX[nodeId]hm}ri(ho]hp]hq]hr]ht]uhhjhihb]rij-")ri}ri(hgXnodeIdhm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXnodeIdriri}ri(hgUhhjiubahkj5"ubahkj:ubeubj6")ri}ri(hgX ObjectListhhjSihijUhkj9"hm}ri(ho]hp]hq]hr]ht]uhvMBhwhhb]rihX ObjectListriri}ri(hgUhhjiubaubeubj?")ri}ri(hgUhhjMihijUhkjB"hm}ri(ho]hp]hq]hr]ht]uhvMBhwhhb]ri(h)ri}ri(hgXRetrieve the list of objects present on the CN that match the calling parameters. At a minimum, this method should be able to return a list of objects that match::hhjihijUhkhhm}ri(ho]hp]hq]hr]ht]uhvM hwhhb]rihXRetrieve the list of objects present on the CN that match the calling parameters. At a minimum, this method should be able to return a list of objects that match:riri}ri(hgXRetrieve the list of objects present on the CN that match the calling parameters. At a minimum, this method should be able to return a list of objects that match:hhjiubaubj3)ri}ri(hgX1fromDate < SystemMetadata.dateSysMetadataModifiedhhjihijUhkj3hm}ri(j#j$hr]hq]ho]hp]ht]uhvMhwhhb]rihX1fromDate < SystemMetadata.dateSysMetadataModifiedriri}ri(hgUhhjiubaubh)ri}ri(hgXbut is expected to also support date range (by also specifying *toDate*), and should also support slicing of the matching set of records by indicating the starting *index* of the response (where 0 is the index of the first item) and the *count* of elements to be returned.hhjihijUhkhhm}ri(ho]hp]hq]hr]ht]uhvM hwhhb]ri(hX?but is expected to also support date range (by also specifying riri}ri(hgX?but is expected to also support date range (by also specifying hhjiubj$)ri}ri(hgX*toDate*hm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXtoDateriri}ri(hgUhhjiubahkj$ubhX]), and should also support slicing of the matching set of records by indicating the starting riri}ri(hgX]), and should also support slicing of the matching set of records by indicating the starting hhjiubj$)ri}ri(hgX*index*hm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXindexriri}ri(hgUhhjiubahkj$ubhXB of the response (where 0 is the index of the first item) and the riri}ri(hgXB of the response (where 0 is the index of the first item) and the hhjiubj$)ri}ri(hgX*count*hm}ri(ho]hp]hq]hr]ht]uhhjihb]rihXcountriri}ri(hgUhhjiubahkj$ubhX of elements to be returned.riri}ri(hgX of elements to be returned.hhjiubeubh)ri}ri(hgX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.rjhhjihijUhkhhm}rj(ho]hp]hq]hr]ht]uhvMhwhhb]rjhX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.rjrj}rj(hgjjhhjiubaubh)rj}rj(hgX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.rjhhjihijUhkhhm}r j(ho]hp]hq]hr]ht]uhvMhwhhb]r jhX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r jr j}r j(hgjjhhjjubaubh)rj}rj(hgX4V2.0: Added filter on authoritativeMemberNode value.rjhhjihijUhkhhm}rj(ho]hp]hq]hr]ht]uhvMhwhhb]rjhX4V2.0: Added filter on authoritativeMemberNode value.rjrj}rj(hgjjhhjjubaubh)rj}rj(hgUhhjihiNhkhhm}rj(ho]hp]hq]hr]ht]uhvNhwhhb]rj(h)rj}rj(hgUhhjjhijUhkhhm}rj(ho]hp]hq]hr]ht]uhvMhwhhb]rj(h)rj}rj(hgXVersionhhjjhijUhkhhm}r j(ho]hp]hq]hr]ht]uhvKhb]r!jhXVersionr"jr#j}r$j(hgUhhjjubaubh)r%j}r&j(hgX 1.0, (2.0)r'jhm}r(j(ho]hp]hq]hr]ht]uhhjjhb]r)jh)r*j}r+j(hgj'jhhj%jhijUhkhhm}r,j(ho]hp]hq]hr]ht]uhvMhb]r-jhX 1.0, (2.0)r.jr/j}r0j(hgj'jhhj*jubaubahkhubeubh)r1j}r2j(hgUhhjjhijUhkhhm}r3j(ho]hp]hq]hr]ht]uhvMhwhhb]r4j(h)r5j}r6j(hgX Use Caseshhj1jhijUhkhhm}r7j(ho]hp]hq]hr]ht]uhvKhb]r8jhX Use Casesr9jr:j}r;j(hgUhhj5jubaubh)r`, :doc:`UC16 `r>jhm}r?j(ho]hp]hq]hr]ht]uhhj1jhb]r@jh)rAj}rBj(hgj>jhhj`rGjhhjAjhijUhkjhm}rHj(UreftypeXdocrIjjjX/design/UseCases/06_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rJjj`2)rKj}rLj(hgjGjhm}rMj(ho]hp]rNj(jjIjehq]hr]ht]uhhjEjhb]rOjhXUC06rPjrQj}rRj(hgUhhjKjubahkji2ubaubhX, rSjrTj}rUj(hgX, hhjAjubj)rVj}rWj(hgX$:doc:`UC16 `rXjhhjAjhijUhkjhm}rYj(UreftypeXdocrZjjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMhb]r[jj`2)r\j}r]j(hgjXjhm}r^j(ho]hp]r_j(jjZjehq]hr]ht]uhhjVjhb]r`jhXUC16rajrbj}rcj(hgUhhj\jubahkji2ubaubeubahkhubeubh)rdj}rej(hgUhhjjhijUhkhhm}rfj(ho]hp]hq]hr]ht]uhvMhwhhb]rgj(h)rhj}rij(hgXREST URLhhjdjhijUhkhhm}rjj(ho]hp]hq]hr]ht]uhvKhb]rkjhXREST URLrljrmj}rnj(hgUhhjhjubaubh)roj}rpj(hgX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]``rqjhm}rrj(ho]hp]hq]hr]ht]uhhjdjhb]rsjh)rtj}ruj(hgjqjhhjojhijUhkhhm}rvj(ho]hp]hq]hr]ht]uhvMhb]rwjj)rxj}ryj(hgjqjhm}rzj(ho]hp]hq]hr]ht]uhhjtjhb]r{jhXGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&nodeId={nodeId}&start={start}&count={count}]r|jr}j}r~j(hgUhhjxjubahkjubaubahkhubeubh)rj}rj(hgUhm}rj(ho]hp]hq]hr]ht]uhhjjhb]rj(h)rj}rj(hgX ParametershhjjhijUhkhhm}rj(ho]hp]hq]hr]ht]uhvKhb]rjhX Parametersrjrj}rj(hgUhhjjubaubh)rj}rj(hgUhm}rj(ho]hp]hq]hr]ht]uhhjjhb]rjj #)rj}rj(hgUhm}rj(ho]hp]hq]hr]ht]uhhjjhb]rj(j#)rj}rj(hgUhm}rj(ho]hp]hq]hr]ht]uhhjjhb]rjh)rj}rj(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rj(ho]hp]hq]hr]ht]uhhjjhb]rj(j")rj}rj(hgXsessionhm}rj(hr]hq]j"ho]hp]ht]uhhjjhb]rjhXsessionrjrj}rj(hgUhhjjubahkj"ubhX (rjrj}rj(hgUhhjjubj)rj}rj(hgX:class:`Types.Session`rjhhjjhijUhkjhm}rj(UreftypeXclassjjX Types.SessionU refdomainXpyrjhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rjj)rj}rj(hgjjhm}rj(ho]hp]rj(jjjXpy-classrjehq]hr]ht]uhhjjhb]rjhX Types.Sessionrjrj}rj(hgUhhjjubahkjubaubhX)rj}rj(hgUhhjjubhX -- rjrj}rj(hgUhhjjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rjrj}rj(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjjubj)rj}rj(hgX:term:`public user`rjhhjjhijUhkjhm}rj(UreftypeXtermjjX public userU refdomainXstdrjhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rjj`2)rj}rj(hgjjhm}rj(ho]hp]rj(jjjXstd-termrjehq]hr]ht]uhhjjhb]rjhX public userrjrj}rj(hgUhhjjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rjrj}rj(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjjubehkhubahkj;#ubj#)rj}rj(hgUhm}rj(ho]hp]hq]hr]ht]uhhjjhb]rjh)rj}rj(hgXfromDate (Types.DateTime) -- Entries with SystemMetadata.dateSysMetadataModified greater than or equal to (>=) fromDate must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rj(ho]hp]hq]hr]ht]uhhjjhb]rj(j")rj}rj(hgXfromDatehm}rj(hr]hq]j"ho]hp]ht]uhhjjhb]rjhXfromDaterjrj}rj(hgUhhjjubahkj"ubhX (rjrj}rj(hgUhhjjubj)rj}rj(hgX:class:`Types.DateTime`rjhhjjhijUhkjhm}rj(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrjhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rjj)rj}rj(hgjjhm}rj(ho]hp]rj(jjjXpy-classrjehq]hr]ht]uhhjjhb]rjhXTypes.DateTimerjrj}rj(hgUhhjjubahkjubaubhX)rj}rj(hgUhhjjubhX -- rjrj}rj(hgUhhjjubhX Entries with rjrj}rj(hgX Entries with hhjjubj)rj}rj(hgX.:attr:`SystemMetadata.dateSysMetadataModified`rjhhjjhijUhkjhm}rj(UreftypeXattrjjX&SystemMetadata.dateSysMetadataModifiedU refdomainXpyrjhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rjj)rj}rj(hgjjhm}rj(ho]hp]rj(jjjXpy-attrrkehq]hr]ht]uhhjjhb]rkhX&SystemMetadata.dateSysMetadataModifiedrkrk}rk(hgUhhjjubahkjubaubhX greater than or equal to (>=) rkrk}rk(hgX greater than or equal to (>=) hhjjubj$)rk}r k(hgX *fromDate*hm}r k(ho]hp]hq]hr]ht]uhhjjhb]r khXfromDater kr k}rk(hgUhhjkubahkj$ubhX] must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.rkrk}rk(hgX] must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjjubehkhubahkj;#ubj#)rk}rk(hgUhm}rk(ho]hp]hq]hr]ht]uhhjjhb]rkh)rk}rk(hgXtoDate (Types.DateTime) -- Entries with SystemMetadata.dateSysMetadataModified less than (<) toDate must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rk(ho]hp]hq]hr]ht]uhhjkhb]rk(j")rk}rk(hgXtoDatehm}rk(hr]hq]j"ho]hp]ht]uhhjkhb]rkhXtoDaterkrk}r k(hgUhhjkubahkj"ubhX (r!kr"k}r#k(hgUhhjkubj)r$k}r%k(hgX:class:`Types.DateTime`r&khhjkhijUhkjhm}r'k(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr(khr]hq]U refexplicitho]hp]ht]jjjNjjUuhvM hb]r)kj)r*k}r+k(hgj&khm}r,k(ho]hp]r-k(jj(kXpy-classr.kehq]hr]ht]uhhj$khb]r/khXTypes.DateTimer0kr1k}r2k(hgUhhj*kubahkjubaubhX)r3k}r4k(hgUhhjkubhX -- r5kr6k}r7k(hgUhhjkubhX Entries with r8kr9k}r:k(hgX Entries with hhjkubj)r;k}rk(UreftypeXattrjjX&SystemMetadata.dateSysMetadataModifiedU refdomainXpyr?khr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]r@kj)rAk}rBk(hgj=khm}rCk(ho]hp]rDk(jj?kXpy-attrrEkehq]hr]ht]uhhj;khb]rFkhX&SystemMetadata.dateSysMetadataModifiedrGkrHk}rIk(hgUhhjAkubahkjubaubhX less than (<) rJkrKk}rLk(hgX less than (<) hhjkubj$)rMk}rNk(hgX*toDate*hm}rOk(ho]hp]hq]hr]ht]uhhjkhb]rPkhXtoDaterQkrRk}rSk(hgUhhjMkubahkj$ubhX\ must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.rTkrUk}rVk(hgX\ must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjkubehkhubahkj;#ubj#)rWk}rXk(hgUhm}rYk(ho]hp]hq]hr]ht]uhhjjhb]rZkh)r[k}r\k(hgXformatId (Types.ObjectFormatIdentifier) -- Restrict results to the specified object format. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r]k(ho]hp]hq]hr]ht]uhhjWkhb]r^k(j")r_k}r`k(hgXformatIdhm}rak(hr]hq]j"ho]hp]ht]uhhj[khb]rbkhXformatIdrckrdk}rek(hgUhhj_kubahkj"ubhX (rfkrgk}rhk(hgUhhj[kubj)rik}rjk(hgX%:class:`Types.ObjectFormatIdentifier`rkkhhj[khijUhkjhm}rlk(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrmkhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvM#hb]rnkj)rok}rpk(hgjkkhm}rqk(ho]hp]rrk(jjmkXpy-classrskehq]hr]ht]uhhjikhb]rtkhXTypes.ObjectFormatIdentifierrukrvk}rwk(hgUhhjokubahkjubaubhX)rxk}ryk(hgUhhj[kubhX -- rzkr{k}r|k(hgUhhj[kubhXzRestrict results to the specified object format. Transmitted as a URL query parameter, and so must be escaped accordingly.r}kr~k}rk(hgXzRestrict results to the specified object format. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj[kubehkhubahkj;#ubj#)rk}rk(hgUhm}rk(ho]hp]hq]hr]ht]uhhjjhb]rkh)rk}rk(hgXidentifier (Types.Identifier) -- Restrict results to the specified identifier. May be either a PID or a SID. If the latter, will return results for each PID in the series. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rk(ho]hp]hq]hr]ht]uhhjkhb]rk(j")rk}rk(hgX identifierhm}rk(hr]hq]j"ho]hp]ht]uhhjkhb]rkhX identifierrkrk}rk(hgUhhjkubahkj"ubhX (rkrk}rk(hgUhhjkubj)rk}rk(hgX:class:`Types.Identifier`rkhhjkhijUhkjhm}rk(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrkhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvM&hb]rkj)rk}rk(hgjkhm}rk(ho]hp]rk(jjkXpy-classrkehq]hr]ht]uhhjkhb]rkhXTypes.Identifierrkrk}rk(hgUhhjkubahkjubaubhX)rk}rk(hgUhhjkubhX -- rkrk}rk(hgUhhjkubhXRestrict results to the specified identifier. May be either a PID or a SID. If the latter, will return results for each PID in the series. Transmitted as a URL query parameter, and so must be escaped accordingly.rkrk}rk(hgXRestrict results to the specified identifier. May be either a PID or a SID. If the latter, will return results for each PID in the series. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjkubehkhubahkj;#ubj#)rk}rk(hgUhm}rk(ho]hp]hq]hr]ht]uhhjjhb]rkh)rk}rk(hgXstart=0 (integer) -- The zero-based index of the first value, relative to the first record of the resultset that matches the parameters. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rk(ho]hp]hq]hr]ht]uhhjkhb]rk(j")rk}rk(hgXstart=0hm}rk(hr]hq]j"ho]hp]ht]uhhjkhb]rkhXstart=0rkrk}rk(hgUhhjkubahkj"ubhX (rkrk}rk(hgUhhjkubj)rk}rk(hgUhm}rk(Ureftypej&j"U reftargetXintegerrkU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjkhb]rkj&)rk}rk(hgjkhm}rk(ho]hp]hq]hr]ht]uhhjkhb]rkhXintegerrkrk}rk(hgUhhjkubahkj&ubahkjubhX)rk}rk(hgUhhjkubhX -- rkrk}rk(hgUhhjkubhXThe zero-based index of the first value, relative to the first record of the resultset that matches the parameters. Transmitted as a URL query parameter, and so must be escaped accordingly.rkrk}rk(hgXThe zero-based index of the first value, relative to the first record of the resultset that matches the parameters. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjkubehkhubahkj;#ubj#)rk}rk(hgUhm}rk(ho]hp]hq]hr]ht]uhhjjhb]rkh)rk}rk(hgX/count=1000 (integer) -- The maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the total in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rk(ho]hp]hq]hr]ht]uhhjkhb]rk(j")rk}rk(hgX count=1000hm}rk(hr]hq]j"ho]hp]ht]uhhjkhb]rkhX count=1000rkrk}rk(hgUhhjkubahkj"ubhX (rkrk}rk(hgUhhjkubj)rk}rk(hgUhm}rk(Ureftypej&j"U reftargetXintegerrkU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjkhb]rkj&)rk}rk(hgjkhm}rk(ho]hp]hq]hr]ht]uhhjkhb]rkhXintegerrkrk}rk(hgUhhjkubahkj&ubahkjubhX)rk}rk(hgUhhjkubhX -- rkrk}rk(hgUhhjkubhXThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the rkrk}rk(hgXThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the hhjkubj$)rk}rk(hgX*total*hm}rk(ho]hp]hq]hr]ht]uhhjkhb]rkhXtotalrkrk}rk(hgUhhjkubahkj$ubhX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.rkrk}rk(hgX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjkubehkhubahkj;#ubj#)rk}rl(hgUhm}rl(ho]hp]hq]hr]ht]uhhjjhb]rlh)rl}rl(hgXnodeId (Types.NodeReference) -- Restrict results to those with authoritativeMemberNode equal to nodeId. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rl(ho]hp]hq]hr]ht]uhhjkhb]rl(j")rl}rl(hgXnodeIdhm}r l(hr]hq]j"ho]hp]ht]uhhjlhb]r lhXnodeIdr lr l}r l(hgUhhjlubahkj"ubhX (rlrl}rl(hgUhhjlubj)rl}rl(hgX:class:`Types.NodeReference`rlhhjlhijUhkjhm}rl(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrlhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvM/hb]rlj)rl}rl(hgjlhm}rl(ho]hp]rl(jjlXpy-classrlehq]hr]ht]uhhjlhb]rlhXTypes.NodeReferencerlrl}rl(hgUhhjlubahkjubaubhX)r l}r!l(hgUhhjlubhX -- r"lr#l}r$l(hgUhhjlubhXRestrict results to those with authoritativeMemberNode equal to nodeId. Transmitted as a URL query parameter, and so must be escaped accordingly.r%lr&l}r'l(hgXRestrict results to those with authoritativeMemberNode equal to nodeId. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjlubehkhubahkj;#ubehkj#ubahkhubehkhubh)r(l}r)l(hgUhm}r*l(ho]hp]hq]hr]ht]uhhjjhb]r+l(h)r,l}r-l(hgXReturnshhj(lhijUhkhhm}r.l(ho]hp]hq]hr]ht]uhvKhb]r/lhXReturnsr0lr1l}r2l(hgUhhj,lubaubh)r3l}r4l(hgUhm}r5l(ho]hp]hq]hr]ht]uhhj(lhb]r6lh)r7l}r8l(hgXYThe list of PIDs that match the query criteria. If none match, an empty list is returned.hm}r9l(ho]hp]hq]hr]ht]uhhj3lhb]r:lhXYThe list of PIDs that match the query criteria. If none match, an empty list is returned.r;lrl}r?l(hgUhm}r@l(ho]hp]hq]hr]ht]uhhjjhb]rAl(h)rBl}rCl(hgX Return typehhj>lhijUhkhhm}rDl(ho]hp]hq]hr]ht]uhvKhb]rElhX Return typerFlrGl}rHl(hgUhhjBlubaubh)rIl}rJl(hgUhm}rKl(ho]hp]hq]hr]ht]uhhj>lhb]rLlh)rMl}rNl(hgXTypes.ObjectListhm}rOl(ho]hp]hq]hr]ht]uhhjIlhb]rPlj)rQl}rRl(hgX:class:`Types.ObjectList`rSlhhjMlhijUhkjhm}rTl(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrUlhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvM2hb]rVlj)rWl}rXl(hgjSlhm}rYl(ho]hp]rZl(jjUlXpy-classr[lehq]hr]ht]uhhjQlhb]r\lhXTypes.ObjectListr]lr^l}r_l(hgUhhjWlubahkjubaubahkhubahkhubehkhubh)r`l}ral(hgUhm}rbl(ho]hp]hq]hr]ht]uhhjjhb]rcl(h)rdl}rel(hgXRaiseshhj`lhijUhkhhm}rfl(ho]hp]hq]hr]ht]uhvKhb]rglhXRaisesrhlril}rjl(hgUhhjdlubaubh)rkl}rll(hgUhm}rml(ho]hp]hq]hr]ht]uhhj`lhb]rnlj #)rol}rpl(hgUhm}rql(ho]hp]hq]hr]ht]uhhjklhb]rrl(j#)rsl}rtl(hgUhm}rul(ho]hp]hq]hr]ht]uhhjolhb]rvlh)rwl}rxl(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1520)hm}ryl(ho]hp]hq]hr]ht]uhhjslhb]rzl(j)r{l}r|l(hgUhm}r}l(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr~lU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjwlhb]rlj")rl}rl(hgj~lhm}rl(ho]hp]hq]hr]ht]uhhj{lhb]rlhXExceptions.NotAuthorizedrlrl}rl(hgUhhjlubahkj"ubahkjubhX -- rlrl}rl(hgUhhjwlubj)rl}rl(hgX$``(errorCode=401, detailCode=1520)``hm}rl(ho]hp]hq]hr]ht]uhhjwlhb]rlhX (errorCode=401, detailCode=1520)rlrl}rl(hgUhhjlubahkjubehkhubahkj;#ubj#)rl}rl(hgUhm}rl(ho]hp]hq]hr]ht]uhhjolhb]rlh)rl}rl(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1540)hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rl(j)rl}rl(hgUhm}rl(Ureftypej#j"U reftargetXExceptions.InvalidRequestrlU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjlhb]rlj")rl}rl(hgjlhm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhXExceptions.InvalidRequestrlrl}rl(hgUhhjlubahkj"ubahkjubhX -- rlrl}rl(hgUhhjlubj)rl}rl(hgX$``(errorCode=400, detailCode=1540)``hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhX (errorCode=400, detailCode=1540)rlrl}rl(hgUhhjlubahkjubehkhubahkj;#ubj#)rl}rl(hgUhm}rl(ho]hp]hq]hr]ht]uhhjolhb]rlh)rl}rl(hgXXExceptions.NotImplemented -- (errorCode=501, detailCode=1560)Raised if some functionality requested is not implemented. In the case of an optional request parameter not being supported, the errorCode should be 400. If the requested format (through HTTP Accept headers) is not supported, then the standard HTTP 406 error code should be returned.hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rl(j)rl}rl(hgUhm}rl(Ureftypej#j"U reftargetXExceptions.NotImplementedrlU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjlhb]rlj")rl}rl(hgjlhm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhXExceptions.NotImplementedrlrl}rl(hgUhhjlubahkj"ubahkjubhX -- rlrl}rl(hgUhhjlubh)rl}rl(hgX$``(errorCode=501, detailCode=1560)``rlhhjlhijUhkhhm}rl(ho]hp]hq]hr]ht]uhvM8hb]rlj)rl}rl(hgjlhm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhX (errorCode=501, detailCode=1560)rlrl}rl(hgUhhjlubahkjubaubh)rl}rl(hgXRaised if some functionality requested is not implemented. In the case of an optional request parameter not being supported, the errorCode should be 400. If the requested format (through HTTP Accept headers) is not supported, then the standard HTTP 406 error code should be returned.rlhhjlhijUhkhhm}rl(ho]hp]hq]hr]ht]uhvM:hb]rlhXRaised if some functionality requested is not implemented. In the case of an optional request parameter not being supported, the errorCode should be 400. If the requested format (through HTTP Accept headers) is not supported, then the standard HTTP 406 error code should be returned.rlrl}rl(hgjlhhjlubaubehkhubahkj;#ubj#)rl}rl(hgUhm}rl(ho]hp]hq]hr]ht]uhhjolhb]rlh)rl}rl(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1580)hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rl(j)rl}rl(hgUhm}rl(Ureftypej#j"U reftargetXExceptions.ServiceFailurerlU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjlhb]rlj")rl}rl(hgjlhm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhXExceptions.ServiceFailurerlrl}rl(hgUhhjlubahkj"ubahkjubhX -- rlrl}rl(hgUhhjlubj)rl}rl(hgX$``(errorCode=500, detailCode=1580)``hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rlhX (errorCode=500, detailCode=1580)rlrl}rl(hgUhhjlubahkjubehkhubahkj;#ubj#)rl}rl(hgUhm}rl(ho]hp]hq]hr]ht]uhhjolhb]rlh)rl}rl(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1530)hm}rl(ho]hp]hq]hr]ht]uhhjlhb]rl(j)rm}rm(hgUhm}rm(Ureftypej#j"U reftargetXExceptions.InvalidTokenrmU refdomainjPihr]hq]U refexplicitho]hp]ht]uhhjlhb]rmj")rm}rm(hgjmhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmhXExceptions.InvalidTokenr mr m}r m(hgUhhjmubahkj"ubahkjubhX -- r mr m}rm(hgUhhjlubj)rm}rm(hgX$``(errorCode=401, detailCode=1530)``hm}rm(ho]hp]hq]hr]ht]uhhjlhb]rmhX (errorCode=401, detailCode=1530)rmrm}rm(hgUhhjmubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rm}rm(hgUhhjUhiNhkjhm}rm(hr]hq]ho]hp]ht]Uentries]rm(jXsearch() (in module CNRead)h+UNtrmauhvNhwhhb]ubj!)rm}rm(hgUhhjUhiNhkj!hm}rm(j"j"Xpyrmhr]hq]ho]hp]ht]j"Xfunctionrmj"jmuhvNhwhhb]r m(j")r!m}r"m(hgX-search(session,queryType,query) -> ObjectListhhjmhijUhkj "hm}r#m(hr]r$mh+aj"jUhq]ho]hp]ht]r%mh+aj"Xsearchr&mj"Uj"uhvMghwhhb]r'm(j")r(m}r)m(hgXCNRead.hhj!mhijUhkj"hm}r*m(ho]hp]hq]hr]ht]uhvMghwhhb]r+mhXCNRead.r,mr-m}r.m(hgUhhj(mubaubj")r/m}r0m(hgj&mhhj!mhijUhkj!"hm}r1m(ho]hp]hq]hr]ht]uhvMghwhhb]r2mhXsearchr3mr4m}r5m(hgUhhj/mubaubj'")r6m}r7m(hgXsession, queryType, queryhhj!mhijUhkj*"hm}r8m(ho]hp]hq]hr]ht]uhvMghwhhb]r9m(j-")r:m}r;m(hgXsessionhm}rmr?m}r@m(hgUhhj:mubahkj5"ubj-")rAm}rBm(hgX queryTypehm}rCm(ho]hp]hq]hr]ht]uhhj6mhb]rDmhX queryTyperEmrFm}rGm(hgUhhjAmubahkj5"ubj-")rHm}rIm(hgXqueryhm}rJm(ho]hp]hq]hr]ht]uhhj6mhb]rKmhXqueryrLmrMm}rNm(hgUhhjHmubahkj5"ubeubj6")rOm}rPm(hgX ObjectListhhj!mhijUhkj9"hm}rQm(ho]hp]hq]hr]ht]uhvMghwhhb]rRmhX ObjectListrSmrTm}rUm(hgUhhjOmubaubeubj?")rVm}rWm(hgUhhjmhijUhkjB"hm}rXm(ho]hp]hq]hr]ht]uhvMghwhhb]rYm(h)rZm}r[m(hgX_Search the metadata catalog and return identifiers of metadata records that match the criteria.r\mhhjVmhijUhkhhm}r]m(ho]hp]hq]hr]ht]uhvMEhwhhb]r^mhX_Search the metadata catalog and return identifiers of metadata records that match the criteria.r_mr`m}ram(hgj\mhhjZmubaubh)rbm}rcm(hgXSearch may be implemented by more than one type of search engine. The queryType parameter indicates which search engine should be targeted. The value and form of *query* is determined by the search engine.hhjVmhijUhkhhm}rdm(ho]hp]hq]hr]ht]uhvMGhwhhb]rem(hXSearch may be implemented by more than one type of search engine. The queryType parameter indicates which search engine should be targeted. The value and form of rfmrgm}rhm(hgXSearch may be implemented by more than one type of search engine. The queryType parameter indicates which search engine should be targeted. The value and form of hhjbmubj$)rim}rjm(hgX*query*hm}rkm(ho]hp]hq]hr]ht]uhhjbmhb]rlmhXqueryrmmrnm}rom(hgUhhjimubahkj$ubhX$ is determined by the search engine.rpmrqm}rrm(hgX$ is determined by the search engine.hhjbmubeubh)rsm}rtm(hgX2Currently supported search engines include: "solr"rumhhjVmhijUhkhhm}rvm(ho]hp]hq]hr]ht]uhvMIhwhhb]rwmhX2Currently supported search engines include: "solr"rxmrym}rzm(hgjumhhjsmubaubh)r{m}r|m(hgUhhjVmhiNhkhhm}r}m(ho]hp]hq]hr]ht]uhvNhwhhb]r~m(h)rm}rm(hgUhhj{mhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMKhwhhb]rm(h)rm}rm(hgXVersionhhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rmhXVersionrmrm}rm(hgUhhjmubaubh)rm}rm(hgX 1.0, (2.0)rmhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmh)rm}rm(hgjmhhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMKhb]rmhX 1.0, (2.0)rmrm}rm(hgjmhhjmubaubahkhubeubh)rm}rm(hgUhhj{mhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMLhwhhb]rm(h)rm}rm(hgX Use CaseshhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rmhX Use Casesrmrm}rm(hgUhhjmubaubh)rm}rm(hgXJ:doc:`UC02 `, :doc:`UC16 `rmhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmh)rm}rm(hgjmhhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMMhb]rm(j)rm}rm(hgX$:doc:`UC02 `rmhhjmhijUhkjhm}rm(UreftypeXdocrmjjX/design/UseCases/02_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMMhb]rmj`2)rm}rm(hgjmhm}rm(ho]hp]rm(jjmehq]hr]ht]uhhjmhb]rmhXUC02rmrm}rm(hgUhhjmubahkji2ubaubhX, rmrm}rm(hgX, hhjmubj)rm}rm(hgX$:doc:`UC16 `rmhhjmhijUhkjhm}rm(UreftypeXdocrmjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMMhb]rmj`2)rm}rm(hgjmhm}rm(ho]hp]rm(jjmehq]hr]ht]uhhjmhb]rmhXUC16rmrm}rm(hgUhhjmubahkji2ubaubeubahkhubeubh)rm}rm(hgUhhj{mhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMNhwhhb]rm(h)rm}rm(hgXREST URLhhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rmhXREST URLrmrm}rm(hgUhhjmubaubh)rm}rm(hgX#``GET /search/{queryType}/{query}``rmhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmh)rm}rm(hgjmhhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvMNhb]rmj)rm}rm(hgjmhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmhXGET /search/{queryType}/{query}rmrm}rm(hgUhhjmubahkjubaubahkhubeubh)rm}rm(hgUhm}rm(ho]hp]hq]hr]ht]uhhj{mhb]rm(h)rm}rm(hgX ParametershhjmhijUhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rmhX Parametersrmrm}rm(hgUhhjmubaubh)rm}rm(hgUhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmj #)rm}rm(hgUhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rm(j#)rm}rm(hgUhm}rm(ho]hp]hq]hr]ht]uhhjmhb]rmh)rm}rm(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rm(ho]hp]hq]hr]ht]uhhjmhb]rm(j")rm}rn(hgXsessionhm}rn(hr]hq]j"ho]hp]ht]uhhjmhb]rnhXsessionrnrn}rn(hgUhhjmubahkj"ubhX (rnrn}rn(hgUhhjmubj)r n}r n(hgX:class:`Types.Session`r nhhjmhijUhkjhm}r n(UreftypeXclassjjX Types.SessionU refdomainXpyr nhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMPhb]rnj)rn}rn(hgj nhm}rn(ho]hp]rn(jj nXpy-classrnehq]hr]ht]uhhj nhb]rnhX Types.Sessionrnrn}rn(hgUhhjnubahkjubaubhX)rn}rn(hgUhhjmubhX -- rnrn}rn(hgUhhjmubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rnrn}rn(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjmubj)r n}r!n(hgX:term:`public user`r"nhhjmhijUhkjhm}r#n(UreftypeXtermjjX public userU refdomainXstdr$nhr]hq]U refexplicitho]hp]ht]jjuhvMOhb]r%nj`2)r&n}r'n(hgj"nhm}r(n(ho]hp]r)n(jj$nXstd-termr*nehq]hr]ht]uhhj nhb]r+nhX public userr,nr-n}r.n(hgUhhj&nubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r/nr0n}r1n(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjmubehkhubahkj;#ubj#)r2n}r3n(hgUhm}r4n(ho]hp]hq]hr]ht]uhhjmhb]r5nh)r6n}r7n(hgXqueryType (string) -- Indicates which search engine will be used to handle the query. Currently supported search engines include: "SOLR". Transmitted as part of the URL path and must be escaped accordingly.hm}r8n(ho]hp]hq]hr]ht]uhhj2nhb]r9n(j")r:n}r;n(hgX queryTypehm}rnr?n}r@n(hgUhhj:nubahkj"ubhX (rAnrBn}rCn(hgUhhj6nubj)rDn}rEn(hgUhm}rFn(Ureftypej&j"U reftargetXstringrGnU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhj6nhb]rHnj&)rIn}rJn(hgjGnhm}rKn(ho]hp]hq]hr]ht]uhhjDnhb]rLnhXstringrMnrNn}rOn(hgUhhjInubahkj&ubahkjubhX)rPn}rQn(hgUhhj6nubhX -- rRnrSn}rTn(hgUhhj6nubhXIndicates which search engine will be used to handle the query. Currently supported search engines include: "SOLR". Transmitted as part of the URL path and must be escaped accordingly.rUnrVn}rWn(hgXIndicates which search engine will be used to handle the query. Currently supported search engines include: "SOLR". Transmitted as part of the URL path and must be escaped accordingly.hhj6nubehkhubahkj;#ubj#)rXn}rYn(hgUhm}rZn(ho]hp]hq]hr]ht]uhhjmhb]r[nh)r\n}r]n(hgXquery (string) -- The remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.hm}r^n(ho]hp]hq]hr]ht]uhhjXnhb]r_n(j")r`n}ran(hgXqueryhm}rbn(hr]hq]j"ho]hp]ht]uhhj\nhb]rcnhXqueryrdnren}rfn(hgUhhj`nubahkj"ubhX (rgnrhn}rin(hgUhhj\nubj)rjn}rkn(hgUhm}rln(Ureftypej&j"U reftargetXstringrmnU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhj\nhb]rnnj&)ron}rpn(hgjmnhm}rqn(ho]hp]hq]hr]ht]uhhjjnhb]rrnhXstringrsnrtn}run(hgUhhjonubahkj&ubahkjubhX)rvn}rwn(hgUhhj\nubhX -- rxnryn}rzn(hgUhhj\nubhXThe remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.r{nr|n}r}n(hgXThe remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.hhj\nubehkhubahkj;#ubehkj#ubahkhubehkhubh)r~n}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhj{mhb]rn(h)rn}rn(hgXReturnshhj~nhijUhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rnhXReturnsrnrn}rn(hgUhhjnubaubh)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhj~nhb]rnh)rn}rn(hgX:A list of objects that match the specified search criteriahm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnhX:A list of objects that match the specified search criteriarnrn}rn(hgX:A list of objects that match the specified search criteriahhjnubahkhubahkhubehkhubh)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhj{mhb]rn(h)rn}rn(hgX Return typehhjnhijUhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rnhX Return typernrn}rn(hgUhhjnubaubh)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnh)rn}rn(hgXTypes.ObjectListhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnj)rn}rn(hgX:class:`Types.ObjectList`rnhhjnhijUhkjhm}rn(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrnhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMYhb]rnj)rn}rn(hgjnhm}rn(ho]hp]rn(jjnXpy-classrnehq]hr]ht]uhhjnhb]rnhXTypes.ObjectListrnrn}rn(hgUhhjnubahkjubaubahkhubahkhubehkhubh)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhj{mhb]rn(h)rn}rn(hgXRaiseshhjnhijUhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rnhXRaisesrnrn}rn(hgUhhjnubaubh)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnj #)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rn(j#)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnh)rn}rn(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4290)hm}rn(ho]hp]hq]hr]ht]uhhjnhb]rn(j)rn}rn(hgUhm}rn(Ureftypej#j"U reftargetXExceptions.InvalidTokenrnU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhjnhb]rnj")rn}rn(hgjnhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnhXExceptions.InvalidTokenrnrn}rn(hgUhhjnubahkj"ubahkjubhX -- rnrn}rn(hgUhhjnubj)rn}rn(hgX$``(errorCode=401, detailCode=4290)``hm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnhX (errorCode=401, detailCode=4290)rnrn}rn(hgUhhjnubahkjubehkhubahkj;#ubj#)rn}rn(hgUhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnh)rn}rn(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4310)hm}rn(ho]hp]hq]hr]ht]uhhjnhb]rn(j)rn}rn(hgUhm}rn(Ureftypej#j"U reftargetXExceptions.ServiceFailurernU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhjnhb]rnj")rn}rn(hgjnhm}rn(ho]hp]hq]hr]ht]uhhjnhb]rnhXExceptions.ServiceFailurernrn}rn(hgUhhjnubahkj"ubahkjubhX -- rnrn}rn(hgUhhjnubj)rn}rn(hgX$``(errorCode=500, detailCode=4310)``hm}ro(ho]hp]hq]hr]ht]uhhjnhb]rohX (errorCode=500, detailCode=4310)roro}ro(hgUhhjnubahkjubehkhubahkj;#ubj#)ro}ro(hgUhm}ro(ho]hp]hq]hr]ht]uhhjnhb]roh)r o}r o(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4280)hm}r o(ho]hp]hq]hr]ht]uhhjohb]r o(j)r o}ro(hgUhm}ro(Ureftypej#j"U reftargetXExceptions.NotAuthorizedroU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhj ohb]roj")ro}ro(hgjohm}ro(ho]hp]hq]hr]ht]uhhj ohb]rohXExceptions.NotAuthorizedroro}ro(hgUhhjoubahkj"ubahkjubhX -- roro}ro(hgUhhj oubj)ro}ro(hgX$``(errorCode=401, detailCode=4280)``hm}ro(ho]hp]hq]hr]ht]uhhj ohb]rohX (errorCode=401, detailCode=4280)r or!o}r"o(hgUhhjoubahkjubehkhubahkj;#ubj#)r#o}r$o(hgUhm}r%o(ho]hp]hq]hr]ht]uhhjnhb]r&oh)r'o}r(o(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4300)hm}r)o(ho]hp]hq]hr]ht]uhhj#ohb]r*o(j)r+o}r,o(hgUhm}r-o(Ureftypej#j"U reftargetXExceptions.InvalidRequestr.oU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhj'ohb]r/oj")r0o}r1o(hgj.ohm}r2o(ho]hp]hq]hr]ht]uhhj+ohb]r3ohXExceptions.InvalidRequestr4or5o}r6o(hgUhhj0oubahkj"ubahkjubhX -- r7or8o}r9o(hgUhhj'oubj)r:o}r;o(hgX$``(errorCode=400, detailCode=4300)``hm}ror?o}r@o(hgUhhj:oubahkjubehkhubahkj;#ubj#)rAo}rBo(hgUhm}rCo(ho]hp]hq]hr]ht]uhhjnhb]rDoh)rEo}rFo(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4281)hm}rGo(ho]hp]hq]hr]ht]uhhjAohb]rHo(j)rIo}rJo(hgUhm}rKo(Ureftypej#j"U reftargetXExceptions.NotImplementedrLoU refdomainjmhr]hq]U refexplicitho]hp]ht]uhhjEohb]rMoj")rNo}rOo(hgjLohm}rPo(ho]hp]hq]hr]ht]uhhjIohb]rQohXExceptions.NotImplementedrRorSo}rTo(hgUhhjNoubahkj"ubahkjubhX -- rUorVo}rWo(hgUhhjEoubj)rXo}rYo(hgX$``(errorCode=501, detailCode=4281)``hm}rZo(ho]hp]hq]hr]ht]uhhjEohb]r[ohX (errorCode=501, detailCode=4281)r\or]o}r^o(hgUhhjXoubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r_o}r`o(hgUhhjUhiNhkjhm}rao(hr]hq]ho]hp]ht]Uentries]rbo(jXquery() (in module CNRead)h5UNtrcoauhvNhwhhb]ubj!)rdo}reo(hgUhhjUhiNhkj!hm}rfo(j"j"Xpyrgohr]hq]ho]hp]ht]j"Xfunctionrhoj"jhouhvNhwhhb]rio(j")rjo}rko(hgX/query(session,queryEngine,query) -> OctetStreamhhjdohijUhkj "hm}rlo(hr]rmoh5aj"jUhq]ho]hp]ht]rnoh5aj"Xqueryrooj"Uj"uhvMhwhhb]rpo(j")rqo}rro(hgXCNRead.hhjjohijUhkj"hm}rso(ho]hp]hq]hr]ht]uhvMhwhhb]rtohXCNRead.ruorvo}rwo(hgUhhjqoubaubj")rxo}ryo(hgjoohhjjohijUhkj!"hm}rzo(ho]hp]hq]hr]ht]uhvMhwhhb]r{ohXqueryr|or}o}r~o(hgUhhjxoubaubj'")ro}ro(hgXsession, queryEngine, queryhhjjohijUhkj*"hm}ro(ho]hp]hq]hr]ht]uhvMhwhhb]ro(j-")ro}ro(hgXsessionhm}ro(ho]hp]hq]hr]ht]uhhjohb]rohXsessionroro}ro(hgUhhjoubahkj5"ubj-")ro}ro(hgX queryEnginehm}ro(ho]hp]hq]hr]ht]uhhjohb]rohX queryEngineroro}ro(hgUhhjoubahkj5"ubj-")ro}ro(hgXqueryhm}ro(ho]hp]hq]hr]ht]uhhjohb]rohXqueryroro}ro(hgUhhjoubahkj5"ubeubj6")ro}ro(hgX OctetStreamhhjjohijUhkj9"hm}ro(ho]hp]hq]hr]ht]uhvMhwhhb]rohX OctetStreamroro}ro(hgUhhjoubaubeubj?")ro}ro(hgUhhjdohijUhkjB"hm}ro(ho]hp]hq]hr]ht]uhvMhwhhb]ro(h)ro}ro(hgXkSubmit a query against the specified *queryEngine* and return the response as formatted by the queryEngine.hhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMjhwhhb]ro(hX%Submit a query against the specified roro}ro(hgX%Submit a query against the specified hhjoubj$)ro}ro(hgX *queryEngine*hm}ro(ho]hp]hq]hr]ht]uhhjohb]rohX queryEngineroro}ro(hgUhhjoubahkj$ubhX9 and return the response as formatted by the queryEngine.roro}ro(hgX9 and return the response as formatted by the queryEngine.hhjoubeubh)ro}ro(hgXThe *query()* operation may be implemented by more than one type of search engine and the *queryEngine* parameter indicates which search engine is targeted. The value and form of *query* is determined by the specific query engine.hhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMlhwhhb]ro(hXThe roro}ro(hgXThe hhjoubj$)ro}ro(hgX *query()*hm}ro(ho]hp]hq]hr]ht]uhhjohb]rohXquery()roro}ro(hgUhhjoubahkj$ubhXM operation may be implemented by more than one type of search engine and the roro}ro(hgXM operation may be implemented by more than one type of search engine and the hhjoubj$)ro}ro(hgX *queryEngine*hm}ro(ho]hp]hq]hr]ht]uhhjohb]rohX queryEngineroro}ro(hgUhhjoubahkj$ubhXL parameter indicates which search engine is targeted. The value and form of roro}ro(hgXL parameter indicates which search engine is targeted. The value and form of hhjoubj$)ro}ro(hgX*query*hm}ro(ho]hp]hq]hr]ht]uhhjohb]rohXqueryroro}ro(hgUhhjoubahkj$ubhX, is determined by the specific query engine.roro}ro(hgX, is determined by the specific query engine.hhjoubeubh)ro}ro(hgXFor example, the solr search engine will accept many of the standard parameters of solr, including field restrictions and faceting.rohhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMnhwhhb]rohXFor example, the solr search engine will accept many of the standard parameters of solr, including field restrictions and faceting.roro}ro(hgjohhjoubaubh)ro}ro(hgXv1.1: This method was added.rohhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMphwhhb]rohXv1.1: This method was added.roro}ro(hgjohhjoubaubh)ro}ro(hgUhhjohiNhkhhm}ro(ho]hp]hq]hr]ht]uhvNhwhhb]ro(h)ro}ro(hgUhhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMrhwhhb]ro(h)ro}ro(hgXVersionhhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvKhb]rohXVersionroro}ro(hgUhhjoubaubh)ro}ro(hgX 1.1, (2.0)rohm}ro(ho]hp]hq]hr]ht]uhhjohb]roh)ro}ro(hgjohhjohijUhkhhm}ro(ho]hp]hq]hr]ht]uhvMrhb]rphX 1.1, (2.0)rprp}rp(hgjohhjoubaubahkhubeubh)rp}rp(hgUhhjohijUhkhhm}rp(ho]hp]hq]hr]ht]uhvMshwhhb]rp(h)rp}r p(hgX Use CaseshhjphijUhkhhm}r p(ho]hp]hq]hr]ht]uhvKhb]r phX Use Casesr pr p}rp(hgUhhjpubaubh)rp}rp(hgXJ:doc:`UC02 `, :doc:`UC16 `rphm}rp(ho]hp]hq]hr]ht]uhhjphb]rph)rp}rp(hgjphhjphijUhkhhm}rp(ho]hp]hq]hr]ht]uhvMthb]rp(j)rp}rp(hgX$:doc:`UC02 `rphhjphijUhkjhm}rp(UreftypeXdocrpjjX/design/UseCases/02_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMthb]rpj`2)rp}rp(hgjphm}r p(ho]hp]r!p(jjpehq]hr]ht]uhhjphb]r"phXUC02r#pr$p}r%p(hgUhhjpubahkji2ubaubhX, r&pr'p}r(p(hgX, hhjpubj)r)p}r*p(hgX$:doc:`UC16 `r+phhjphijUhkjhm}r,p(UreftypeXdocr-pjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvMthb]r.pj`2)r/p}r0p(hgj+phm}r1p(ho]hp]r2p(jj-pehq]hr]ht]uhhj)phb]r3phXUC16r4pr5p}r6p(hgUhhj/pubahkji2ubaubeubahkhubeubh)r7p}r8p(hgUhhjohijUhkhhm}r9p(ho]hp]hq]hr]ht]uhvMuhwhhb]r:p(h)r;p}rphXREST URLr?pr@p}rAp(hgUhhj;pubaubh)rBp}rCp(hgX$``GET /query/{queryEngine}/{query}``rDphm}rEp(ho]hp]hq]hr]ht]uhhj7phb]rFph)rGp}rHp(hgjDphhjBphijUhkhhm}rIp(ho]hp]hq]hr]ht]uhvMuhb]rJpj)rKp}rLp(hgjDphm}rMp(ho]hp]hq]hr]ht]uhhjGphb]rNphX GET /query/{queryEngine}/{query}rOprPp}rQp(hgUhhjKpubahkjubaubahkhubeubh)rRp}rSp(hgUhm}rTp(ho]hp]hq]hr]ht]uhhjohb]rUp(h)rVp}rWp(hgX ParametershhjRphijUhkhhm}rXp(ho]hp]hq]hr]ht]uhvKhb]rYphX ParametersrZpr[p}r\p(hgUhhjVpubaubh)r]p}r^p(hgUhm}r_p(ho]hp]hq]hr]ht]uhhjRphb]r`pj #)rap}rbp(hgUhm}rcp(ho]hp]hq]hr]ht]uhhj]phb]rdp(j#)rep}rfp(hgUhm}rgp(ho]hp]hq]hr]ht]uhhjaphb]rhph)rip}rjp(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rkp(ho]hp]hq]hr]ht]uhhjephb]rlp(j")rmp}rnp(hgXsessionhm}rop(hr]hq]j"ho]hp]ht]uhhjiphb]rpphXsessionrqprrp}rsp(hgUhhjmpubahkj"ubhX (rtprup}rvp(hgUhhjipubj)rwp}rxp(hgX:class:`Types.Session`ryphhjiphijUhkjhm}rzp(UreftypeXclassjjX Types.SessionU refdomainXpyr{phr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMwhb]r|pj)r}p}r~p(hgjyphm}rp(ho]hp]rp(jj{pXpy-classrpehq]hr]ht]uhhjwphb]rphX Types.Sessionrprp}rp(hgUhhj}pubahkjubaubhX)rp}rp(hgUhhjipubhX -- rprp}rp(hgUhhjipubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rprp}rp(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjipubj)rp}rp(hgX:term:`public user`rphhjiphijUhkjhm}rp(UreftypeXtermjjX public userU refdomainXstdrphr]hq]U refexplicitho]hp]ht]jjuhvMvhb]rpj`2)rp}rp(hgjphm}rp(ho]hp]rp(jjpXstd-termrpehq]hr]ht]uhhjphb]rphX public userrprp}rp(hgUhhjpubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rprp}rp(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjipubehkhubahkj;#ubj#)rp}rp(hgUhm}rp(ho]hp]hq]hr]ht]uhhjaphb]rph)rp}rp(hgXqueryEngine (string) -- Indicates which search engine will be used to handle the query. Supported search engines can be determined through the CNRead.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.hm}rp(ho]hp]hq]hr]ht]uhhjphb]rp(j")rp}rp(hgX queryEnginehm}rp(hr]hq]j"ho]hp]ht]uhhjphb]rphX queryEnginerprp}rp(hgUhhjpubahkj"ubhX (rprp}rp(hgUhhjpubj)rp}rp(hgUhm}rp(Ureftypej&j"U reftargetXstringrpU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjphb]rpj&)rp}rp(hgjphm}rp(ho]hp]hq]hr]ht]uhhjphb]rphXstringrprp}rp(hgUhhjpubahkj&ubahkjubhX)rp}rp(hgUhhjpubhX -- rprp}rp(hgUhhjpubhXIndicates which search engine will be used to handle the query. Supported search engines can be determined through the CNRead.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.rprp}rp(hgXIndicates which search engine will be used to handle the query. Supported search engines can be determined through the CNRead.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.hhjpubehkhubahkj;#ubj#)rp}rp(hgUhm}rp(ho]hp]hq]hr]ht]uhhjaphb]rph)rp}rp(hgXquery (string) -- The remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.hm}rp(ho]hp]hq]hr]ht]uhhjphb]rp(j")rp}rp(hgXqueryhm}rp(hr]hq]j"ho]hp]ht]uhhjphb]rphXqueryrprp}rp(hgUhhjpubahkj"ubhX (rprp}rp(hgUhhjpubj)rp}rp(hgUhm}rp(Ureftypej&j"U reftargetXstringrpU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjphb]rpj&)rp}rp(hgjphm}rp(ho]hp]hq]hr]ht]uhhjphb]rphXstringrprp}rp(hgUhhjpubahkj&ubahkjubhX)rp}rp(hgUhhjpubhX -- rprp}rp(hgUhhjpubhXThe remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.rprp}rp(hgXThe remainder of the URL is passed verbatim to the respective search engine implementation. Hence it may contain additional path elements and query elements as determined by the functionality of the search engine. The caller is reponsible for providing a '?' to indicate the start of the query string portion of the URL, as well as proper URL escaping. Transmitted as part of the URL path and must be escaped accordingly.hhjpubehkhubahkj;#ubehkj#ubahkhubehkhubh)rp}rp(hgUhm}rp(ho]hp]hq]hr]ht]uhhjohb]rp(h)rp}rp(hgXReturnshhjphijUhkhhm}rp(ho]hp]hq]hr]ht]uhvKhb]rphXReturnsrprp}rp(hgUhhjpubaubh)rp}rp(hgUhm}rp(ho]hp]hq]hr]ht]uhhjphb]rph)rp}rp(hgXfThe structure of the response is determined by the chosen search engine and parameters provided to it.hm}rp(ho]hp]hq]hr]ht]uhhjphb]rphXfThe structure of the response is determined by the chosen search engine and parameters provided to it.rprq}rq(hgXfThe structure of the response is determined by the chosen search engine and parameters provided to it.hhjpubahkhubahkhubehkhubh)rq}rq(hgUhm}rq(ho]hp]hq]hr]ht]uhhjohb]rq(h)rq}rq(hgX Return typehhjqhijUhkhhm}rq(ho]hp]hq]hr]ht]uhvKhb]r qhX Return typer qr q}r q(hgUhhjqubaubh)r q}rq(hgUhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqh)rq}rq(hgXTypes.OctetStreamhm}rq(ho]hp]hq]hr]ht]uhhj qhb]rqj)rq}rq(hgX:class:`Types.OctetStream`rqhhjqhijUhkjhm}rq(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrqhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rqj)rq}rq(hgjqhm}rq(ho]hp]rq(jjqXpy-classrqehq]hr]ht]uhhjqhb]r qhXTypes.OctetStreamr!qr"q}r#q(hgUhhjqubahkjubaubahkhubahkhubehkhubh)r$q}r%q(hgUhm}r&q(ho]hp]hq]hr]ht]uhhjohb]r'q(h)r(q}r)q(hgXRaiseshhj$qhijUhkhhm}r*q(ho]hp]hq]hr]ht]uhvKhb]r+qhXRaisesr,qr-q}r.q(hgUhhj(qubaubh)r/q}r0q(hgUhm}r1q(ho]hp]hq]hr]ht]uhhj$qhb]r2qj #)r3q}r4q(hgUhm}r5q(ho]hp]hq]hr]ht]uhhj/qhb]r6q(j#)r7q}r8q(hgUhm}r9q(ho]hp]hq]hr]ht]uhhj3qhb]r:qh)r;q}rq(j)r?q}r@q(hgUhm}rAq(Ureftypej#j"U reftargetXExceptions.InvalidTokenrBqU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhj;qhb]rCqj")rDq}rEq(hgjBqhm}rFq(ho]hp]hq]hr]ht]uhhj?qhb]rGqhXExceptions.InvalidTokenrHqrIq}rJq(hgUhhjDqubahkj"ubahkjubhX -- rKqrLq}rMq(hgUhhj;qubj)rNq}rOq(hgX$``(errorCode=401, detailCode=4320)``hm}rPq(ho]hp]hq]hr]ht]uhhj;qhb]rQqhX (errorCode=401, detailCode=4320)rRqrSq}rTq(hgUhhjNqubahkjubehkhubahkj;#ubj#)rUq}rVq(hgUhm}rWq(ho]hp]hq]hr]ht]uhhj3qhb]rXqh)rYq}rZq(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4321)hm}r[q(ho]hp]hq]hr]ht]uhhjUqhb]r\q(j)r]q}r^q(hgUhm}r_q(Ureftypej#j"U reftargetXExceptions.ServiceFailurer`qU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjYqhb]raqj")rbq}rcq(hgj`qhm}rdq(ho]hp]hq]hr]ht]uhhj]qhb]reqhXExceptions.ServiceFailurerfqrgq}rhq(hgUhhjbqubahkj"ubahkjubhX -- riqrjq}rkq(hgUhhjYqubj)rlq}rmq(hgX$``(errorCode=500, detailCode=4321)``hm}rnq(ho]hp]hq]hr]ht]uhhjYqhb]roqhX (errorCode=500, detailCode=4321)rpqrqq}rrq(hgUhhjlqubahkjubehkhubahkj;#ubj#)rsq}rtq(hgUhm}ruq(ho]hp]hq]hr]ht]uhhj3qhb]rvqh)rwq}rxq(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4322)hm}ryq(ho]hp]hq]hr]ht]uhhjsqhb]rzq(j)r{q}r|q(hgUhm}r}q(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr~qU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjwqhb]rqj")rq}rq(hgj~qhm}rq(ho]hp]hq]hr]ht]uhhj{qhb]rqhXExceptions.NotAuthorizedrqrq}rq(hgUhhjqubahkj"ubahkjubhX -- rqrq}rq(hgUhhjwqubj)rq}rq(hgX$``(errorCode=401, detailCode=4322)``hm}rq(ho]hp]hq]hr]ht]uhhjwqhb]rqhX (errorCode=401, detailCode=4322)rqrq}rq(hgUhhjqubahkjubehkhubahkj;#ubj#)rq}rq(hgUhm}rq(ho]hp]hq]hr]ht]uhhj3qhb]rqh)rq}rq(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4323)hm}rq(ho]hp]hq]hr]ht]uhhjqhb]rq(j)rq}rq(hgUhm}rq(Ureftypej#j"U reftargetXExceptions.InvalidRequestrqU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjqhb]rqj")rq}rq(hgjqhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhXExceptions.InvalidRequestrqrq}rq(hgUhhjqubahkj"ubahkjubhX -- rqrq}rq(hgUhhjqubj)rq}rq(hgX$``(errorCode=400, detailCode=4323)``hm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhX (errorCode=400, detailCode=4323)rqrq}rq(hgUhhjqubahkjubehkhubahkj;#ubj#)rq}rq(hgUhm}rq(ho]hp]hq]hr]ht]uhhj3qhb]rqh)rq}rq(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4324)hm}rq(ho]hp]hq]hr]ht]uhhjqhb]rq(j)rq}rq(hgUhm}rq(Ureftypej#j"U reftargetXExceptions.NotImplementedrqU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjqhb]rqj")rq}rq(hgjqhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhXExceptions.NotImplementedrqrq}rq(hgUhhjqubahkj"ubahkjubhX -- rqrq}rq(hgUhhjqubj)rq}rq(hgX$``(errorCode=501, detailCode=4324)``hm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhX (errorCode=501, detailCode=4324)rqrq}rq(hgUhhjqubahkjubehkhubahkj;#ubj#)rq}rq(hgUhm}rq(ho]hp]hq]hr]ht]uhhj3qhb]rqh)rq}rq(hgX_Exceptions.NotFound -- (errorCode=404, detailCode=4325)The specified queryEngine does not existhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rq(j)rq}rq(hgUhm}rq(Ureftypej#j"U reftargetXExceptions.NotFoundrqU refdomainjgohr]hq]U refexplicitho]hp]ht]uhhjqhb]rqj")rq}rq(hgjqhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhXExceptions.NotFoundrqrq}rq(hgUhhjqubahkj"ubahkjubhX -- rqrq}rq(hgUhhjqubh)rq}rq(hgX$``(errorCode=404, detailCode=4325)``rqhhjqhijUhkhhm}rq(ho]hp]hq]hr]ht]uhvMhb]rqj)rq}rq(hgjqhm}rq(ho]hp]hq]hr]ht]uhhjqhb]rqhX (errorCode=404, detailCode=4325)rqrq}rq(hgUhhjqubahkjubaubh)rq}rq(hgX(The specified queryEngine does not existrqhhjqhijUhkhhm}rq(ho]hp]hq]hr]ht]uhvMhb]rqhX(The specified queryEngine does not existrqrq}rq(hgjqhhjqubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rq}rq(hgUhhjUhiNhkjhm}rq(hr]hq]ho]hp]ht]Uentries]rq(jX.getQueryEngineDescription() (in module CNRead)hUNtrqauhvNhwhhb]ubj!)rq}rq(hgUhhjUhiNhkj!hm}rq(j"j"Xpyrrhr]hq]ho]hp]ht]j"Xfunctionrrj"jruhvNhwhhb]rr(j")rr}rr(hgXHgetQueryEngineDescription(session,queryEngine) -> QueryEngineDescriptionhhjqhijUhkj "hm}rr(hr]rrhaj"jUhq]ho]hp]ht]rrhaj"XgetQueryEngineDescriptionrrj"Uj"uhvMhwhhb]r r(j")r r}r r(hgXCNRead.hhjrhijUhkj"hm}r r(ho]hp]hq]hr]ht]uhvMhwhhb]r rhXCNRead.rrrr}rr(hgUhhj rubaubj")rr}rr(hgjrhhjrhijUhkj!"hm}rr(ho]hp]hq]hr]ht]uhvMhwhhb]rrhXgetQueryEngineDescriptionrrrr}rr(hgUhhjrubaubj'")rr}rr(hgXsession, queryEnginehhjrhijUhkj*"hm}rr(ho]hp]hq]hr]ht]uhvMhwhhb]rr(j-")rr}rr(hgXsessionhm}rr(ho]hp]hq]hr]ht]uhhjrhb]rrhXsessionr rr!r}r"r(hgUhhjrubahkj5"ubj-")r#r}r$r(hgX queryEnginehm}r%r(ho]hp]hq]hr]ht]uhhjrhb]r&rhX queryEnginer'rr(r}r)r(hgUhhj#rubahkj5"ubeubj6")r*r}r+r(hgXQueryEngineDescriptionhhjrhijUhkj9"hm}r,r(ho]hp]hq]hr]ht]uhvMhwhhb]r-rhXQueryEngineDescriptionr.rr/r}r0r(hgUhhj*rubaubeubj?")r1r}r2r(hgUhhjqhijUhkjB"hm}r3r(ho]hp]hq]hr]ht]uhvMhwhhb]r4r(h)r5r}r6r(hgXProvides metadata about the query service of the specified *queryEngine*. The metadata provides a brief description of the query engine, its version, its schema version, and an optional list of fields supported by the query engine.hhj1rhijUhkhhm}r7r(ho]hp]hq]hr]ht]uhvMhwhhb]r8r(hX;Provides metadata about the query service of the specified r9rr:r}r;r(hgX;Provides metadata about the query service of the specified hhj5rubj$)rr(ho]hp]hq]hr]ht]uhhj5rhb]r?rhX queryEnginer@rrAr}rBr(hgUhhjs}r?s(hgjsubahkj"ubahkjubhX -- rEsrFs}rGs(hgUhhj5subj)rHs}rIs(hgX$``(errorCode=501, detailCode=4410)``hm}rJs(ho]hp]hq]hr]ht]uhhj5shb]rKshX (errorCode=501, detailCode=4410)rLsrMs}rNs(hgUhhjHsubahkjubehkhubahkj;#ubj#)rOs}rPs(hgUhm}rQs(ho]hp]hq]hr]ht]uhhj-shb]rRsh)rSs}rTs(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4411)hm}rUs(ho]hp]hq]hr]ht]uhhjOshb]rVs(j)rWs}rXs(hgUhm}rYs(Ureftypej#j"U reftargetXExceptions.ServiceFailurerZsU refdomainjrhr]hq]U refexplicitho]hp]ht]uhhjSshb]r[sj")r\s}r]s(hgjZshm}r^s(ho]hp]hq]hr]ht]uhhjWshb]r_shXExceptions.ServiceFailurer`sras}rbs(hgUhhj\subahkj"ubahkjubhX -- rcsrds}res(hgUhhjSsubj)rfs}rgs(hgX$``(errorCode=500, detailCode=4411)``hm}rhs(ho]hp]hq]hr]ht]uhhjSshb]rishX (errorCode=500, detailCode=4411)rjsrks}rls(hgUhhjfsubahkjubehkhubahkj;#ubj#)rms}rns(hgUhm}ros(ho]hp]hq]hr]ht]uhhj-shb]rpsh)rqs}rrs(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4412)hm}rss(ho]hp]hq]hr]ht]uhhjmshb]rts(j)rus}rvs(hgUhm}rws(Ureftypej#j"U reftargetXExceptions.InvalidTokenrxsU refdomainjrhr]hq]U refexplicitho]hp]ht]uhhjqshb]rysj")rzs}r{s(hgjxshm}r|s(ho]hp]hq]hr]ht]uhhjushb]r}shXExceptions.InvalidTokenr~srs}rs(hgUhhjzsubahkj"ubahkjubhX -- rsrs}rs(hgUhhjqsubj)rs}rs(hgX$``(errorCode=401, detailCode=4412)``hm}rs(ho]hp]hq]hr]ht]uhhjqshb]rshX (errorCode=401, detailCode=4412)rsrs}rs(hgUhhjsubahkjubehkhubahkj;#ubj#)rs}rs(hgUhm}rs(ho]hp]hq]hr]ht]uhhj-shb]rsh)rs}rs(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4413)hm}rs(ho]hp]hq]hr]ht]uhhjshb]rs(j)rs}rs(hgUhm}rs(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrsU refdomainjrhr]hq]U refexplicitho]hp]ht]uhhjshb]rsj")rs}rs(hgjshm}rs(ho]hp]hq]hr]ht]uhhjshb]rshXExceptions.NotAuthorizedrsrs}rs(hgUhhjsubahkj"ubahkjubhX -- rsrs}rs(hgUhhjsubj)rs}rs(hgX$``(errorCode=401, detailCode=4413)``hm}rs(ho]hp]hq]hr]ht]uhhjshb]rshX (errorCode=401, detailCode=4413)rsrs}rs(hgUhhjsubahkjubehkhubahkj;#ubj#)rs}rs(hgUhm}rs(ho]hp]hq]hr]ht]uhhj-shb]rsh)rs}rs(hgX_Exceptions.NotFound -- (errorCode=404, detailCode=4414)The specified queryEngine does not existhm}rs(ho]hp]hq]hr]ht]uhhjshb]rs(j)rs}rs(hgUhm}rs(Ureftypej#j"U reftargetXExceptions.NotFoundrsU refdomainjrhr]hq]U refexplicitho]hp]ht]uhhjshb]rsj")rs}rs(hgjshm}rs(ho]hp]hq]hr]ht]uhhjshb]rshXExceptions.NotFoundrsrs}rs(hgUhhjsubahkj"ubahkjubhX -- rsrs}rs(hgUhhjsubh)rs}rs(hgX$``(errorCode=404, detailCode=4414)``rshhjshijUhkhhm}rs(ho]hp]hq]hr]ht]uhvMhb]rsj)rs}rs(hgjshm}rs(ho]hp]hq]hr]ht]uhhjshb]rshX (errorCode=404, detailCode=4414)rsrs}rs(hgUhhjsubahkjubaubh)rs}rs(hgX(The specified queryEngine does not existrshhjshijUhkhhm}rs(ho]hp]hq]hr]ht]uhvMhb]rshX(The specified queryEngine does not existrsrs}rs(hgjshhjsubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rs}rs(hgUhhjUhiNhkjhm}rs(hr]hq]ho]hp]ht]Uentries]rs(jX%listQueryEngines() (in module CNRead)h0UNtrsauhvNhwhhb]ubj!)rs}rs(hgUhhjUhiNhkj!hm}rs(j"j"Xpyrshr]hq]ho]hp]ht]j"Xfunctionrsj"jsuhvNhwhhb]rs(j")rs}rs(hgX,listQueryEngines(session) -> QueryEngineListhhjshijUhkj "hm}rs(hr]rsh0aj"jUhq]ho]hp]ht]rsh0aj"XlistQueryEnginesrsj"Uj"uhvMhwhhb]rs(j")rs}rs(hgXCNRead.hhjshijUhkj"hm}rs(ho]hp]hq]hr]ht]uhvMhwhhb]rshXCNRead.rsrs}rs(hgUhhjsubaubj")rs}rs(hgjshhjshijUhkj!"hm}rs(ho]hp]hq]hr]ht]uhvMhwhhb]rshXlistQueryEnginesrsrs}rs(hgUhhjsubaubj'")rs}rs(hgXsessionhhjshijUhkj*"hm}rs(ho]hp]hq]hr]ht]uhvMhwhhb]rsj-")rs}rs(hgXsessionhm}rs(ho]hp]hq]hr]ht]uhhjshb]rshXsessionrsrs}rs(hgUhhjsubahkj5"ubaubj6")rs}rt(hgXQueryEngineListhhjshijUhkj9"hm}rt(ho]hp]hq]hr]ht]uhvMhwhhb]rthXQueryEngineListrtrt}rt(hgUhhjsubaubeubj?")rt}rt(hgUhhjshijUhkjB"hm}rt(ho]hp]hq]hr]ht]uhvMhwhhb]r t(h)r t}r t(hgXReturns a list of query engines, i.e. supported values for the *queryEngine* parameter of the *getQueryEngineDescription* and *query* operations.hhjthijUhkhhm}r t(ho]hp]hq]hr]ht]uhvMhwhhb]r t(hX?Returns a list of query engines, i.e. supported values for the rtrt}rt(hgX?Returns a list of query engines, i.e. supported values for the hhj tubj$)rt}rt(hgX *queryEngine*hm}rt(ho]hp]hq]hr]ht]uhhj thb]rthX queryEnginertrt}rt(hgUhhjtubahkj$ubhX parameter of the rtrt}rt(hgX parameter of the hhj tubj$)rt}rt(hgX*getQueryEngineDescription*hm}rt(ho]hp]hq]hr]ht]uhhj thb]rthXgetQueryEngineDescriptionrtr t}r!t(hgUhhjtubahkj$ubhX and r"tr#t}r$t(hgX and hhj tubj$)r%t}r&t(hgX*query*hm}r't(ho]hp]hq]hr]ht]uhhj thb]r(thXqueryr)tr*t}r+t(hgUhhj%tubahkj$ubhX operations.r,tr-t}r.t(hgX operations.hhj tubeubh)r/t}r0t(hgXcThe list of search engines available may be influenced by the authentication status of the request.r1thhjthijUhkhhm}r2t(ho]hp]hq]hr]ht]uhvMhwhhb]r3thXcThe list of search engines available may be influenced by the authentication status of the request.r4tr5t}r6t(hgj1thhj/tubaubh)r7t}r8t(hgXv1.1: This method was added.r9thhjthijUhkhhm}r:t(ho]hp]hq]hr]ht]uhvMhwhhb]r;thXv1.1: This method was added.rt(hgj9thhj7tubaubh)r?t}r@t(hgUhhjthiNhkhhm}rAt(ho]hp]hq]hr]ht]uhvNhwhhb]rBt(h)rCt}rDt(hgUhhj?thijUhkhhm}rEt(ho]hp]hq]hr]ht]uhvMhwhhb]rFt(h)rGt}rHt(hgXVersionhhjCthijUhkhhm}rIt(ho]hp]hq]hr]ht]uhvKhb]rJthXVersionrKtrLt}rMt(hgUhhjGtubaubh)rNt}rOt(hgX 1.1, (2.0)rPthm}rQt(ho]hp]hq]hr]ht]uhhjCthb]rRth)rSt}rTt(hgjPthhjNthijUhkhhm}rUt(ho]hp]hq]hr]ht]uhvMhb]rVthX 1.1, (2.0)rWtrXt}rYt(hgjPthhjStubaubahkhubeubh)rZt}r[t(hgUhhj?thijUhkhhm}r\t(ho]hp]hq]hr]ht]uhvMhwhhb]r]t(h)r^t}r_t(hgXREST URLhhjZthijUhkhhm}r`t(ho]hp]hq]hr]ht]uhvKhb]rathXREST URLrbtrct}rdt(hgUhhj^tubaubh)ret}rft(hgX``GET /query``rgthm}rht(ho]hp]hq]hr]ht]uhhjZthb]rith)rjt}rkt(hgjgthhjethijUhkhhm}rlt(ho]hp]hq]hr]ht]uhvMhb]rmtj)rnt}rot(hgjgthm}rpt(ho]hp]hq]hr]ht]uhhjjthb]rqthX GET /queryrrtrst}rtt(hgUhhjntubahkjubaubahkhubeubh)rut}rvt(hgUhm}rwt(ho]hp]hq]hr]ht]uhhj?thb]rxt(h)ryt}rzt(hgX ParametershhjuthijUhkhhm}r{t(ho]hp]hq]hr]ht]uhvKhb]r|thX Parametersr}tr~t}rt(hgUhhjytubaubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjuthb]rth)rt}rt(hgX.session (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate provided with the request. The certificate must be traceable to an authority recognized by DataONE, currently CILogon. Transmitted as part of the SSL handshake process.hm}rt(ho]hp]hq]hr]ht]uhhjthb]rt(j")rt}rt(hgXsessionhm}rt(hr]hq]j"ho]hp]ht]uhhjthb]rthXsessionrtrt}rt(hgUhhjtubahkj"ubhX (rtrt}rt(hgUhhjtubj)rt}rt(hgX:class:`Types.Session`rthhjthijUhkjhm}rt(UreftypeXclassjjX Types.SessionU refdomainXpyrthr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rtj)rt}rt(hgjthm}rt(ho]hp]rt(jjtXpy-classrtehq]hr]ht]uhhjthb]rthX Types.Sessionrtrt}rt(hgUhhjtubahkjubaubhX)rt}rt(hgUhhjtubhX -- rtrt}rt(hgUhhjtubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate provided with the request. The certificate must be traceable to an authority recognized by DataONE, currently CILogon. Transmitted as part of the SSL handshake process.rtrt}rt(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate provided with the request. The certificate must be traceable to an authority recognized by DataONE, currently CILogon. Transmitted as part of the SSL handshake process.hhjtubehkhubahkhubehkhubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhj?thb]rt(h)rt}rt(hgXReturnshhjthijUhkhhm}rt(ho]hp]hq]hr]ht]uhvKhb]rthXReturnsrtrt}rt(hgUhhjtubaubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjthb]rth)rt}rt(hgXLA list of names of queryEngines available to the user identified by session.hm}rt(ho]hp]hq]hr]ht]uhhjthb]rt(hXDA list of names of queryEngines available to the user identified by rtrt}rt(hgXDA list of names of queryEngines available to the user identified by hhjtubj$)rt}rt(hgX *session*hm}rt(ho]hp]hq]hr]ht]uhhjthb]rthXsessionrtrt}rt(hgUhhjtubahkj$ubhX.rt}rt(hgX.hhjtubehkhubahkhubehkhubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhj?thb]rt(h)rt}rt(hgX Return typehhjthijUhkhhm}rt(ho]hp]hq]hr]ht]uhvKhb]rthX Return typertrt}rt(hgUhhjtubaubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjthb]rth)rt}rt(hgXTypes.QueryEngineListhm}rt(ho]hp]hq]hr]ht]uhhjthb]rtj)rt}rt(hgX:class:`Types.QueryEngineList`rthhjthijUhkjhm}rt(UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyrthr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rtj)rt}rt(hgjthm}rt(ho]hp]rt(jjtXpy-classrtehq]hr]ht]uhhjthb]rthXTypes.QueryEngineListrtrt}rt(hgUhhjtubahkjubaubahkhubahkhubehkhubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhj?thb]rt(h)rt}rt(hgXRaiseshhjthijUhkhhm}rt(ho]hp]hq]hr]ht]uhvKhb]rthXRaisesrtrt}rt(hgUhhjtubaubh)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjthb]rtj #)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjthb]rt(j#)rt}rt(hgUhm}rt(ho]hp]hq]hr]ht]uhhjthb]ruh)ru}ru(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4420)hm}ru(ho]hp]hq]hr]ht]uhhjthb]ru(j)ru}ru(hgUhm}ru(Ureftypej#j"U reftargetXExceptions.NotImplementedruU refdomainjshr]hq]U refexplicitho]hp]ht]uhhjuhb]r uj")r u}r u(hgjuhm}r u(ho]hp]hq]hr]ht]uhhjuhb]r uhXExceptions.NotImplementedruru}ru(hgUhhj uubahkj"ubahkjubhX -- ruru}ru(hgUhhjuubj)ru}ru(hgX$``(errorCode=501, detailCode=4420)``hm}ru(ho]hp]hq]hr]ht]uhhjuhb]ruhX (errorCode=501, detailCode=4420)ruru}ru(hgUhhjuubahkjubehkhubahkj;#ubj#)ru}ru(hgUhm}ru(ho]hp]hq]hr]ht]uhhjthb]ruh)ru}r u(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4421)hm}r!u(ho]hp]hq]hr]ht]uhhjuhb]r"u(j)r#u}r$u(hgUhm}r%u(Ureftypej#j"U reftargetXExceptions.ServiceFailurer&uU refdomainjshr]hq]U refexplicitho]hp]ht]uhhjuhb]r'uj")r(u}r)u(hgj&uhm}r*u(ho]hp]hq]hr]ht]uhhj#uhb]r+uhXExceptions.ServiceFailurer,ur-u}r.u(hgUhhj(uubahkj"ubahkjubhX -- r/ur0u}r1u(hgUhhjuubj)r2u}r3u(hgX$``(errorCode=500, detailCode=4421)``hm}r4u(ho]hp]hq]hr]ht]uhhjuhb]r5uhX (errorCode=500, detailCode=4421)r6ur7u}r8u(hgUhhj2uubahkjubehkhubahkj;#ubj#)r9u}r:u(hgUhm}r;u(ho]hp]hq]hr]ht]uhhjthb]ru(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4422)hm}r?u(ho]hp]hq]hr]ht]uhhj9uhb]r@u(j)rAu}rBu(hgUhm}rCu(Ureftypej#j"U reftargetXExceptions.InvalidTokenrDuU refdomainjshr]hq]U refexplicitho]hp]ht]uhhj=uhb]rEuj")rFu}rGu(hgjDuhm}rHu(ho]hp]hq]hr]ht]uhhjAuhb]rIuhXExceptions.InvalidTokenrJurKu}rLu(hgUhhjFuubahkj"ubahkjubhX -- rMurNu}rOu(hgUhhj=uubj)rPu}rQu(hgX$``(errorCode=401, detailCode=4422)``hm}rRu(ho]hp]hq]hr]ht]uhhj=uhb]rSuhX (errorCode=401, detailCode=4422)rTurUu}rVu(hgUhhjPuubahkjubehkhubahkj;#ubj#)rWu}rXu(hgUhm}rYu(ho]hp]hq]hr]ht]uhhjthb]rZuh)r[u}r\u(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4423)hm}r]u(ho]hp]hq]hr]ht]uhhjWuhb]r^u(j)r_u}r`u(hgUhm}rau(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrbuU refdomainjshr]hq]U refexplicitho]hp]ht]uhhj[uhb]rcuj")rdu}reu(hgjbuhm}rfu(ho]hp]hq]hr]ht]uhhj_uhb]rguhXExceptions.NotAuthorizedrhuriu}rju(hgUhhjduubahkj"ubahkjubhX -- rkurlu}rmu(hgUhhj[uubj)rnu}rou(hgX$``(errorCode=401, detailCode=4423)``hm}rpu(ho]hp]hq]hr]ht]uhhj[uhb]rquhX (errorCode=401, detailCode=4423)rrursu}rtu(hgUhhjnuubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)ruu}rvu(hgUhhjUhiNhkjhm}rwu(hr]hq]ho]hp]ht]Uentries]rxu(jX synchronize() (in module CNRead)hAUNtryuauhvNhwhhb]ubj!)rzu}r{u(hgUhhjUhiNhkj!hm}r|u(j"j"Xpyr}uhr]hq]ho]hp]ht]j"Xfunctionr~uj"j~uuhvNhwhhb]ru(j")ru}ru(hgX#synchronize(session,pid) -> booleanhhjzuhiXAinternal padding after source/apis/generated/generated_CNRead.txtruhkj "hm}ru(hr]ruhAaj"jUhq]ho]hp]ht]ruhAaj"X synchronizeruj"Uj"uhvMhwhhb]ru(j")ru}ru(hgXCNRead.hhjuhijuhkj"hm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhXCNRead.ruru}ru(hgUhhjuubaubj")ru}ru(hgjuhhjuhijuhkj!"hm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhX synchronizeruru}ru(hgUhhjuubaubj'")ru}ru(hgX session, pidhhjuhijuhkj*"hm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ru(j-")ru}ru(hgXsessionhm}ru(ho]hp]hq]hr]ht]uhhjuhb]ruhXsessionruru}ru(hgUhhjuubahkj5"ubj-")ru}ru(hgXpidhm}ru(ho]hp]hq]hr]ht]uhhjuhb]ruhXpidruru}ru(hgUhhjuubahkj5"ubeubj6")ru}ru(hgXbooleanhhjuhijuhkj9"hm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhXbooleanruru}ru(hgUhhjuubaubeubj?")ru}ru(hgUhhjzuhijuhkjB"hm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ru(h)ru}ru(hgXIndicates to the CN that a new or existing object identified by PID requires synchronization. Note that this operation is asynchronous, a successful return indicates that the synchronization task was successfully queued.ruhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhXIndicates to the CN that a new or existing object identified by PID requires synchronization. Note that this operation is asynchronous, a successful return indicates that the synchronization task was successfully queued.ruru}ru(hgjuhhjuubaubh)ru}ru(hgX~This method may be called by any Member Node for new content or the authoritative Member Node for updates to existing content.ruhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhX~This method may be called by any Member Node for new content or the authoritative Member Node for updates to existing content.ruru}ru(hgjuhhjuubaubh)ru}ru(hgXThe CN will schedule the synchronization task which will then be processed in the same way as content changes identified through the listObjects polling mechanism.ruhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhXThe CN will schedule the synchronization task which will then be processed in the same way as content changes identified through the listObjects polling mechanism.ruru}ru(hgjuhhjuubaubh)ru}ru(hgX3v2.0: This method was added to the Version 2.0 API.ruhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ruhX3v2.0: This method was added to the Version 2.0 API.ruru}ru(hgjuhhjuubaubh)ru}ru(hgUhhjuhiNhkhhm}ru(ho]hp]hq]hr]ht]uhvNhwhhb]ru(h)ru}ru(hgUhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ru(h)ru}ru(hgXVersionhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvKhb]ruhXVersionruru}ru(hgUhhjuubaubh)ru}ru(hgX2.0ruhm}ru(ho]hp]hq]hr]ht]uhhjuhb]ruh)ru}ru(hgjuhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhb]ruhX2.0ruru}ru(hgjuhhjuubaubahkhubeubh)ru}ru(hgUhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvMhwhhb]ru(h)ru}ru(hgXREST URLhhjuhijUhkhhm}ru(ho]hp]hq]hr]ht]uhvKhb]ruhXREST URLruru}ru(hgUhhjuubaubh)ru}ru(hgX``POST /synchronize``ruhm}ru(ho]hp]hq]hr]ht]uhhjuhb]ruh)ru}ru(hgjuhhjuhijUhkhhm}rv(ho]hp]hq]hr]ht]uhvMhb]rvj)rv}rv(hgjuhm}rv(ho]hp]hq]hr]ht]uhhjuhb]rvhXPOST /synchronizervrv}rv(hgUhhjvubahkjubaubahkhubeubh)r v}r v(hgUhm}r v(ho]hp]hq]hr]ht]uhhjuhb]r v(h)r v}rv(hgX Parametershhj vhijuhkhhm}rv(ho]hp]hq]hr]ht]uhvKhb]rvhX Parametersrvrv}rv(hgUhhj vubaubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhj vhb]rvj #)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rv(j#)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvh)r v}r!v(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r"v(ho]hp]hq]hr]ht]uhhjvhb]r#v(j")r$v}r%v(hgXsessionhm}r&v(hr]hq]j"ho]hp]ht]uhhj vhb]r'vhXsessionr(vr)v}r*v(hgUhhj$vubahkj"ubhX (r+vr,v}r-v(hgUhhj vubj)r.v}r/v(hgX:class:`Types.Session`r0vhhj vhijUhkjhm}r1v(UreftypeXclassjjX Types.SessionU refdomainXpyr2vhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]r3vj)r4v}r5v(hgj0vhm}r6v(ho]hp]r7v(jj2vXpy-classr8vehq]hr]ht]uhhj.vhb]r9vhX Types.Sessionr:vr;v}rv(hgUhhj vubhX -- r?vr@v}rAv(hgUhhj vubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rBvrCv}rDv(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj vubj)rEv}rFv(hgX:term:`public user`rGvhhj vhijUhkjhm}rHv(UreftypeXtermjjX public userU refdomainXstdrIvhr]hq]U refexplicitho]hp]ht]jjuhvMhb]rJvj`2)rKv}rLv(hgjGvhm}rMv(ho]hp]rNv(jjIvXstd-termrOvehq]hr]ht]uhhjEvhb]rPvhX public userrQvrRv}rSv(hgUhhjKvubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rTvrUv}rVv(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj vubehkhubahkj;#ubj#)rWv}rXv(hgUhm}rYv(ho]hp]hq]hr]ht]uhhjvhb]rZvh)r[v}r\v(hgXlpid (Types.Identifier) -- Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r]v(ho]hp]hq]hr]ht]uhhjWvhb]r^v(j")r_v}r`v(hgXpidhm}rav(hr]hq]j"ho]hp]ht]uhhj[vhb]rbvhXpidrcvrdv}rev(hgUhhj_vubahkj"ubhX (rfvrgv}rhv(hgUhhj[vubj)riv}rjv(hgX:class:`Types.Identifier`rkvhhj[vhijUhkjhm}rlv(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrmvhr]hq]U refexplicitho]hp]ht]jjjNjjUuhvMhb]rnvj)rov}rpv(hgjkvhm}rqv(ho]hp]rrv(jjmvXpy-classrsvehq]hr]ht]uhhjivhb]rtvhXTypes.Identifierruvrvv}rwv(hgUhhjovubahkjubaubhX)rxv}ryv(hgUhhj[vubhX -- rzvr{v}r|v(hgUhhj[vubhX#Transmitted as a UTF-8 String as a r}vr~v}rv(hgX#Transmitted as a UTF-8 String as a hhj[vubj$)rv}rv(hgX *Param part*hm}rv(ho]hp]hq]hr]ht]uhhj[vhb]rvhX Param partrvrv}rv(hgUhhjvubahkj$ubhX% of the MIME multipart/mixed message.rvrv}rv(hgX% of the MIME multipart/mixed message.hhj[vubehkhubahkj;#ubehkj#ubahkhubehkhubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjuhb]rv(h)rv}rv(hgXReturnshhjvhijuhkhhm}rv(ho]hp]hq]hr]ht]uhvKhb]rvhXReturnsrvrv}rv(hgUhhjvubaubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvh)rv}rv(hgXLTrue if the synchronization request was successfully queued, otherwise Falsehm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvhXLTrue if the synchronization request was successfully queued, otherwise Falservrv}rv(hgXLTrue if the synchronization request was successfully queued, otherwise Falsehhjvubahkhubahkhubehkhubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjuhb]rv(h)rv}rv(hgX Return typehhjvhijuhkhhm}rv(ho]hp]hq]hr]ht]uhvKhb]rvhX Return typervrv}rv(hgUhhjvubaubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvh)rv}rv(hgXbooleanhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvj)rv}rv(hgUhm}rv(Ureftypej&j"U reftargetXbooleanU refdomainj}uhr]hq]U refexplicitho]hp]ht]uhhjvhb]rvhXbooleanrvrv}rv(hgUhhjvubahkjubahkhubahkhubehkhubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjuhb]rv(h)rv}rv(hgXRaiseshhjvhijuhkhhm}rv(ho]hp]hq]hr]ht]uhvKhb]rvhXRaisesrvrv}rv(hgUhhjvubaubh)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvj #)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rv(j#)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvh)rv}rv(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4960)hm}rv(ho]hp]hq]hr]ht]uhhjvhb]rv(j)rv}rv(hgUhm}rv(Ureftypej#j"U reftargetXExceptions.NotImplementedrvU refdomainj}uhr]hq]U refexplicitho]hp]ht]uhhjvhb]rvj")rv}rv(hgjvhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvhXExceptions.NotImplementedrvrv}rv(hgUhhjvubahkj"ubahkjubhX -- rvrv}rv(hgUhhjvubj)rv}rv(hgX$``(errorCode=501, detailCode=4960)``hm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvhX (errorCode=501, detailCode=4960)rvrv}rv(hgUhhjvubahkjubehkhubahkj;#ubj#)rv}rv(hgUhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvh)rv}rv(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4961)hm}rv(ho]hp]hq]hr]ht]uhhjvhb]rv(j)rv}rv(hgUhm}rv(Ureftypej#j"U reftargetXExceptions.ServiceFailurervU refdomainj}uhr]hq]U refexplicitho]hp]ht]uhhjvhb]rvj")rv}rv(hgjvhm}rv(ho]hp]hq]hr]ht]uhhjvhb]rvhXExceptions.ServiceFailurervrv}rv(hgUhhjvubahkj"ubahkjubhX -- rvrw}rw(hgUhhjvubj)rw}rw(hgX$``(errorCode=500, detailCode=4961)``hm}rw(ho]hp]hq]hr]ht]uhhjvhb]rwhX (errorCode=500, detailCode=4961)rwrw}rw(hgUhhjwubahkjubehkhubahkj;#ubj#)r w}r w(hgUhm}r w(ho]hp]hq]hr]ht]uhhjvhb]r wh)r w}rw(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4962)hm}rw(ho]hp]hq]hr]ht]uhhj whb]rw(j)rw}rw(hgUhm}rw(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrwU refdomainj}uhr]hq]U refexplicitho]hp]ht]uhhj whb]rwj")rw}rw(hgjwhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwhXExceptions.NotAuthorizedrwrw}rw(hgUhhjwubahkj"ubahkjubhX -- rwrw}rw(hgUhhj wubj)r w}r!w(hgX$``(errorCode=401, detailCode=4962)``hm}r"w(ho]hp]hq]hr]ht]uhhj whb]r#whX (errorCode=401, detailCode=4962)r$wr%w}r&w(hgUhhj wubahkjubehkhubahkj;#ubj#)r'w}r(w(hgUhm}r)w(ho]hp]hq]hr]ht]uhhjvhb]r*wh)r+w}r,w(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4963)hm}r-w(ho]hp]hq]hr]ht]uhhj'whb]r.w(j)r/w}r0w(hgUhm}r1w(Ureftypej#j"U reftargetXExceptions.InvalidTokenr2wU refdomainj}uhr]hq]U refexplicitho]hp]ht]uhhj+whb]r3wj")r4w}r5w(hgj2whm}r6w(ho]hp]hq]hr]ht]uhhj/whb]r7whXExceptions.InvalidTokenr8wr9w}r:w(hgUhhj4wubahkj"ubahkjubhX -- r;wrw}r?w(hgX$``(errorCode=401, detailCode=4963)``hm}r@w(ho]hp]hq]hr]ht]uhhj+whb]rAwhX (errorCode=401, detailCode=4963)rBwrCw}rDw(hgUhhj>wubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubeubhd)rEw}rFw(hgUhhhehihjhkhlhm}rGw(ho]hp]hq]hr]rHw(X module-CNViewrIwhYeht]rJwh!auhvKMhwhhb]rKw(hy)rLw}rMw(hgXView APIrNwhhjEwhihjhkh}hm}rOw(ho]hp]hq]hr]ht]uhvKMhwhhb]rPwhXView APIrQwrRw}rSw(hgjNwhhjLwubaubj)rTw}rUw(hgUhhjEwhihjhkjhm}rVw(hr]hq]ho]hp]ht]Uentries]rWw(jXCNView (module)X module-CNViewUNtrXwauhvNhwhhb]ubh)rYw}rZw(hgXmThe *CNView* API implements methods that enable viewing content on a :term:`Coordinating Node`. Like the MNView service, the CNView service provides a transformed view of a metadata file, data file, or package. The CNView service provides a default view for all content, and may choose to redirect a review request to the authoritative Member Node for a given PID.hhjEwhihjhkhhm}r[w(ho]hp]hq]hr]ht]uhvKRhwhhb]r\w(hXThe r]wr^w}r_w(hgXThe hhjYwubj$)r`w}raw(hgX*CNView*hm}rbw(ho]hp]hq]hr]ht]uhhjYwhb]rcwhXCNViewrdwrew}rfw(hgUhhj`wubahkj$ubhX9 API implements methods that enable viewing content on a rgwrhw}riw(hgX9 API implements methods that enable viewing content on a hhjYwubj)rjw}rkw(hgX:term:`Coordinating Node`rlwhhjYwhihjhkjhm}rmw(UreftypeXtermjjXcoordinating nodeU refdomainXstdrnwhr]hq]U refexplicitho]hp]ht]jjuhvKRhb]rowj`2)rpw}rqw(hgjlwhm}rrw(ho]hp]rsw(jjnwXstd-termrtwehq]hr]ht]uhhjjwhb]ruwhXCoordinating Nodervwrww}rxw(hgUhhjpwubahkji2ubaubhX. Like the MNView service, the CNView service provides a transformed view of a metadata file, data file, or package. The CNView service provides a default view for all content, and may choose to redirect a review request to the authoritative Member Node for a given PID.rywrzw}r{w(hgX. Like the MNView service, the CNView service provides a transformed view of a metadata file, data file, or package. The CNView service provides a default view for all content, and may choose to redirect a review request to the authoritative Member Node for a given PID.hhjYwubeubj)r|w}r}w(hgXBWarning: this file is automatically generated. Edits will be losthhjEwhijX*source/apis/generated/generated_CNView.txtr~wrw}rwbhkj!hm}rw(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]rwhXBWarning: this file is automatically generated. Edits will be lostrwrw}rw(hgUhhj|wubaubj))rw}rw(hgUhhjEwhiNhkj,hm}rw(ho]hp]hq]hr]rwUid5rwaht]uhvNhwhhb]rw(hy)rw}rw(hgX"Functions defined in :mod:`CNView`hm}rw(ho]hp]hq]hr]ht]uhhjwhb]rw(hXFunctions defined in rwrw}rw(hgXFunctions defined in hhjwubj)rw}rw(hgX :mod:`CNView`rwhhjwhijwhkjhm}rw(UreftypeXmodjjXCNViewU refdomainXpyrwhr]hq]U refexplicitho]hp]ht]jjjNjXCNViewrwuhvKhb]rwj)rw}rw(hgjwhm}rw(ho]hp]rw(jjwXpy-modrwehq]hr]ht]uhhjwhb]rwhXCNViewrwrw}rw(hgUhhjwubahkjubaubehkh}ubj9)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolsKuhhjwhb]rw(j>)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolwidthKuhhjwhb]hkjBubj>)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolwidthKuhhjwhb]hkjBubj>)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolwidthK uhhjwhb]hkjBubj>)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolwidthK uhhjwhb]hkjBubj>)rw}rw(hgUhm}rw(hr]hq]ho]hp]ht]UcolwidthKuhhjwhb]hkjBubjO)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwjT)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rw(jY)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwh)rw}rw(hgXTierrwhhjwhijwhkhhm}rw(ho]hp]hq]hr]ht]uhvK hb]rwhXTierrwrw}rw(hgjwhhjwubaubahkjfubjY)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwh)rw}rw(hgXVersionrwhhjwhijwhkhhm}rw(ho]hp]hq]hr]ht]uhvK hb]rwhXVersionrwrw}rw(hgjwhhjwubaubahkjfubjY)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwh)rw}rw(hgXRESTrwhhjwhijwhkhhm}rw(ho]hp]hq]hr]ht]uhvK hb]rwhXRESTrwrw}rw(hgjwhhjwubaubahkjfubjY)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwh)rw}rw(hgXFunctionrwhhjwhijwhkhhm}rw(ho]hp]hq]hr]ht]uhvK hb]rwhXFunctionrwrw}rw(hgjwhhjwubaubahkjfubjY)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rwh)rw}rw(hgX Parametersrwhhjwhijwhkhhm}rw(ho]hp]hq]hr]ht]uhvK hb]rwhX Parametersrwrw}rw(hgjwhhjwubaubahkjfubehkjubahkjubj)rw}rw(hgUhm}rw(ho]hp]hq]hr]ht]uhhjwhb]rw(jT)rw}rw(hgUhm}rx(ho]hp]hq]hr]ht]uhhjwhb]rx(jY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjwhb]rxh)rx}rx(hgXTier 1rxhhjxhijwhkhhm}r x(ho]hp]hq]hr]ht]uhvKhb]r xhXTier 1r xr x}r x(hgjxhhjxubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjwhb]rxh)rx}rx(hgX2.0rxhhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rxhX2.0rxrx}rx(hgjxhhjxubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjwhb]rxh)rx}rx(hgX``GET /views/{theme}/{id}``r xhhjxhijwhkhhm}r!x(ho]hp]hq]hr]ht]uhvKhb]r"xj)r#x}r$x(hgj xhm}r%x(ho]hp]hq]hr]ht]uhhjxhb]r&xhXGET /views/{theme}/{id}r'xr(x}r)x(hgUhhj#xubahkjubaubahkjfubjY)r*x}r+x(hgUhm}r,x(ho]hp]hq]hr]ht]uhhjwhb]r-xh)r.x}r/x(hgX :func:`view`r0xhhj*xhijwhkhhm}r1x(ho]hp]hq]hr]ht]uhvKhb]r2xj)r3x}r4x(hgj0xhhj.xhijwhkjhm}r5x(UreftypeXfuncjjXviewU refdomainXpyr6xhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]r7xj)r8x}r9x(hgj0xhm}r:x(ho]hp]r;x(jj6xXpy-funcrxr?x}r@x(hgUhhj8xubahkjubaubaubahkjfubjY)rAx}rBx(hgUhm}rCx(ho]hp]hq]hr]ht]uhhjwhb]rDxh)rEx}rFx(hgXm(:class:`session`, ``theme``, :class:`id`) ``->`` :class:`Types.OctetStream`hhjAxhijwhkhhm}rGx(ho]hp]hq]hr]ht]uhvKhb]rHx(hX(rIx}rJx(hgX(hhjExubj)rKx}rLx(hgX:class:`session`rMxhhjExhijwhkjhm}rNx(UreftypeXclassjjX Types.SessionU refdomainXpyrOxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rPxj)rQx}rRx(hgjMxhm}rSx(ho]hp]rTx(jjOxXpy-classrUxehq]hr]ht]uhhjKxhb]rVxhXsessionrWxrXx}rYx(hgUhhjQxubahkjubaubhX, rZxr[x}r\x(hgX, hhjExubj)r]x}r^x(hgX ``theme``hm}r_x(ho]hp]hq]hr]ht]uhhjExhb]r`xhXthemeraxrbx}rcx(hgUhhj]xubahkjubhX, rdxrex}rfx(hgX, hhjExubj)rgx}rhx(hgX:class:`id`rixhhjExhijwhkjhm}rjx(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrkxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rlxj)rmx}rnx(hgjixhm}rox(ho]hp]rpx(jjkxXpy-classrqxehq]hr]ht]uhhjgxhb]rrxhXidrsxrtx}rux(hgUhhjmxubahkjubaubhX) rvxrwx}rxx(hgX) hhjExubj)ryx}rzx(hgX``->``hm}r{x(ho]hp]hq]hr]ht]uhhjExhb]r|xhX->r}xr~x}rx(hgUhhjyxubahkjubhX rx}rx(hgX hhjExubj)rx}rx(hgX:class:`Types.OctetStream`rxhhjExhijwhkjhm}rx(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rxj)rx}rx(hgjxhm}rx(ho]hp]rx(jjxXpy-classrxehq]hr]ht]uhhjxhb]rxhXTypes.OctetStreamrxrx}rx(hgUhhjxubahkjubaubeubahkjfubehkjubjT)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjwhb]rx(jY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxh)rx}rx(hgXTier 1rxhhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rxhXTier 1rxrx}rx(hgjxhhjxubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxh)rx}rx(hgX2.0rxhhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rxhX2.0rxrx}rx(hgjxhhjxubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxh)rx}rx(hgX``GET /views``rxhhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rxj)rx}rx(hgjxhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxhX GET /viewsrxrx}rx(hgUhhjxubahkjubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxh)rx}rx(hgX:func:`listViews`rxhhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rxj)rx}rx(hgjxhhjxhijwhkjhm}rx(UreftypeXfuncjjX listViewsU refdomainXpyrxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rxj)rx}rx(hgjxhm}rx(ho]hp]rx(jjxXpy-funcrxehq]hr]ht]uhhjxhb]rxhX listViews()rxrx}rx(hgUhhjxubahkjubaubaubahkjfubjY)rx}rx(hgUhm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxh)rx}rx(hgXB(:class:`session`) ``->`` :class:`Types.OptionList`hhjxhijwhkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]rx(hX(rx}rx(hgX(hhjxubj)rx}rx(hgX:class:`session`rxhhjxhijwhkjhm}rx(UreftypeXclassjjX Types.SessionU refdomainXpyrxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rxj)rx}rx(hgjxhm}rx(ho]hp]rx(jjxXpy-classrxehq]hr]ht]uhhjxhb]rxhXsessionrxrx}rx(hgUhhjxubahkjubaubhX) rxrx}rx(hgX) hhjxubj)rx}rx(hgX``->``hm}rx(ho]hp]hq]hr]ht]uhhjxhb]rxhX->rxrx}rx(hgUhhjxubahkjubhX rx}rx(hgX hhjxubj)rx}rx(hgX:class:`Types.OptionList`rxhhjxhijwhkjhm}rx(UreftypeXclassjjXTypes.OptionListU refdomainXpyrxhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKhb]rxj)rx}ry(hgjxhm}ry(ho]hp]ry(jjxXpy-classryehq]hr]ht]uhhjxhb]ryhXTypes.OptionListryry}ry(hgUhhjxubahkjubaubeubahkjfubehkjubehkjubehkjubeubj)ry}r y(hgUhhjEwhiNhkjhm}r y(hr]hq]ho]hp]ht]Uentries]r y(jXview() (in module CNView)hUNtr yauhvNhwhhb]ubj!)r y}ry(hgUhhjEwhiNhkj!hm}ry(j"j"Xpyryhr]hq]ho]hp]ht]j"Xfunctionryj"jyuhvNhwhhb]ry(j")ry}ry(hgX%view(session,theme,id) -> OctetStreamhhj yhijwhkj "hm}ry(hr]ryhaj"jwhq]ho]hp]ht]ryhaj"Xviewryj"Uj"uhvKDhwhhb]ry(j")ry}ry(hgXCNView.hhjyhijwhkj"hm}ry(ho]hp]hq]hr]ht]uhvKDhwhhb]ryhXCNView.ryry}r y(hgUhhjyubaubj")r!y}r"y(hgjyhhjyhijwhkj!"hm}r#y(ho]hp]hq]hr]ht]uhvKDhwhhb]r$yhXviewr%yr&y}r'y(hgUhhj!yubaubj'")r(y}r)y(hgXsession, theme, idhhjyhijwhkj*"hm}r*y(ho]hp]hq]hr]ht]uhvKDhwhhb]r+y(j-")r,y}r-y(hgXsessionhm}r.y(ho]hp]hq]hr]ht]uhhj(yhb]r/yhXsessionr0yr1y}r2y(hgUhhj,yubahkj5"ubj-")r3y}r4y(hgXthemehm}r5y(ho]hp]hq]hr]ht]uhhj(yhb]r6yhXthemer7yr8y}r9y(hgUhhj3yubahkj5"ubj-")r:y}r;y(hgXidhm}ryr?y}r@y(hgUhhj:yubahkj5"ubeubj6")rAy}rBy(hgX OctetStreamhhjyhijwhkj9"hm}rCy(ho]hp]hq]hr]ht]uhvKDhwhhb]rDyhX OctetStreamrEyrFy}rGy(hgUhhjAyubaubeubj?")rHy}rIy(hgUhhj yhijwhkjB"hm}rJy(ho]hp]hq]hr]ht]uhvKDhwhhb]rKy(h)rLy}rMy(hgXpProvides a formatted view of an object (science metadata, data, resource, or other) using the given named theme.rNyhhjHyhijwhkhhm}rOy(ho]hp]hq]hr]ht]uhvKhwhhb]rPyhXpProvides a formatted view of an object (science metadata, data, resource, or other) using the given named theme.rQyrRy}rSy(hgjNyhhjLyubaubh)rTy}rUy(hgXvThe service :func:`CNView.view` operation will implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format. In addition, a CN may redirect a client to the view service of the authoritative Member Node for a PID if that node has implemented the :func:`MNView.view` service and implements a compatible theme.hhjHyhijwhkhhm}rVy(ho]hp]hq]hr]ht]uhvK hwhhb]rWy(hX The service rXyrYy}rZy(hgX The service hhjTyubj)r[y}r\y(hgX:func:`CNView.view`r]yhhjTyhijwhkjhm}r^y(UreftypeXfuncjjX CNView.viewU refdomainXpyr_yhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvK hb]r`yj)ray}rby(hgj]yhm}rcy(ho]hp]rdy(jj_yXpy-funcreyehq]hr]ht]uhhj[yhb]rfyhX CNView.view()rgyrhy}riy(hgUhhjayubahkjubaubhX operation will implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format. In addition, a CN may redirect a client to the view service of the authoritative Member Node for a PID if that node has implemented the rjyrky}rly(hgX operation will implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format. In addition, a CN may redirect a client to the view service of the authoritative Member Node for a PID if that node has implemented the hhjTyubj)rmy}rny(hgX:func:`MNView.view`royhhjTyhijwhkjhm}rpy(UreftypeXfuncjjX MNView.viewU refdomainXpyrqyhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvK hb]rryj)rsy}rty(hgjoyhm}ruy(ho]hp]rvy(jjqyXpy-funcrwyehq]hr]ht]uhhjmyhb]rxyhX MNView.view()ryyrzy}r{y(hgUhhjsyubahkjubaubhX+ service and implements a compatible theme.r|yr}y}r~y(hgX+ service and implements a compatible theme.hhjTyubeubh)ry}ry(hgXhIf the {theme} parameter is not recognized, the service must render the object using the default theme rather than throwing an error. Note that the return type of Types.OctetStream requires that the consuming client has a priori knowledge of the theme being returned (like HTML). Response headers must include the correct mime-type of the view being returned.ryhhjHyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK"hwhhb]ryhXhIf the {theme} parameter is not recognized, the service must render the object using the default theme rather than throwing an error. Note that the return type of Types.OctetStream requires that the consuming client has a priori knowledge of the theme being returned (like HTML). Response headers must include the correct mime-type of the view being returned.ryry}ry(hgjyhhjyubaubh)ry}ry(hgX3v2.0: This method was added to the Version 2.0 API.ryhhjHyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK$hwhhb]ryhX3v2.0: This method was added to the Version 2.0 API.ryry}ry(hgjyhhjyubaubh)ry}ry(hgUhhjHyhiNhkhhm}ry(ho]hp]hq]hr]ht]uhvNhwhhb]ry(h)ry}ry(hgUhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK&hwhhb]ry(h)ry}ry(hgXVersionhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvKhb]ryhXVersionryry}ry(hgUhhjyubaubh)ry}ry(hgX2.0ryhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ryh)ry}ry(hgjyhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK&hb]ryhX2.0ryry}ry(hgjyhhjyubaubahkhubeubh)ry}ry(hgUhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK'hwhhb]ry(h)ry}ry(hgXREST URLhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvKhb]ryhXREST URLryry}ry(hgUhhjyubaubh)ry}ry(hgX``GET /views/{theme}/{id}``ryhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ryh)ry}ry(hgjyhhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvK'hb]ryj)ry}ry(hgjyhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ryhXGET /views/{theme}/{id}ryry}ry(hgUhhjyubahkjubaubahkhubeubh)ry}ry(hgUhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ry(h)ry}ry(hgX Parametershhjyhijwhkhhm}ry(ho]hp]hq]hr]ht]uhvKhb]ryhX Parametersryry}ry(hgUhhjyubaubh)ry}ry(hgUhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ryj #)ry}ry(hgUhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ry(j#)ry}ry(hgUhm}ry(ho]hp]hq]hr]ht]uhhjyhb]ryh)ry}ry(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}ry(ho]hp]hq]hr]ht]uhhjyhb]ry(j")ry}ry(hgXsessionhm}ry(hr]hq]j"ho]hp]ht]uhhjyhb]ryhXsessionryry}ry(hgUhhjyubahkj"ubhX (ryry}ry(hgUhhjyubj)ry}ry(hgX:class:`Types.Session`ryhhjyhijwhkjhm}ry(UreftypeXclassjjX Types.SessionU refdomainXpyryhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvK)hb]ryj)ry}ry(hgjyhm}ry(ho]hp]ry(jjyXpy-classryehq]hr]ht]uhhjyhb]ryhX Types.Sessionryry}ry(hgUhhjyubahkjubaubhX)ry}ry(hgUhhjyubhX -- ryry}ry(hgUhhjyubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the ryry}rz(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjyubj)rz}rz(hgX:term:`public user`rzhhjyhijwhkjhm}rz(UreftypeXtermjjX public userU refdomainXstdrzhr]hq]U refexplicitho]hp]ht]jjuhvK(hb]rzj`2)rz}rz(hgjzhm}r z(ho]hp]r z(jjzXstd-termr zehq]hr]ht]uhhjzhb]r zhX public userr zrz}rz(hgUhhjzubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rzrz}rz(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjyubehkhubahkj;#ubj#)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjyhb]rzh)rz}rz(hgX'theme (string) -- Indicates which themed view will be used to handle the query. All implementations must support a 'default' HTML theme, but are free to implement additional themes that return both HTML and non-HTML responses. Transmitted as part of the URL path and must be escaped accordingly.hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rz(j")rz}rz(hgXthemehm}rz(hr]hq]j"ho]hp]ht]uhhjzhb]rzhXthemerzr z}r!z(hgUhhjzubahkj"ubhX (r"zr#z}r$z(hgUhhjzubj)r%z}r&z(hgUhm}r'z(Ureftypej&j"U reftargetXstringr(zU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjzhb]r)zj&)r*z}r+z(hgj(zhm}r,z(ho]hp]hq]hr]ht]uhhj%zhb]r-zhXstringr.zr/z}r0z(hgUhhj*zubahkj&ubahkjubhX)r1z}r2z(hgUhhjzubhX -- r3zr4z}r5z(hgUhhjzubhXIndicates which themed view will be used to handle the query. All implementations must support a 'default' HTML theme, but are free to implement additional themes that return both HTML and non-HTML responses. Transmitted as part of the URL path and must be escaped accordingly.r6zr7z}r8z(hgXIndicates which themed view will be used to handle the query. All implementations must support a 'default' HTML theme, but are free to implement additional themes that return both HTML and non-HTML responses. Transmitted as part of the URL path and must be escaped accordingly.hhjzubehkhubahkj;#ubj#)r9z}r:z(hgUhm}r;z(ho]hp]hq]hr]ht]uhhjyhb]rz(hgXid (Types.Identifier) -- The identifier of the object to render in a view. May be a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r?z(ho]hp]hq]hr]ht]uhhj9zhb]r@z(j")rAz}rBz(hgXidhm}rCz(hr]hq]j"ho]hp]ht]uhhj=zhb]rDzhXidrEzrFz}rGz(hgUhhjAzubahkj"ubhX (rHzrIz}rJz(hgUhhj=zubj)rKz}rLz(hgX:class:`Types.Identifier`rMzhhj=zhijwhkjhm}rNz(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrOzhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvK/hb]rPzj)rQz}rRz(hgjMzhm}rSz(ho]hp]rTz(jjOzXpy-classrUzehq]hr]ht]uhhjKzhb]rVzhXTypes.IdentifierrWzrXz}rYz(hgUhhjQzubahkjubaubhX)rZz}r[z(hgUhhj=zubhX -- r\zr]z}r^z(hgUhhj=zubhXThe identifier of the object to render in a view. May be a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r_zr`z}raz(hgXThe identifier of the object to render in a view. May be a PID or a SID, the latter acting as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhj=zubehkhubahkj;#ubehkj#ubahkhubehkhubh)rbz}rcz(hgUhm}rdz(ho]hp]hq]hr]ht]uhhjyhb]rez(h)rfz}rgz(hgXReturnshhjbzhijwhkhhm}rhz(ho]hp]hq]hr]ht]uhvKhb]rizhXReturnsrjzrkz}rlz(hgUhhjfzubaubh)rmz}rnz(hgUhm}roz(ho]hp]hq]hr]ht]uhhjbzhb]rpzh)rqz}rrz(hgXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.hm}rsz(ho]hp]hq]hr]ht]uhhjmzhb]rtzhXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.ruzrvz}rwz(hgXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.hhjqzubahkhubahkhubehkhubh)rxz}ryz(hgUhm}rzz(ho]hp]hq]hr]ht]uhhjyhb]r{z(h)r|z}r}z(hgX Return typehhjxzhijwhkhhm}r~z(ho]hp]hq]hr]ht]uhvKhb]rzhX Return typerzrz}rz(hgUhhj|zubaubh)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjxzhb]rzh)rz}rz(hgXTypes.OctetStreamhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzj)rz}rz(hgX:class:`Types.OctetStream`rzhhjzhijwhkjhm}rz(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrzhr]hq]U refexplicitho]hp]ht]jjjNjjwuhvK2hb]rzj)rz}rz(hgjzhm}rz(ho]hp]rz(jjzXpy-classrzehq]hr]ht]uhhjzhb]rzhXTypes.OctetStreamrzrz}rz(hgUhhjzubahkjubaubahkhubahkhubehkhubh)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjyhb]rz(h)rz}rz(hgXRaiseshhjzhijwhkhhm}rz(ho]hp]hq]hr]ht]uhvKhb]rzhXRaisesrzrz}rz(hgUhhjzubaubh)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzj #)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rz(j#)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzh)rz}rz(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2850)hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rz(j)rz}rz(hgUhm}rz(Ureftypej#j"U reftargetXExceptions.InvalidTokenrzU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjzhb]rzj")rz}rz(hgjzhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzhXExceptions.InvalidTokenrzrz}rz(hgUhhjzubahkj"ubahkjubhX -- rzrz}rz(hgUhhjzubj)rz}rz(hgX$``(errorCode=401, detailCode=2850)``hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzhX (errorCode=401, detailCode=2850)rzrz}rz(hgUhhjzubahkjubehkhubahkj;#ubj#)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzh)rz}rz(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2851)hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rz(j)rz}rz(hgUhm}rz(Ureftypej#j"U reftargetXExceptions.ServiceFailurerzU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjzhb]rzj")rz}rz(hgjzhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzhXExceptions.ServiceFailurerzrz}rz(hgUhhjzubahkj"ubahkjubhX -- rzrz}rz(hgUhhjzubj)rz}rz(hgX$``(errorCode=500, detailCode=2851)``hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzhX (errorCode=500, detailCode=2851)rzrz}rz(hgUhhjzubahkjubehkhubahkj;#ubj#)rz}rz(hgUhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzh)rz}rz(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2852)hm}rz(ho]hp]hq]hr]ht]uhhjzhb]rz(j)rz}rz(hgUhm}rz(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrzU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjzhb]rzj")rz}rz(hgjzhm}rz(ho]hp]hq]hr]ht]uhhjzhb]rzhXExceptions.NotAuthorizedrzrz}rz(hgUhhjzubahkj"ubahkjubhX -- rzrz}rz(hgUhhjzubj)r{}r{(hgX$``(errorCode=401, detailCode=2852)``hm}r{(ho]hp]hq]hr]ht]uhhjzhb]r{hX (errorCode=401, detailCode=2852)r{r{}r{(hgUhhj{ubahkjubehkhubahkj;#ubj#)r{}r{(hgUhm}r {(ho]hp]hq]hr]ht]uhhjzhb]r {h)r {}r {(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2853)hm}r {(ho]hp]hq]hr]ht]uhhj{hb]r{(j)r{}r{(hgUhm}r{(Ureftypej#j"U reftargetXExceptions.InvalidRequestr{U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhj {hb]r{j")r{}r{(hgj{hm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{hXExceptions.InvalidRequestr{r{}r{(hgUhhj{ubahkj"ubahkjubhX -- r{r{}r{(hgUhhj {ubj)r{}r{(hgX$``(errorCode=400, detailCode=2853)``hm}r {(ho]hp]hq]hr]ht]uhhj {hb]r!{hX (errorCode=400, detailCode=2853)r"{r#{}r${(hgUhhj{ubahkjubehkhubahkj;#ubj#)r%{}r&{(hgUhm}r'{(ho]hp]hq]hr]ht]uhhjzhb]r({h)r){}r*{(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2854)hm}r+{(ho]hp]hq]hr]ht]uhhj%{hb]r,{(j)r-{}r.{(hgUhm}r/{(Ureftypej#j"U reftargetXExceptions.NotImplementedr0{U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhj){hb]r1{j")r2{}r3{(hgj0{hm}r4{(ho]hp]hq]hr]ht]uhhj-{hb]r5{hXExceptions.NotImplementedr6{r7{}r8{(hgUhhj2{ubahkj"ubahkjubhX -- r9{r:{}r;{(hgUhhj){ubj)r<{}r={(hgX$``(errorCode=501, detailCode=2854)``hm}r>{(ho]hp]hq]hr]ht]uhhj){hb]r?{hX (errorCode=501, detailCode=2854)r@{rA{}rB{(hgUhhj<{ubahkjubehkhubahkj;#ubj#)rC{}rD{(hgUhm}rE{(ho]hp]hq]hr]ht]uhhjzhb]rF{h)rG{}rH{(hgXXExceptions.NotFound -- (errorCode=404, detailCode=2855)The specified pid does not exist.hm}rI{(ho]hp]hq]hr]ht]uhhjC{hb]rJ{(j)rK{}rL{(hgUhm}rM{(Ureftypej#j"U reftargetXExceptions.NotFoundrN{U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjG{hb]rO{j")rP{}rQ{(hgjN{hm}rR{(ho]hp]hq]hr]ht]uhhjK{hb]rS{hXExceptions.NotFoundrT{rU{}rV{(hgUhhjP{ubahkj"ubahkjubhX -- rW{rX{}rY{(hgUhhjG{ubh)rZ{}r[{(hgX$``(errorCode=404, detailCode=2855)``r\{hhjG{hijwhkhhm}r]{(ho]hp]hq]hr]ht]uhvK>hb]r^{j)r_{}r`{(hgj\{hm}ra{(ho]hp]hq]hr]ht]uhhjZ{hb]rb{hX (errorCode=404, detailCode=2855)rc{rd{}re{(hgUhhj_{ubahkjubaubh)rf{}rg{(hgX!The specified pid does not exist.rh{hhjG{hijwhkhhm}ri{(ho]hp]hq]hr]ht]uhvK@hb]rj{hX!The specified pid does not exist.rk{rl{}rm{(hgjh{hhjf{ubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rn{}ro{(hgUhhjEwhiNhkjhm}rp{(hr]hq]ho]hp]ht]Uentries]rq{(jXlistViews() (in module CNView)h'UNtrr{auhvNhwhhb]ubj!)rs{}rt{(hgUhhjEwhiNhkj!hm}ru{(j"j"Xpyrv{hr]hq]ho]hp]ht]j"Xfunctionrw{j"jw{uhvNhwhhb]rx{(j")ry{}rz{(hgX listViews(session) -> OptionListhhjs{hiXAinternal padding after source/apis/generated/generated_CNView.txtr{{hkj "hm}r|{(hr]r}{h'aj"jwhq]ho]hp]ht]r~{h'aj"X listViewsr{j"Uj"uhvK^hwhhb]r{(j")r{}r{(hgXCNView.hhjy{hij{{hkj"hm}r{(ho]hp]hq]hr]ht]uhvK^hwhhb]r{hXCNView.r{r{}r{(hgUhhj{ubaubj")r{}r{(hgj{hhjy{hij{{hkj!"hm}r{(ho]hp]hq]hr]ht]uhvK^hwhhb]r{hX listViewsr{r{}r{(hgUhhj{ubaubj'")r{}r{(hgXsessionhhjy{hij{{hkj*"hm}r{(ho]hp]hq]hr]ht]uhvK^hwhhb]r{j-")r{}r{(hgXsessionhm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{hXsessionr{r{}r{(hgUhhj{ubahkj5"ubaubj6")r{}r{(hgX OptionListhhjy{hij{{hkj9"hm}r{(ho]hp]hq]hr]ht]uhvK^hwhhb]r{hX OptionListr{r{}r{(hgUhhj{ubaubeubj?")r{}r{(hgUhhjs{hij{{hkjB"hm}r{(ho]hp]hq]hr]ht]uhvK^hwhhb]r{(h)r{}r{(hgXJProvides a list of usable themes for rendering content in a view, including a required 'default' theme. The list of themes is provided as an OptionList, where the option key should be used as the theme name in calls to MNView.view, and the description provides a human readable description of what will be returned fo rthat theme.r{hhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKGhwhhb]r{hXJProvides a list of usable themes for rendering content in a view, including a required 'default' theme. The list of themes is provided as an OptionList, where the option key should be used as the theme name in calls to MNView.view, and the description provides a human readable description of what will be returned fo rthat theme.r{r{}r{(hgj{hhj{ubaubh)r{}r{(hgX3v2.0: This method was added to the Version 2.0 API.r{hhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKIhwhhb]r{hX3v2.0: This method was added to the Version 2.0 API.r{r{}r{(hgj{hhj{ubaubh)r{}r{(hgUhhj{hiNhkhhm}r{(ho]hp]hq]hr]ht]uhvNhwhhb]r{(h)r{}r{(hgUhhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKKhwhhb]r{(h)r{}r{(hgXVersionhhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKhb]r{hXVersionr{r{}r{(hgUhhj{ubaubh)r{}r{(hgX2.0r{hm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{h)r{}r{(hgj{hhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKKhb]r{hX2.0r{r{}r{(hgj{hhj{ubaubahkhubeubh)r{}r{(hgUhhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKLhwhhb]r{(h)r{}r{(hgXREST URLhhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKhb]r{hXREST URLr{r{}r{(hgUhhj{ubaubh)r{}r{(hgX``GET /views``r{hm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{h)r{}r{(hgj{hhj{hijwhkhhm}r{(ho]hp]hq]hr]ht]uhvKLhb]r{j)r{}r{(hgj{hm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{hX GET /viewsr{r{}r{(hgUhhj{ubahkjubaubahkhubeubh)r{}r{(hgUhm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{(h)r{}r{(hgX Parametershhj{hij{{hkhhm}r{(ho]hp]hq]hr]ht]uhvKhb]r{hX Parametersr{r{}r{(hgUhhj{ubaubh)r{}r{(hgUhm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{h)r{}r{(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r{(ho]hp]hq]hr]ht]uhhj{hb]r{(j")r{}r{(hgXsessionhm}r|(hr]hq]j"ho]hp]ht]uhhj{hb]r|hXsessionr|r|}r|(hgUhhj{ubahkj"ubhX (r|r|}r|(hgUhhj{ubj)r|}r |(hgX:class:`Types.Session`r |hhj{hijwhkjhm}r |(UreftypeXclassjjX Types.SessionU refdomainXpyr |hr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKNhb]r |j)r|}r|(hgj |hm}r|(ho]hp]r|(jj |Xpy-classr|ehq]hr]ht]uhhj|hb]r|hX Types.Sessionr|r|}r|(hgUhhj|ubahkjubaubhX)r|}r|(hgUhhj{ubhX -- r|r|}r|(hgUhhj{ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the r|r|}r|(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj{ubj)r|}r |(hgX:term:`public user`r!|hhj{hijwhkjhm}r"|(UreftypeXtermjjX public userU refdomainXstdr#|hr]hq]U refexplicitho]hp]ht]jjuhvKMhb]r$|j`2)r%|}r&|(hgj!|hm}r'|(ho]hp]r(|(jj#|Xstd-termr)|ehq]hr]ht]uhhj|hb]r*|hX public userr+|r,|}r-|(hgUhhj%|ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r.|r/|}r0|(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj{ubehkhubahkhubehkhubh)r1|}r2|(hgUhm}r3|(ho]hp]hq]hr]ht]uhhj{hb]r4|(h)r5|}r6|(hgXReturnshhj1|hij{{hkhhm}r7|(ho]hp]hq]hr]ht]uhvKhb]r8|hXReturnsr9|r:|}r;|(hgUhhj5|ubaubh)r<|}r=|(hgUhm}r>|(ho]hp]hq]hr]ht]uhhj1|hb]r?|h)r@|}rA|(hgXIA list of available themes that can be used with the MNView.view service.hm}rB|(ho]hp]hq]hr]ht]uhhj<|hb]rC|hXIA list of available themes that can be used with the MNView.view service.rD|rE|}rF|(hgXIA list of available themes that can be used with the MNView.view service.hhj@|ubahkhubahkhubehkhubh)rG|}rH|(hgUhm}rI|(ho]hp]hq]hr]ht]uhhj{hb]rJ|(h)rK|}rL|(hgX Return typehhjG|hij{{hkhhm}rM|(ho]hp]hq]hr]ht]uhvKhb]rN|hX Return typerO|rP|}rQ|(hgUhhjK|ubaubh)rR|}rS|(hgUhm}rT|(ho]hp]hq]hr]ht]uhhjG|hb]rU|h)rV|}rW|(hgXTypes.OptionListhm}rX|(ho]hp]hq]hr]ht]uhhjR|hb]rY|j)rZ|}r[|(hgX:class:`Types.OptionList`r\|hhjV|hijwhkjhm}r]|(UreftypeXclassjjXTypes.OptionListU refdomainXpyr^|hr]hq]U refexplicitho]hp]ht]jjjNjjwuhvKQhb]r_|j)r`|}ra|(hgj\|hm}rb|(ho]hp]rc|(jj^|Xpy-classrd|ehq]hr]ht]uhhjZ|hb]re|hXTypes.OptionListrf|rg|}rh|(hgUhhj`|ubahkjubaubahkhubahkhubehkhubh)ri|}rj|(hgUhm}rk|(ho]hp]hq]hr]ht]uhhj{hb]rl|(h)rm|}rn|(hgXRaiseshhji|hij{{hkhhm}ro|(ho]hp]hq]hr]ht]uhvKhb]rp|hXRaisesrq|rr|}rs|(hgUhhjm|ubaubh)rt|}ru|(hgUhm}rv|(ho]hp]hq]hr]ht]uhhji|hb]rw|j #)rx|}ry|(hgUhm}rz|(ho]hp]hq]hr]ht]uhhjt|hb]r{|(j#)r||}r}|(hgUhm}r~|(ho]hp]hq]hr]ht]uhhjx|hb]r|h)r|}r|(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2860)hm}r|(ho]hp]hq]hr]ht]uhhj||hb]r|(j)r|}r|(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.InvalidTokenr|U refdomainjv{hr]hq]U refexplicitho]hp]ht]uhhj|hb]r|j")r|}r|(hgj|hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hXExceptions.InvalidTokenr|r|}r|(hgUhhj|ubahkj"ubahkjubhX -- r|r|}r|(hgUhhj|ubj)r|}r|(hgX$``(errorCode=401, detailCode=2860)``hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hX (errorCode=401, detailCode=2860)r|r|}r|(hgUhhj|ubahkjubehkhubahkj;#ubj#)r|}r|(hgUhm}r|(ho]hp]hq]hr]ht]uhhjx|hb]r|h)r|}r|(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2861)hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|(j)r|}r|(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.ServiceFailurer|U refdomainjv{hr]hq]U refexplicitho]hp]ht]uhhj|hb]r|j")r|}r|(hgj|hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hXExceptions.ServiceFailurer|r|}r|(hgUhhj|ubahkj"ubahkjubhX -- r|r|}r|(hgUhhj|ubj)r|}r|(hgX$``(errorCode=500, detailCode=2861)``hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hX (errorCode=500, detailCode=2861)r|r|}r|(hgUhhj|ubahkjubehkhubahkj;#ubj#)r|}r|(hgUhm}r|(ho]hp]hq]hr]ht]uhhjx|hb]r|h)r|}r|(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2862)hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|(j)r|}r|(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr|U refdomainjv{hr]hq]U refexplicitho]hp]ht]uhhj|hb]r|j")r|}r|(hgj|hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hXExceptions.NotAuthorizedr|r|}r|(hgUhhj|ubahkj"ubahkjubhX -- r|r|}r|(hgUhhj|ubj)r|}r|(hgX$``(errorCode=401, detailCode=2862)``hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hX (errorCode=401, detailCode=2862)r|r|}r|(hgUhhj|ubahkjubehkhubahkj;#ubj#)r|}r|(hgUhm}r|(ho]hp]hq]hr]ht]uhhjx|hb]r|h)r|}r|(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2863)hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|(j)r|}r|(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.InvalidRequestr|U refdomainjv{hr]hq]U refexplicitho]hp]ht]uhhj|hb]r|j")r|}r|(hgj|hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hXExceptions.InvalidRequestr|r|}r|(hgUhhj|ubahkj"ubahkjubhX -- r|r|}r|(hgUhhj|ubj)r|}r|(hgX$``(errorCode=400, detailCode=2863)``hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|hX (errorCode=400, detailCode=2863)r|r|}r|(hgUhhj|ubahkjubehkhubahkj;#ubj#)r|}r|(hgUhm}r|(ho]hp]hq]hr]ht]uhhjx|hb]r|h)r|}r|(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2864)hm}r|(ho]hp]hq]hr]ht]uhhj|hb]r|(j)r|}r|(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.NotImplementedr|U refdomainjv{hr]hq]U refexplicitho]hp]ht]uhhj|hb]r}j")r}}r}(hgj|hm}r}(ho]hp]hq]hr]ht]uhhj|hb]r}hXExceptions.NotImplementedr}r}}r}(hgUhhj}ubahkj"ubahkjubhX -- r}r }}r }(hgUhhj|ubj)r }}r }(hgX$``(errorCode=501, detailCode=2864)``hm}r }(ho]hp]hq]hr]ht]uhhj|hb]r}hX (errorCode=501, detailCode=2864)r}r}}r}(hgUhhj }ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubeubhd)r}}r}(hgUhhhehihjhkhlhm}r}(ho]hp]hq]hr]r}(Xmodule-CNAuthorizationr}h^eht]r}hFauhvKYhwhhb]r}(hy)r}}r}(hgXAuthorization APIr}hhj}hihjhkh}hm}r}(ho]hp]hq]hr]ht]uhvKYhwhhb]r}hXAuthorization APIr}r}}r }(hgj}hhj}ubaubj)r!}}r"}(hgUhhj}hihjhkjhm}r#}(hr]hq]ho]hp]ht]Uentries]r$}(jXCNAuthorization (module)Xmodule-CNAuthorizationUNtr%}auhvNhwhhb]ubj)r&}}r'}(hgXBWarning: this file is automatically generated. Edits will be losthhj}hijX3source/apis/generated/generated_CNAuthorization.txtr(}r)}}r*}bhkj!hm}r+}(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]r,}hXBWarning: this file is automatically generated. Edits will be lostr-}r.}}r/}(hgUhhj&}ubaubj))r0}}r1}(hgUhhj}hiNhkj,hm}r2}(ho]hp]hq]hr]r3}Uid6r4}aht]uhvNhwhhb]r5}(hy)r6}}r7}(hgX+Functions defined in :mod:`CNAuthorization`hm}r8}(ho]hp]hq]hr]ht]uhhj0}hb]r9}(hXFunctions defined in r:}r;}}r<}(hgXFunctions defined in hhj6}ubj)r=}}r>}(hgX:mod:`CNAuthorization`r?}hhj6}hij)}hkjhm}r@}(UreftypeXmodjjXCNAuthorizationU refdomainXpyrA}hr]hq]U refexplicitho]hp]ht]jjjNjXCNAuthorizationrB}uhvKhb]rC}j)rD}}rE}(hgj?}hm}rF}(ho]hp]rG}(jjA}Xpy-modrH}ehq]hr]ht]uhhj=}hb]rI}hXCNAuthorizationrJ}rK}}rL}(hgUhhjD}ubahkjubaubehkh}ubj9)rM}}rN}(hgUhm}rO}(hr]hq]ho]hp]ht]UcolsKuhhj0}hb]rP}(j>)rQ}}rR}(hgUhm}rS}(hr]hq]ho]hp]ht]UcolwidthKuhhjM}hb]hkjBubj>)rT}}rU}(hgUhm}rV}(hr]hq]ho]hp]ht]UcolwidthKuhhjM}hb]hkjBubj>)rW}}rX}(hgUhm}rY}(hr]hq]ho]hp]ht]UcolwidthK uhhjM}hb]hkjBubj>)rZ}}r[}(hgUhm}r\}(hr]hq]ho]hp]ht]UcolwidthK uhhjM}hb]hkjBubj>)r]}}r^}(hgUhm}r_}(hr]hq]ho]hp]ht]UcolwidthKuhhjM}hb]hkjBubjO)r`}}ra}(hgUhm}rb}(ho]hp]hq]hr]ht]uhhjM}hb]rc}jT)rd}}re}(hgUhm}rf}(ho]hp]hq]hr]ht]uhhj`}hb]rg}(jY)rh}}ri}(hgUhm}rj}(ho]hp]hq]hr]ht]uhhjd}hb]rk}h)rl}}rm}(hgXTierrn}hhjh}hij)}hkhhm}ro}(ho]hp]hq]hr]ht]uhvK hb]rp}hXTierrq}rr}}rs}(hgjn}hhjl}ubaubahkjfubjY)rt}}ru}(hgUhm}rv}(ho]hp]hq]hr]ht]uhhjd}hb]rw}h)rx}}ry}(hgXVersionrz}hhjt}hij)}hkhhm}r{}(ho]hp]hq]hr]ht]uhvK hb]r|}hXVersionr}}r~}}r}(hgjz}hhjx}ubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhjd}hb]r}h)r}}r}(hgXRESTr}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvK hb]r}hXRESTr}r}}r}(hgj}hhj}ubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhjd}hb]r}h)r}}r}(hgXFunctionr}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvK hb]r}hXFunctionr}r}}r}(hgj}hhj}ubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhjd}hb]r}h)r}}r}(hgX Parametersr}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvK hb]r}hX Parametersr}r}}r}(hgj}hhj}ubaubahkjfubehkjubahkjubj)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhjM}hb]r}(jT)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}(jY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}h)r}}r}(hgXTier 2r}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r}hXTier 2r}r}}r}(hgj}hhj}ubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}h)r}}r}(hgX1.0, 2.0r}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r}hX1.0, 2.0r}r}}r}(hgj}hhj}ubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}h)r}}r}(hgX``PUT /owner/{id}``r}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r}j)r}}r}(hgj}hm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}hXPUT /owner/{id}r}r}}r}(hgUhhj}ubahkjubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}h)r}}r}(hgX:func:`setRightsHolder`r}hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r}j)r}}r}(hgj}hhj}hij)}hkjhm}r}(UreftypeXfuncjjXsetRightsHolderU refdomainXpyr}hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r}j)r}}r}(hgj}hm}r}(ho]hp]r}(jj}Xpy-funcr}ehq]hr]ht]uhhj}hb]r}hXsetRightsHolder()r}r}}r}(hgUhhj}ubahkjubaubaubahkjfubjY)r}}r}(hgUhm}r}(ho]hp]hq]hr]ht]uhhj}hb]r}h)r}}r}(hgX(:class:`session`, :class:`id`, :class:`userId`, ``serialVersion``) ``->`` :class:`Types.Identifier`hhj}hij)}hkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r}(hX(r}}r}(hgX(hhj}ubj)r}}r}(hgX:class:`session`r}hhj}hij)}hkjhm}r}(UreftypeXclassjjX Types.SessionU refdomainXpyr}hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r}j)r}}r}(hgj}hm}r}(ho]hp]r}(jj}Xpy-classr}ehq]hr]ht]uhhj}hb]r~hXsessionr~r~}r~(hgUhhj}ubahkjubaubhX, r~r~}r~(hgX, hhj}ubj)r~}r~(hgX:class:`id`r ~hhj}hij)}hkjhm}r ~(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr ~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r ~j)r ~}r~(hgj ~hm}r~(ho]hp]r~(jj ~Xpy-classr~ehq]hr]ht]uhhj~hb]r~hXidr~r~}r~(hgUhhj ~ubahkjubaubhX, r~r~}r~(hgX, hhj}ubj)r~}r~(hgX:class:`userId`r~hhj}hij)}hkjhm}r~(UreftypeXclassjjX Types.SubjectU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r~j)r~}r ~(hgj~hm}r!~(ho]hp]r"~(jj~Xpy-classr#~ehq]hr]ht]uhhj~hb]r$~hXuserIdr%~r&~}r'~(hgUhhj~ubahkjubaubhX, r(~r)~}r*~(hgX, hhj}ubj)r+~}r,~(hgX``serialVersion``hm}r-~(ho]hp]hq]hr]ht]uhhj}hb]r.~hX serialVersionr/~r0~}r1~(hgUhhj+~ubahkjubhX) r2~r3~}r4~(hgX) hhj}ubj)r5~}r6~(hgX``->``hm}r7~(ho]hp]hq]hr]ht]uhhj}hb]r8~hX->r9~r:~}r;~(hgUhhj5~ubahkjubhX r<~}r=~(hgX hhj}ubj)r>~}r?~(hgX:class:`Types.Identifier`r@~hhj}hij)}hkjhm}rA~(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrB~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rC~j)rD~}rE~(hgj@~hm}rF~(ho]hp]rG~(jjB~Xpy-classrH~ehq]hr]ht]uhhj>~hb]rI~hXTypes.IdentifierrJ~rK~}rL~(hgUhhjD~ubahkjubaubeubahkjfubehkjubjT)rM~}rN~(hgUhm}rO~(ho]hp]hq]hr]ht]uhhj}hb]rP~(jY)rQ~}rR~(hgUhm}rS~(ho]hp]hq]hr]ht]uhhjM~hb]rT~h)rU~}rV~(hgXTier 2rW~hhjQ~hij)}hkhhm}rX~(ho]hp]hq]hr]ht]uhvKhb]rY~hXTier 2rZ~r[~}r\~(hgjW~hhjU~ubaubahkjfubjY)r]~}r^~(hgUhm}r_~(ho]hp]hq]hr]ht]uhhjM~hb]r`~h)ra~}rb~(hgX1.0, 2.0rc~hhj]~hij)}hkhhm}rd~(ho]hp]hq]hr]ht]uhvKhb]re~hX1.0, 2.0rf~rg~}rh~(hgjc~hhja~ubaubahkjfubjY)ri~}rj~(hgUhm}rk~(ho]hp]hq]hr]ht]uhhjM~hb]rl~h)rm~}rn~(hgX*``GET /isAuthorized/{id}?action={action}``ro~hhji~hij)}hkhhm}rp~(ho]hp]hq]hr]ht]uhvKhb]rq~j)rr~}rs~(hgjo~hm}rt~(ho]hp]hq]hr]ht]uhhjm~hb]ru~hX&GET /isAuthorized/{id}?action={action}rv~rw~}rx~(hgUhhjr~ubahkjubaubahkjfubjY)ry~}rz~(hgUhm}r{~(ho]hp]hq]hr]ht]uhhjM~hb]r|~h)r}~}r~~(hgX:func:`isAuthorized`r~hhjy~hij)}hkhhm}r~(ho]hp]hq]hr]ht]uhvKhb]r~j)r~}r~(hgj~hhj}~hij)}hkjhm}r~(UreftypeXfuncjjX isAuthorizedU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r~j)r~}r~(hgj~hm}r~(ho]hp]r~(jj~Xpy-funcr~ehq]hr]ht]uhhj~hb]r~hXisAuthorized()r~r~}r~(hgUhhj~ubahkjubaubaubahkjfubjY)r~}r~(hgUhm}r~(ho]hp]hq]hr]ht]uhhjM~hb]r~h)r~}r~(hgXr(:class:`session`, :class:`id`, :class:`action`) ``->`` booleanhhj~hij)}hkhhm}r~(ho]hp]hq]hr]ht]uhvKhb]r~(hX(r~}r~(hgX(hhj~ubj)r~}r~(hgX:class:`session`r~hhj~hij)}hkjhm}r~(UreftypeXclassjjX Types.SessionU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r~j)r~}r~(hgj~hm}r~(ho]hp]r~(jj~Xpy-classr~ehq]hr]ht]uhhj~hb]r~hXsessionr~r~}r~(hgUhhj~ubahkjubaubhX, r~r~}r~(hgX, hhj~ubj)r~}r~(hgX:class:`id`r~hhj~hij)}hkjhm}r~(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r~j)r~}r~(hgj~hm}r~(ho]hp]r~(jj~Xpy-classr~ehq]hr]ht]uhhj~hb]r~hXidr~r~}r~(hgUhhj~ubahkjubaubhX, r~r~}r~(hgX, hhj~ubj)r~}r~(hgX!:class:`action`r~hhj~hij)}hkjhm}r~(UreftypeXclassjjXTypes.PermissionU refdomainXpyr~hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r~j)r~}r~(hgj~hm}r~(ho]hp]r~(jj~Xpy-classr~ehq]hr]ht]uhhj~hb]r~hXactionr~r~}r~(hgUhhj~ubahkjubaubhX) r~r~}r~(hgX) hhj~ubj)r~}r~(hgX``->``hm}r~(ho]hp]hq]hr]ht]uhhj~hb]r~hX->r~r~}r~(hgUhhj~ubahkjubhX booleanr~r~}r~(hgX booleanhhj~ubeubahkjfubehkjubjT)r~}r~(hgUhm}r~(ho]hp]hq]hr]ht]uhhj}hb]r~(jY)r~}r~(hgUhm}r~(ho]hp]hq]hr]ht]uhhj~hb]r~h)r~}r~(hgXTier 2r~hhj~hij)}hkhhm}r~(ho]hp]hq]hr]ht]uhvKhb]r~hXTier 2r~r~}r~(hgj~hhj~ubaubahkjfubjY)r~}r~(hgUhm}r~(ho]hp]hq]hr]ht]uhhj~hb]r~h)r~}r~(hgX1.0, 2.0r~hhj~hij)}hkhhm}r~(ho]hp]hq]hr]ht]uhvKhb]r~hX1.0, 2.0r~r~}r~(hgj~hhj~ubaubahkjfubjY)r~}r~(hgUhm}r~(ho]hp]hq]hr]ht]uhhj~hb]r~h)r~}r~(hgX``PUT /accessRules/{id}``r~hhj~hij)}hkhhm}r~(ho]hp]hq]hr]ht]uhvKhb]r~j)r~}r(hgj~hm}r(ho]hp]hq]hr]ht]uhhj~hb]rhXPUT /accessRules/{id}rr}r(hgUhhj~ubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]r h)r }r (hgX:func:`setAccessPolicy`r hhjhij)}hkhhm}r (ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgj hhj hij)}hkjhm}r(UreftypeXfuncjjXsetAccessPolicyU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rj)r}r(hgj hm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXsetAccessPolicy()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]r h)r!}r"(hgX(:class:`session`, :class:`id`, :class:`accessPolicy`, ``serialVersion``) ``->`` booleanhhjhij)}hkhhm}r#(ho]hp]hq]hr]ht]uhvKhb]r$(hX(r%}r&(hgX(hhj!ubj)r'}r((hgX:class:`session`r)hhj!hij)}hkjhm}r*(UreftypeXclassjjX Types.SessionU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r,j)r-}r.(hgj)hm}r/(ho]hp]r0(jj+Xpy-classr1ehq]hr]ht]uhhj'hb]r2hXsessionr3r4}r5(hgUhhj-ubahkjubaubhX, r6r7}r8(hgX, hhj!ubj)r9}r:(hgX:class:`id`r;hhj!hij)}hkjhm}r<(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr=hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r>j)r?}r@(hgj;hm}rA(ho]hp]rB(jj=Xpy-classrCehq]hr]ht]uhhj9hb]rDhXidrErF}rG(hgUhhj?ubahkjubaubhX, rHrI}rJ(hgX, hhj!ubj)rK}rL(hgX):class:`accessPolicy`rMhhj!hij)}hkjhm}rN(UreftypeXclassjjXTypes.AccessPolicyU refdomainXpyrOhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rPj)rQ}rR(hgjMhm}rS(ho]hp]rT(jjOXpy-classrUehq]hr]ht]uhhjKhb]rVhX accessPolicyrWrX}rY(hgUhhjQubahkjubaubhX, rZr[}r\(hgX, hhj!ubj)r]}r^(hgX``serialVersion``hm}r_(ho]hp]hq]hr]ht]uhhj!hb]r`hX serialVersionrarb}rc(hgUhhj]ubahkjubhX) rdre}rf(hgX) hhj!ubj)rg}rh(hgX``->``hm}ri(ho]hp]hq]hr]ht]uhhj!hb]rjhX->rkrl}rm(hgUhhjgubahkjubhX booleanrnro}rp(hgX booleanhhj!ubeubahkjfubehkjubehkjubehkjubeubj)rq}rr(hgUhhj}hiNhkjhm}rs(hr]hq]ho]hp]ht]Uentries]rt(jX-setRightsHolder() (in module CNAuthorization)h#UNtruauhvNhwhhb]ubj!)rv}rw(hgUhhj}hiNhkj!hm}rx(j"j"Xpyryhr]hq]ho]hp]ht]j"Xfunctionrzj"jzuhvNhwhhb]r{(j")r|}r}(hgX>setRightsHolder(session,id,userId,serialVersion) -> Identifierhhjvhij)}hkj "hm}r~(hr]rh#aj"jB}hq]ho]hp]ht]rh#aj"XsetRightsHolderrj"Uj"uhvKPhwhhb]r(j")r}r(hgXCNAuthorization.hhj|hij)}hkj"hm}r(ho]hp]hq]hr]ht]uhvKPhwhhb]rhXCNAuthorization.rr}r(hgUhhjubaubj")r}r(hgjhhj|hij)}hkj!"hm}r(ho]hp]hq]hr]ht]uhvKPhwhhb]rhXsetRightsHolderrr}r(hgUhhjubaubj'")r}r(hgX"session, id, userId, serialVersionhhj|hij)}hkj*"hm}r(ho]hp]hq]hr]ht]uhvKPhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj5"ubj-")r}r(hgXuserIdhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXuserIdrr}r(hgUhhjubahkj5"ubj-")r}r(hgX serialVersionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgX Identifierhhj|hij)}hkj9"hm}r(ho]hp]hq]hr]ht]uhvKPhwhhb]rhX Identifierrr}r(hgUhhjubaubeubj?")r}r(hgUhhjvhij)}hkjB"hm}r(ho]hp]hq]hr]ht]uhvKPhwhhb]r(h)r}r(hgXeChanges ownership (RightsHolder) of the specified object to the :term:`subject` specified by `userId`hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK#hwhhb]r(hX@Changes ownership (RightsHolder) of the specified object to the rr}r(hgX@Changes ownership (RightsHolder) of the specified object to the hhjubj)r}r(hgX:term:`subject`rhhjhij)}hkjhm}r(UreftypeXtermjjXsubjectU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK#hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkji2ubaubhX specified by rr}r(hgX specified by hhjubcdocutils.nodes title_reference r)r}r(hgX`userId`hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXuserIdrr}r(hgUhhjubahkUtitle_referencerubeubh)r}r(hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK%hwhhb]r(hX'v2.0: The supplied identifier may be a rr}r(hgX'v2.0: The supplied identifier may be a hhjubj)r}r(hgX :term:`PID`rhhjhij)}hkjhm}r(UreftypeXtermjjXpidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK%hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXPIDrr}r(hgUhhjubahkji2ubaubhX or a rr}r(hgX or a hhjubj)r}r(hgX :term:`SID`rhhjhij)}hkjhm}r(UreftypeXtermjjXsidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK%hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXSIDrr}r(hgUhhjubahkji2ubaubhX.r}r(hgX.hhjubeubh)r}r (hgUhhjhiNhkhhm}r (ho]hp]hq]hr]ht]uhvNhwhhb]r (h)r }r (hgUhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK'hwhhb]r(h)r}r(hgXVersionhhj hij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX1.0, 2.0rhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgjhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK'hb]rhX1.0, 2.0r r!}r"(hgjhhjubaubahkhubeubh)r#}r$(hgUhhjhij)}hkhhm}r%(ho]hp]hq]hr]ht]uhvK(hwhhb]r&(h)r'}r((hgX Use Caseshhj#hij)}hkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r*hX Use Casesr+r,}r-(hgUhhj'ubaubh)r.}r/(hgX$:doc:`UC16 `r0hm}r1(ho]hp]hq]hr]ht]uhhj#hb]r2h)r3}r4(hgj0hhj.hij)}hkhhm}r5(ho]hp]hq]hr]ht]uhvK)hb]r6j)r7}r8(hgj0hhj3hij)}hkjhm}r9(UreftypeXdocr:jjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvK)hb]r;j`2)r<}r=(hgj0hm}r>(ho]hp]r?(jj:ehq]hr]ht]uhhj7hb]r@hXUC16rArB}rC(hgUhhj<ubahkji2ubaubaubahkhubeubh)rD}rE(hgUhhjhij)}hkhhm}rF(ho]hp]hq]hr]ht]uhvK*hwhhb]rG(h)rH}rI(hgXREST URLhhjDhij)}hkhhm}rJ(ho]hp]hq]hr]ht]uhvKhb]rKhXREST URLrLrM}rN(hgUhhjHubaubh)rO}rP(hgX``PUT /owner/{id}``rQhm}rR(ho]hp]hq]hr]ht]uhhjDhb]rSh)rT}rU(hgjQhhjOhij)}hkhhm}rV(ho]hp]hq]hr]ht]uhvK*hb]rWj)rX}rY(hgjQhm}rZ(ho]hp]hq]hr]ht]uhhjThb]r[hXPUT /owner/{id}r\r]}r^(hgUhhjXubahkjubaubahkhubeubh)r_}r`(hgUhm}ra(ho]hp]hq]hr]ht]uhhjhb]rb(h)rc}rd(hgX Parametershhj_hij)}hkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rfhX Parametersrgrh}ri(hgUhhjcubaubh)rj}rk(hgUhm}rl(ho]hp]hq]hr]ht]uhhj_hb]rmj #)rn}ro(hgUhm}rp(ho]hp]hq]hr]ht]uhhjjhb]rq(j#)rr}rs(hgUhm}rt(ho]hp]hq]hr]ht]uhhjnhb]ruh)rv}rw(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rx(ho]hp]hq]hr]ht]uhhjrhb]ry(j")rz}r{(hgXsessionhm}r|(hr]hq]j"ho]hp]ht]uhhjvhb]r}hXsessionr~r}r(hgUhhjzubahkj"ubhX (rr}r(hgUhhjvubj)r}r(hgX:class:`Types.Session`rhhjvhij)}hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvK,hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjvubhX -- rr}r(hgUhhjvubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjvubj)r}r(hgX:term:`public user`rhhjvhij)}hkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK+hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjvubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjnhb]rh)r}r(hgXid (Types.Identifier) -- Identifier of the object to be modified. May be either a PID or a SID, the latter acting on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Identifier`rhhjhij)}hkjhm}r€(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrÀhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvK/hb]rĀj)rŀ}rƀ(hgjhm}rǀ(ho]hp]rȀ(jjÀXpy-classrɀehq]hr]ht]uhhjhb]rʀhXTypes.Identifierrˀr̀}r̀(hgUhhjŀubahkjubaubhX)r΀}rπ(hgUhhjubhX -- rЀrр}rҀ(hgUhhjubhXIdentifier of the object to be modified. May be either a PID or a SID, the latter acting on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.rӀrԀ}rՀ(hgXIdentifier of the object to be modified. May be either a PID or a SID, the latter acting on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubj#)rր}r׀(hgUhm}r؀(ho]hp]hq]hr]ht]uhhjnhb]rـh)rڀ}rۀ(hgXuserId (Types.Subject) -- The subject that will be taking ownership of the specified object. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r܀(ho]hp]hq]hr]ht]uhhjրhb]r݀(j")rހ}r߀(hgXuserIdhm}r(hr]hq]j"ho]hp]ht]uhhjڀhb]rhXuserIdrr}r(hgUhhjހubahkj"ubhX (rr}r(hgUhhjڀubj)r}r(hgX:class:`Types.Subject`rhhjڀhij)}hkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvK2hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjڀubhX -- rr}r(hgUhhjڀubhXgThe subject that will be taking ownership of the specified object. Transmitted as a UTF-8 String as a rr}r(hgXgThe subject that will be taking ownership of the specified object. Transmitted as a UTF-8 String as a hhjڀubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhjڀhb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjڀubehkhubahkj;#ubj#)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjnhb]r h)r }r(hgXserialVersion (unsigned long) -- The serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhj hb]r(j")r}r(hgX serialVersionhm}r(hr]hq]j"ho]hp]ht]uhhj hb]rhX serialVersionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhj ubj)r}r(hgUhm}r(Ureftypej&j"U reftargetX unsigned longrU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhj hb]rj&)r }r!(hgjhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#hX unsigned longr$r%}r&(hgUhhj ubahkj&ubahkjubhX)r'}r((hgUhhj ubhX -- r)r*}r+(hgUhhj ubhXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a r,r-}r.(hgXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a hhj ubj$)r/}r0(hgX *Param part*hm}r1(ho]hp]hq]hr]ht]uhhj hb]r2hX Param partr3r4}r5(hgUhhj/ubahkj$ubhX% of the MIME multipart/mixed message.r6r7}r8(hgX% of the MIME multipart/mixed message.hhj ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r9}r:(hgUhm}r;(ho]hp]hq]hr]ht]uhhjhb]r<(h)r=}r>(hgXReturnshhj9hij)}hkhhm}r?(ho]hp]hq]hr]ht]uhvKhb]r@hXReturnsrArB}rC(hgUhhj=ubaubh)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhj9hb]rGh)rH}rI(hgX*Identifier of the object that was modifiedhm}rJ(ho]hp]hq]hr]ht]uhhjDhb]rKhX*Identifier of the object that was modifiedrLrM}rN(hgX*Identifier of the object that was modifiedhhjHubahkhubahkhubehkhubh)rO}rP(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjhb]rR(h)rS}rT(hgX Return typehhjOhij)}hkhhm}rU(ho]hp]hq]hr]ht]uhvKhb]rVhX Return typerWrX}rY(hgUhhjSubaubh)rZ}r[(hgUhm}r\(ho]hp]hq]hr]ht]uhhjOhb]r]h)r^}r_(hgXTypes.Identifierhm}r`(ho]hp]hq]hr]ht]uhhjZhb]raj)rb}rc(hgX:class:`Types.Identifier`rdhhj^hij)}hkjhm}re(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrfhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvK8hb]rgj)rh}ri(hgjdhm}rj(ho]hp]rk(jjfXpy-classrlehq]hr]ht]uhhjbhb]rmhXTypes.Identifierrnro}rp(hgUhhjhubahkjubaubahkhubahkhubehkhubh)rq}rr(hgUhm}rs(ho]hp]hq]hr]ht]uhhjhb]rt(h)ru}rv(hgXRaiseshhjqhij)}hkhhm}rw(ho]hp]hq]hr]ht]uhvKhb]rxhXRaisesryrz}r{(hgUhhjuubaubh)r|}r}(hgUhm}r~(ho]hp]hq]hr]ht]uhhjqhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj|hb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4490)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4490)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4490)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4480)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4480)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4480)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rÁh)rā}rŁ(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4440)The supplied subject does not have permission to change ownership of the objecthm}rƁ(ho]hp]hq]hr]ht]uhhjhb]rǁ(j)rȁ}rɁ(hgUhm}rʁ(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrˁU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjāhb]ŕj")ŕ}r΁(hgjˁhm}rρ(ho]hp]hq]hr]ht]uhhjȁhb]rЁhXExceptions.NotAuthorizedrсrҁ}rӁ(hgUhhj́ubahkj"ubahkjubhX -- rԁrՁ}rց(hgUhhjāubh)rׁ}r؁(hgX$``(errorCode=401, detailCode=4440)``rفhhjāhij)}hkhhm}rځ(ho]hp]hq]hr]ht]uhvK>hb]rہj)r܁}r݁(hgjفhm}rށ(ho]hp]hq]hr]ht]uhhjׁhb]r߁hX (errorCode=401, detailCode=4440)rr}r(hgUhhj܁ubahkjubaubh)r}r(hgXOThe supplied subject does not have permission to change ownership of the objectrhhjāhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK@hb]rhXOThe supplied subject does not have permission to change ownership of the objectrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXpExceptions.NotFound -- (errorCode=404, detailCode=4460)The specified object does not exist in the DataONE systemhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=4460)``rhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKBhb]rj)r}r(hgjhm}r (ho]hp]hq]hr]ht]uhhjhb]r hX (errorCode=404, detailCode=4460)r r }r (hgUhhjubahkjubaubh)r}r(hgX9The specified object does not exist in the DataONE systemrhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKDhb]rhX9The specified object does not exist in the DataONE systemrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4441)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r (Ureftypej#j"U reftargetXExceptions.NotImplementedr!U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjhb]r"j")r#}r$(hgj!hm}r%(ho]hp]hq]hr]ht]uhhjhb]r&hXExceptions.NotImplementedr'r(}r)(hgUhhj#ubahkj"ubahkjubhX -- r*r+}r,(hgUhhjubj)r-}r.(hgX$``(errorCode=501, detailCode=4441)``hm}r/(ho]hp]hq]hr]ht]uhhjhb]r0hX (errorCode=501, detailCode=4441)r1r2}r3(hgUhhj-ubahkjubehkhubahkj;#ubj#)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7h)r8}r9(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4442)hm}r:(ho]hp]hq]hr]ht]uhhj4hb]r;(j)r<}r=(hgUhm}r>(Ureftypej#j"U reftargetXExceptions.InvalidRequestr?U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhj8hb]r@j")rA}rB(hgj?hm}rC(ho]hp]hq]hr]ht]uhhj<hb]rDhXExceptions.InvalidRequestrErF}rG(hgUhhjAubahkj"ubahkjubhX -- rHrI}rJ(hgUhhj8ubj)rK}rL(hgX$``(errorCode=400, detailCode=4442)``hm}rM(ho]hp]hq]hr]ht]uhhj8hb]rNhX (errorCode=400, detailCode=4442)rOrP}rQ(hgUhhjKubahkjubehkhubahkj;#ubj#)rR}rS(hgUhm}rT(ho]hp]hq]hr]ht]uhhjhb]rUh)rV}rW(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4443)The serialVersion supplied with the request does not match the serialVersion of the targethm}rX(ho]hp]hq]hr]ht]uhhjRhb]rY(j)rZ}r[(hgUhm}r\(Ureftypej#j"U reftargetXExceptions.VersionMismatchr]U refdomainjyhr]hq]U refexplicitho]hp]ht]uhhjVhb]r^j")r_}r`(hgj]hm}ra(ho]hp]hq]hr]ht]uhhjZhb]rbhXExceptions.VersionMismatchrcrd}re(hgUhhj_ubahkj"ubahkjubhX -- rfrg}rh(hgUhhjVubh)ri}rj(hgX$``(errorCode=409, detailCode=4443)``rkhhjVhij)}hkhhm}rl(ho]hp]hq]hr]ht]uhvKJhb]rmj)rn}ro(hgjkhm}rp(ho]hp]hq]hr]ht]uhhjihb]rqhX (errorCode=409, detailCode=4443)rrrs}rt(hgUhhjnubahkjubaubh)ru}rv(hgXZThe serialVersion supplied with the request does not match the serialVersion of the targetrwhhjVhij)}hkhhm}rx(ho]hp]hq]hr]ht]uhvKLhb]ryhXZThe serialVersion supplied with the request does not match the serialVersion of the targetrzr{}r|(hgjwhhjuubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}}r~(hgUhhj}hiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX*isAuthorized() (in module CNAuthorization)hUNtrauhvNhwhhb]ubj!)r}r(hgUhhj}hiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX*isAuthorized(session,id,action) -> booleanhhjhij)}hkj "hm}r(hr]rhaj"jB}hq]ho]hp]ht]rhaj"X isAuthorizedrj"Uj"uhvKhwhhb]r(j")r}r(hgXCNAuthorization.hhjhij)}hkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNAuthorization.rr}r(hgUhhjubaubj")r}r(hgjhhjhij)}hkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX isAuthorizedrr}r(hgUhhjubaubj'")r}r(hgXsession, id, actionhhjhij)}hkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj5"ubj-")r}r(hgXactionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXactionrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjhij)}hkj9"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjhij)}hkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r‚(hgXjTest if the user identified by the provided token has authorization for operation on the specified object.rÂhhjhij)}hkhhm}rĂ(ho]hp]hq]hr]ht]uhvKShwhhb]rłhXjTest if the user identified by the provided token has authorization for operation on the specified object.rƂrǂ}rȂ(hgjÂhhjubaubh)rɂ}rʂ(hgXCA successful operation is indicated by a return HTTP status of 200.r˂hhjhij)}hkhhm}r̂(ho]hp]hq]hr]ht]uhvKUhwhhb]r͂hXCA successful operation is indicated by a return HTTP status of 200.r΂rς}rЂ(hgj˂hhjɂubaubh)rт}r҂(hgXQFailure is indicated by an exception such as :exc:`NotAuthorized` being returned.hhjhij)}hkhhm}rӂ(ho]hp]hq]hr]ht]uhvKWhwhhb]rԂ(hX-Failure is indicated by an exception such as rՂrւ}rׂ(hgX-Failure is indicated by an exception such as hhjтubj)r؂}rق(hgX:exc:`NotAuthorized`rڂhhjтhij)}hkjhm}rۂ(UreftypeXexcjjX NotAuthorizedU refdomainXpyr܂hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKWhb]r݂j)rނ}r߂(hgjڂhm}r(ho]hp]r(jj܂Xpy-excrehq]hr]ht]uhhj؂hb]rhX NotAuthorizedrr}r(hgUhhjނubahkjubaubhX being returned.rr}r(hgX being returned.hhjтubeubh)r}r(hgXA successful response is indicated by a response HTTP status of 200. The body of the response is arbitrary and SHOULD be ignored by the caller.rhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKYhwhhb]rhXA successful response is indicated by a response HTTP status of 200. The body of the response is arbitrary and SHOULD be ignored by the caller.rr}r(hgjhhjubaubh)r}r(hgXVIf the action is not authorized, then a :exc:`NotAuthorized` exception MUST be raised.hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvK[hwhhb]r(hX(If the action is not authorized, then a rr}r(hgX(If the action is not authorized, then a hhjubj)r}r(hgX:exc:`NotAuthorized`rhhjhij)}hkjhm}r(UreftypeXexcjjX NotAuthorizedU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvK[hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-excrehq]hr]ht]uhhjhb]rhX NotAuthorizedrr}r(hgUhhjubahkjubaubhX exception MUST be raised.rr }r (hgX exception MUST be raised.hhjubeubh)r }r (hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhjhij)}hkhhm}r (ho]hp]hq]hr]ht]uhvK]hwhhb]r(hX'v2.0: The supplied identifier may be a rr}r(hgX'v2.0: The supplied identifier may be a hhj ubj)r}r(hgX :term:`PID`rhhj hij)}hkjhm}r(UreftypeXtermjjXpidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK]hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXPIDrr}r (hgUhhjubahkji2ubaubhX or a r!r"}r#(hgX or a hhj ubj)r$}r%(hgX :term:`SID`r&hhj hij)}hkjhm}r'(UreftypeXtermjjXsidU refdomainXstdr(hr]hq]U refexplicitho]hp]ht]jjuhvK]hb]r)j`2)r*}r+(hgj&hm}r,(ho]hp]r-(jj(Xstd-termr.ehq]hr]ht]uhhj$hb]r/hXSIDr0r1}r2(hgUhhj*ubahkji2ubaubhX.r3}r4(hgX.hhj ubeubh)r5}r6(hgUhhjhiNhkhhm}r7(ho]hp]hq]hr]ht]uhvNhwhhb]r8(h)r9}r:(hgUhhj5hij)}hkhhm}r;(ho]hp]hq]hr]ht]uhvK_hwhhb]r<(h)r=}r>(hgXVersionhhj9hij)}hkhhm}r?(ho]hp]hq]hr]ht]uhvKhb]r@hXVersionrArB}rC(hgUhhj=ubaubh)rD}rE(hgX1.0, 2.0rFhm}rG(ho]hp]hq]hr]ht]uhhj9hb]rHh)rI}rJ(hgjFhhjDhij)}hkhhm}rK(ho]hp]hq]hr]ht]uhvK_hb]rLhX1.0, 2.0rMrN}rO(hgjFhhjIubaubahkhubeubh)rP}rQ(hgUhhj5hij)}hkhhm}rR(ho]hp]hq]hr]ht]uhvK`hwhhb]rS(h)rT}rU(hgX Use CaseshhjPhij)}hkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rWhX Use CasesrXrY}rZ(hgUhhjTubaubh)r[}r\(hgX:doc:`UC01 `, :doc:`UC02 `, :doc:`UC36 `, :doc:`UC37 `r]hm}r^(ho]hp]hq]hr]ht]uhhjPhb]r_h)r`}ra(hgj]hhj[hij)}hkhhm}rb(ho]hp]hq]hr]ht]uhvKahb]rc(j)rd}re(hgX$:doc:`UC01 `rfhhj`hij)}hkjhm}rg(UreftypeXdocrhjjX/design/UseCases/01_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKahb]rij`2)rj}rk(hgjfhm}rl(ho]hp]rm(jjhehq]hr]ht]uhhjdhb]rnhXUC01rorp}rq(hgUhhjjubahkji2ubaubhX, rrrs}rt(hgX, hhj`ubj)ru}rv(hgX$:doc:`UC02 `rwhhj`hij)}hkjhm}rx(UreftypeXdocryjjX/design/UseCases/02_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKahb]rzj`2)r{}r|(hgjwhm}r}(ho]hp]r~(jjyehq]hr]ht]uhhjuhb]rhXUC02rr}r(hgUhhj{ubahkji2ubaubhX, rr}r(hgX, hhj`ubj)r}r(hgX$:doc:`UC36 `rhhj`hij)}hkjhm}r(UreftypeXdocrjjX/design/UseCases/36_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKahb]rj`2)r}r(hgjhm}r(ho]hp]r(jjehq]hr]ht]uhhjhb]rhXUC36rr}r(hgUhhjubahkji2ubaubhX, rr}r(hgX, hhj`ubj)r}r(hgX$:doc:`UC37 `rhhj`hij)}hkjhm}r(UreftypeXdocrjjX/design/UseCases/37_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKahb]rj`2)r}r(hgjhm}r(ho]hp]r(jjehq]hr]ht]uhhjhb]rhXUC37rr}r(hgUhhjubahkji2ubaubeubahkhubeubh)r}r(hgUhhj5hij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKbhwhhb]r(h)r}r(hgXREST URLhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX*``GET /isAuthorized/{id}?action={action}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKbhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX&GET /isAuthorized/{id}?action={action}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}rƒ(ho]hp]hq]hr]ht]uhhj5hb]rÃ(h)ră}rŃ(hgX Parametershhjhij)}hkhhm}rƃ(ho]hp]hq]hr]ht]uhvKhb]rǃhX ParametersrȃrɃ}rʃ(hgUhhjăubaubh)r˃}r̃(hgUhm}r̓(ho]hp]hq]hr]ht]uhhjhb]r΃j #)rσ}rЃ(hgUhm}rу(ho]hp]hq]hr]ht]uhhj˃hb]r҃(j#)rӃ}rԃ(hgUhm}rՃ(ho]hp]hq]hr]ht]uhhjσhb]rփh)r׃}r؃(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rك(ho]hp]hq]hr]ht]uhhjӃhb]rڃ(j")rۃ}r܃(hgXsessionhm}r݃(hr]hq]j"ho]hp]ht]uhhj׃hb]rރhXsessionr߃r}r(hgUhhjۃubahkj"ubhX (rr}r(hgUhhj׃ubj)r}r(hgX:class:`Types.Session`rhhj׃hij)}hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKdhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhj׃ubhX -- rr}r(hgUhhj׃ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj׃ubj)r}r(hgX:term:`public user`rhhj׃hij)}hkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKchb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr }r (hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r r }r (hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj׃ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjσhb]rh)r}r(hgXid (Types.Identifier) -- The identifer of the resource for which access is being checked. May be either a PID or a SID, the latter returning results as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r }r!(hgX:class:`Types.Identifier`r"hhjhij)}hkjhm}r#(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr$hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKghb]r%j)r&}r'(hgj"hm}r((ho]hp]r)(jj$Xpy-classr*ehq]hr]ht]uhhj hb]r+hXTypes.Identifierr,r-}r.(hgUhhj&ubahkjubaubhX)r/}r0(hgUhhjubhX -- r1r2}r3(hgUhhjubhXThe identifer of the resource for which access is being checked. May be either a PID or a SID, the latter returning results as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.r4r5}r6(hgXThe identifer of the resource for which access is being checked. May be either a PID or a SID, the latter returning results as if called with the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubj#)r7}r8(hgUhm}r9(ho]hp]hq]hr]ht]uhhjσhb]r:h)r;}r<(hgXaction (Types.Permission) -- The type of operation which is being requested for the given identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r=(ho]hp]hq]hr]ht]uhhj7hb]r>(j")r?}r@(hgXactionhm}rA(hr]hq]j"ho]hp]ht]uhhj;hb]rBhXactionrCrD}rE(hgUhhj?ubahkj"ubhX (rFrG}rH(hgUhhj;ubj)rI}rJ(hgX:class:`Types.Permission`rKhhj;hij)}hkjhm}rL(UreftypeXclassjjXTypes.PermissionU refdomainXpyrMhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKjhb]rNj)rO}rP(hgjKhm}rQ(ho]hp]rR(jjMXpy-classrSehq]hr]ht]uhhjIhb]rThXTypes.PermissionrUrV}rW(hgUhhjOubahkjubaubhX)rX}rY(hgUhhj;ubhX -- rZr[}r\(hgUhhj;ubhXThe type of operation which is being requested for the given identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.r]r^}r_(hgXThe type of operation which is being requested for the given identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj;ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r`}ra(hgUhm}rb(ho]hp]hq]hr]ht]uhhj5hb]rc(h)rd}re(hgXReturnshhj`hij)}hkhhm}rf(ho]hp]hq]hr]ht]uhvKhb]rghXReturnsrhri}rj(hgUhhjdubaubh)rk}rl(hgUhm}rm(ho]hp]hq]hr]ht]uhhj`hb]rnh)ro}rp(hgX True if the operation is allowedhm}rq(ho]hp]hq]hr]ht]uhhjkhb]rrhX True if the operation is allowedrsrt}ru(hgX True if the operation is allowedhhjoubahkhubahkhubehkhubh)rv}rw(hgUhm}rx(ho]hp]hq]hr]ht]uhhj5hb]ry(h)rz}r{(hgX Return typehhjvhij)}hkhhm}r|(ho]hp]hq]hr]ht]uhvKhb]r}hX Return typer~r}r(hgUhhjzubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj5hb]r(h)r}r(hgXRaiseshhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1760)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=1760)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=1760)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r„(hgUhm}rÄ(ho]hp]hq]hr]ht]uhhjhb]rĄh)rń}rƄ(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1840)hm}rDŽ(ho]hp]hq]hr]ht]uhhjhb]rȄ(j)rɄ}rʄ(hgUhm}r˄(Ureftypej#j"U reftargetXExceptions.InvalidTokenr̄U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjńhb]r̈́j")r΄}rτ(hgj̄hm}rЄ(ho]hp]hq]hr]ht]uhhjɄhb]rфhXExceptions.InvalidTokenr҄rӄ}rԄ(hgUhhj΄ubahkj"ubahkjubhX -- rՄrք}rׄ(hgUhhjńubj)r؄}rل(hgX$``(errorCode=401, detailCode=1840)``hm}rڄ(ho]hp]hq]hr]ht]uhhjńhb]rۄhX (errorCode=401, detailCode=1840)r܄r݄}rބ(hgUhhj؄ubahkjubehkhubahkj;#ubj#)r߄}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX7Exceptions.NotFound -- (errorCode=404, detailCode=1800)hm}r(ho]hp]hq]hr]ht]uhhj߄hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=404, detailCode=1800)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=1800)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=1820)This error is raised if the request comes from a black listed source (e.g. a temporary block may be imposed on a source that calls this method too many times within some time interval)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgjhm}r (ho]hp]hq]hr]ht]uhhjhb]r hXExceptions.NotAuthorizedrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=1820)``rhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKuhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=1820)rr}r(hgUhhjubahkjubaubh)r }r!(hgXThis error is raised if the request comes from a black listed source (e.g. a temporary block may be imposed on a source that calls this method too many times within some time interval)r"hhjhij)}hkhhm}r#(ho]hp]hq]hr]ht]uhvKwhb]r$hXThis error is raised if the request comes from a black listed source (e.g. a temporary block may be imposed on a source that calls this method too many times within some time interval)r%r&}r'(hgj"hhj ubaubehkhubahkj;#ubj#)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1780)hm}r.(ho]hp]hq]hr]ht]uhhj(hb]r/(j)r0}r1(hgUhm}r2(Ureftypej#j"U reftargetXExceptions.NotImplementedr3U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj,hb]r4j")r5}r6(hgj3hm}r7(ho]hp]hq]hr]ht]uhhj0hb]r8hXExceptions.NotImplementedr9r:}r;(hgUhhj5ubahkj"ubahkjubhX -- r<r=}r>(hgUhhj,ubj)r?}r@(hgX$``(errorCode=501, detailCode=1780)``hm}rA(ho]hp]hq]hr]ht]uhhj,hb]rBhX (errorCode=501, detailCode=1780)rCrD}rE(hgUhhj?ubahkjubehkhubahkj;#ubj#)rF}rG(hgUhm}rH(ho]hp]hq]hr]ht]uhhjhb]rIh)rJ}rK(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1761)hm}rL(ho]hp]hq]hr]ht]uhhjFhb]rM(j)rN}rO(hgUhm}rP(Ureftypej#j"U reftargetXExceptions.InvalidRequestrQU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjJhb]rRj")rS}rT(hgjQhm}rU(ho]hp]hq]hr]ht]uhhjNhb]rVhXExceptions.InvalidRequestrWrX}rY(hgUhhjSubahkj"ubahkjubhX -- rZr[}r\(hgUhhjJubj)r]}r^(hgX$``(errorCode=400, detailCode=1761)``hm}r_(ho]hp]hq]hr]ht]uhhjJhb]r`hX (errorCode=400, detailCode=1761)rarb}rc(hgUhhj]ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rd}re(hgUhhj}hiNhkjhm}rf(hr]hq]ho]hp]ht]Uentries]rg(jX-setAccessPolicy() (in module CNAuthorization)h,UNtrhauhvNhwhhb]ubj!)ri}rj(hgUhhj}hiNhkj!hm}rk(j"j"Xpyrlhr]hq]ho]hp]ht]j"Xfunctionrmj"jmuhvNhwhhb]rn(j")ro}rp(hgXAsetAccessPolicy(session,id,accessPolicy,serialVersion) -> booleanhhjihiXJinternal padding after source/apis/generated/generated_CNAuthorization.txtrqhkj "hm}rr(hr]rsh,aj"jB}hq]ho]hp]ht]rth,aj"XsetAccessPolicyruj"Uj"uhvKhwhhb]rv(j")rw}rx(hgXCNAuthorization.hhjohijqhkj"hm}ry(ho]hp]hq]hr]ht]uhvKhwhhb]rzhXCNAuthorization.r{r|}r}(hgUhhjwubaubj")r~}r(hgjuhhjohijqhkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXsetAccessPolicyrr}r(hgUhhj~ubaubj'")r}r(hgX(session, id, accessPolicy, serialVersionhhjohijqhkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj5"ubj-")r}r(hgX accessPolicyhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX accessPolicyrr}r(hgUhhjubahkj5"ubj-")r}r(hgX serialVersionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjohijqhkj9"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjihijqhkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgX=Sets the access permissions for an object identified by *id*.hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(hX8Sets the access permissions for an object identified by rr}r(hgX8Sets the access permissions for an object identified by hhjubj$)r}r(hgX*id*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXidrr}r(hgUhhjubahkj$ubhX.r}r(hgX.hhjubeubh)r}r(hgX=Triggers a change to the system metadata modified time stamp.r…hhjhij)}hkhhm}rÅ(ho]hp]hq]hr]ht]uhvKhwhhb]rąhX=Triggers a change to the system metadata modified time stamp.rŅrƅ}rDž(hgj…hhjubaubh)rȅ}rɅ(hgX[Successful completion of this operation is indicated by a HTTP response status code of 200.rʅhhjhij)}hkhhm}r˅(ho]hp]hq]hr]ht]uhvKhwhhb]r̅hX[Successful completion of this operation is indicated by a HTTP response status code of 200.rͅr΅}rυ(hgjʅhhjȅubaubh)rЅ}rх(hgXUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception such as :exc:`NotAuthorized`.hhjhij)}hkhhm}r҅(ho]hp]hq]hr]ht]uhvKhwhhb]rӅ(hXjUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception such as rԅrՅ}rօ(hgXjUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception such as hhjЅubj)rׅ}r؅(hgX:exc:`NotAuthorized`rمhhjЅhij)}hkjhm}rڅ(UreftypeXexcjjX NotAuthorizedU refdomainXpyrۅhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]r܅j)r݅}rޅ(hgjمhm}r߅(ho]hp]r(jjۅXpy-excrehq]hr]ht]uhhjׅhb]rhX NotAuthorizedrr}r(hgUhhj݅ubahkjubaubhX.r}r(hgX.hhjЅubeubh)r}r(hgXDv2.0: The supplied identifier may be a :term:`PID` or a :term:`SID`.hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(hX'v2.0: The supplied identifier may be a rr}r(hgX'v2.0: The supplied identifier may be a hhjubj)r}r(hgX :term:`PID`rhhjhij)}hkjhm}r(UreftypeXtermjjXpidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXPIDrr}r(hgUhhjubahkji2ubaubhX or a rr}r(hgX or a hhjubj)r}r(hgX :term:`SID`rhhjhij)}hkjhm}r(UreftypeXtermjjXsidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r (ho]hp]r (jjXstd-termr ehq]hr]ht]uhhjhb]r hXSIDr r}r(hgUhhjubahkji2ubaubhX.r}r(hgX.hhjubeubh)r}r(hgUhhjhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXVersionhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r (hgUhhjubaubh)r!}r"(hgX1.0, 2.0r#hm}r$(ho]hp]hq]hr]ht]uhhjhb]r%h)r&}r'(hgj#hhj!hij)}hkhhm}r((ho]hp]hq]hr]ht]uhvKhb]r)hX1.0, 2.0r*r+}r,(hgj#hhj&ubaubahkhubeubh)r-}r.(hgUhhjhij)}hkhhm}r/(ho]hp]hq]hr]ht]uhvKhwhhb]r0(h)r1}r2(hgX Use Caseshhj-hij)}hkhhm}r3(ho]hp]hq]hr]ht]uhvKhb]r4hX Use Casesr5r6}r7(hgUhhj1ubaubh)r8}r9(hgX$:doc:`UC16 `r:hm}r;(ho]hp]hq]hr]ht]uhhj-hb]r<h)r=}r>(hgj:hhj8hij)}hkhhm}r?(ho]hp]hq]hr]ht]uhvKhb]r@j)rA}rB(hgj:hhj=hij)}hkjhm}rC(UreftypeXdocrDjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rEj`2)rF}rG(hgj:hm}rH(ho]hp]rI(jjDehq]hr]ht]uhhjAhb]rJhXUC16rKrL}rM(hgUhhjFubahkji2ubaubaubahkhubeubh)rN}rO(hgUhhjhij)}hkhhm}rP(ho]hp]hq]hr]ht]uhvKhwhhb]rQ(h)rR}rS(hgXREST URLhhjNhij)}hkhhm}rT(ho]hp]hq]hr]ht]uhvKhb]rUhXREST URLrVrW}rX(hgUhhjRubaubh)rY}rZ(hgX``PUT /accessRules/{id}``r[hm}r\(ho]hp]hq]hr]ht]uhhjNhb]r]h)r^}r_(hgj[hhjYhij)}hkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]raj)rb}rc(hgj[hm}rd(ho]hp]hq]hr]ht]uhhj^hb]rehXPUT /accessRules/{id}rfrg}rh(hgUhhjbubahkjubaubahkhubeubh)ri}rj(hgUhm}rk(ho]hp]hq]hr]ht]uhhjhb]rl(h)rm}rn(hgX Parametershhjihijqhkhhm}ro(ho]hp]hq]hr]ht]uhvKhb]rphX Parametersrqrr}rs(hgUhhjmubaubh)rt}ru(hgUhm}rv(ho]hp]hq]hr]ht]uhhjihb]rwj #)rx}ry(hgUhm}rz(ho]hp]hq]hr]ht]uhhjthb]r{(j#)r|}r}(hgUhm}r~(ho]hp]hq]hr]ht]uhhjxhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhj|hb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhij)}hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhij)}hkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjxhb]rh)r}r(hgXid (Types.Identifier) -- The object for which access control is being updated. May be either a PID or a SID, the latter acting on the HEAD PID only. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]r†hXidrÆrĆ}rņ(hgUhhjubahkj"ubhX (rƆrdž}rȆ(hgUhhjubj)rɆ}rʆ(hgX:class:`Types.Identifier`rˆhhjhij)}hkjhm}r̆(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr͆hr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rΆj)rφ}rІ(hgjˆhm}rц(ho]hp]r҆(jj͆Xpy-classrӆehq]hr]ht]uhhjɆhb]rԆhXTypes.IdentifierrՆrֆ}r׆(hgUhhjφubahkjubaubhX)r؆}rن(hgUhhjubhX -- rچrۆ}r܆(hgUhhjubhXThe object for which access control is being updated. May be either a PID or a SID, the latter acting on the HEAD PID only. Transmitted as part of the URL path and must be escaped accordingly.r݆rކ}r߆(hgXThe object for which access control is being updated. May be either a PID or a SID, the latter acting on the HEAD PID only. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjxhb]rh)r}r(hgXaccessPolicy (Types.AccessPolicy) -- The desired privileges to be assigned to the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgX accessPolicyhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhX accessPolicyrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.AccessPolicy`rhhjhij)}hkjhm}r(UreftypeXclassjjXTypes.AccessPolicyU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjjB}uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.AccessPolicyrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXThe desired privileges to be assigned to the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXThe desired privileges to be assigned to the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)r }r (hgX *File part*hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX File partr r}r(hgUhhj ubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjxhb]rh)r}r(hgXserialVersion (unsigned long) -- The serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgX serialVersionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhX serialVersionrr }r!(hgUhhjubahkj"ubhX (r"r#}r$(hgUhhjubj)r%}r&(hgUhm}r'(Ureftypej&j"U reftargetX unsigned longr(U refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjhb]r)j&)r*}r+(hgj(hm}r,(ho]hp]hq]hr]ht]uhhj%hb]r-hX unsigned longr.r/}r0(hgUhhj*ubahkj&ubahkjubhX)r1}r2(hgUhhjubhX -- r3r4}r5(hgUhhjubhXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a r6r7}r8(hgXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a hhjubj$)r9}r:(hgX *Param part*hm}r;(ho]hp]hq]hr]ht]uhhjhb]r<hX Param partr=r>}r?(hgUhhj9ubahkj$ubhX% of the MIME multipart/mixed message.r@rA}rB(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)rC}rD(hgUhm}rE(ho]hp]hq]hr]ht]uhhjhb]rF(h)rG}rH(hgXReturnshhjChijqhkhhm}rI(ho]hp]hq]hr]ht]uhvKhb]rJhXReturnsrKrL}rM(hgUhhjGubaubh)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhjChb]rQh)rR}rS(hgX0True if the operation succeeds, otherwise false.hm}rT(ho]hp]hq]hr]ht]uhhjNhb]rUhX0True if the operation succeeds, otherwise false.rVrW}rX(hgX0True if the operation succeeds, otherwise false.hhjRubahkhubahkhubehkhubh)rY}rZ(hgUhm}r[(ho]hp]hq]hr]ht]uhhjhb]r\(h)r]}r^(hgX Return typehhjYhijqhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r`hX Return typerarb}rc(hgUhhj]ubaubh)rd}re(hgUhm}rf(ho]hp]hq]hr]ht]uhhjYhb]rgh)rh}ri(hgXbooleanhm}rj(ho]hp]hq]hr]ht]uhhjdhb]rkj)rl}rm(hgUhm}rn(Ureftypej&j"U reftargetXbooleanU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjhhb]rohXbooleanrprq}rr(hgUhhjlubahkjubahkhubahkhubehkhubh)rs}rt(hgUhm}ru(ho]hp]hq]hr]ht]uhhjhb]rv(h)rw}rx(hgXRaiseshhjshijqhkhhm}ry(ho]hp]hq]hr]ht]uhvKhb]rzhXRaisesr{r|}r}(hgUhhjwubaubh)r~}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjshb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXXExceptions.InvalidToken -- (errorCode=401, detailCode=4410)The supplied token is invalidhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4410)``rhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4410)rr}r(hgUhhjubahkjubaubh)r}r(hgXThe supplied token is invalidrhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXThe supplied token is invalidrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4430)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurer‡rÇ}rć(hgUhhjubahkj"ubahkjubhX -- rŇrƇ}rLJ(hgUhhjubj)rȇ}rɇ(hgX$``(errorCode=500, detailCode=4430)``hm}rʇ(ho]hp]hq]hr]ht]uhhjhb]rˇhX (errorCode=500, detailCode=4430)ṙr͇}r·(hgUhhjȇubahkjubehkhubahkj;#ubj#)rχ}rЇ(hgUhm}rч(ho]hp]hq]hr]ht]uhhjhb]r҇h)rӇ}rԇ(hgXpExceptions.NotFound -- (errorCode=404, detailCode=4400)The specified object does not exist in the DataONE systemhm}rՇ(ho]hp]hq]hr]ht]uhhjχhb]rև(j)rׇ}r؇(hgUhm}rه(Ureftypej#j"U reftargetXExceptions.NotFoundrڇU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjӇhb]rۇj")r܇}r݇(hgjڇhm}rއ(ho]hp]hq]hr]ht]uhhjׇhb]r߇hXExceptions.NotFoundrr}r(hgUhhj܇ubahkj"ubahkjubhX -- rr}r(hgUhhjӇubh)r}r(hgX$``(errorCode=404, detailCode=4400)``rhhjӇhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=4400)rr}r(hgUhhjubahkjubaubh)r}r(hgX9The specified object does not exist in the DataONE systemrhhjӇhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX9The specified object does not exist in the DataONE systemrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4420)The Subject does not have permission to alter access control rules for the object.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r (ho]hp]hq]hr]ht]uhhjhb]r hXExceptions.NotAuthorizedr r }r (hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4420)``rhhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4420)rr}r(hgUhhjubahkjubaubh)r}r(hgXZThe :term:`Subject` does not have permission to alter access control rules for the object.hhjhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r (hXThe r!r"}r#(hgXThe hhjubj)r$}r%(hgX:term:`Subject`r&hhjhij)}hkjhm}r'(UreftypeXtermjjXsubjectU refdomainXstdr(hr]hq]U refexplicitho]hp]ht]jjuhvKhb]r)j`2)r*}r+(hgj&hm}r,(ho]hp]r-(jj(Xstd-termr.ehq]hr]ht]uhhj$hb]r/hXSubjectr0r1}r2(hgUhhj*ubahkji2ubaubhXG does not have permission to alter access control rules for the object.r3r4}r5(hgXG does not have permission to alter access control rules for the object.hhjubeubehkhubahkj;#ubj#)r6}r7(hgUhm}r8(ho]hp]hq]hr]ht]uhhjhb]r9h)r:}r;(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4401)hm}r<(ho]hp]hq]hr]ht]uhhj6hb]r=(j)r>}r?(hgUhm}r@(Ureftypej#j"U reftargetXExceptions.NotImplementedrAU refdomainjlhr]hq]U refexplicitho]hp]ht]uhhj:hb]rBj")rC}rD(hgjAhm}rE(ho]hp]hq]hr]ht]uhhj>hb]rFhXExceptions.NotImplementedrGrH}rI(hgUhhjCubahkj"ubahkjubhX -- rJrK}rL(hgUhhj:ubj)rM}rN(hgX$``(errorCode=501, detailCode=4401)``hm}rO(ho]hp]hq]hr]ht]uhhj:hb]rPhX (errorCode=501, detailCode=4401)rQrR}rS(hgUhhjMubahkjubehkhubahkj;#ubj#)rT}rU(hgUhm}rV(ho]hp]hq]hr]ht]uhhjhb]rWh)rX}rY(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4402)hm}rZ(ho]hp]hq]hr]ht]uhhjThb]r[(j)r\}r](hgUhm}r^(Ureftypej#j"U reftargetXExceptions.InvalidRequestr_U refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjXhb]r`j")ra}rb(hgj_hm}rc(ho]hp]hq]hr]ht]uhhj\hb]rdhXExceptions.InvalidRequestrerf}rg(hgUhhjaubahkj"ubahkjubhX -- rhri}rj(hgUhhjXubj)rk}rl(hgX$``(errorCode=400, detailCode=4402)``hm}rm(ho]hp]hq]hr]ht]uhhjXhb]rnhX (errorCode=400, detailCode=4402)rorp}rq(hgUhhjkubahkjubehkhubahkj;#ubj#)rr}rs(hgUhm}rt(ho]hp]hq]hr]ht]uhhjhb]ruh)rv}rw(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4403)The serialVersion supplied with the request does not match the serialVersion of the targethm}rx(ho]hp]hq]hr]ht]uhhjrhb]ry(j)rz}r{(hgUhm}r|(Ureftypej#j"U reftargetXExceptions.VersionMismatchr}U refdomainjlhr]hq]U refexplicitho]hp]ht]uhhjvhb]r~j")r}r(hgj}hm}r(ho]hp]hq]hr]ht]uhhjzhb]rhXExceptions.VersionMismatchrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjvubh)r}r(hgX$``(errorCode=409, detailCode=4403)``rhhjvhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=409, detailCode=4403)rr}r(hgUhhjubahkjubaubh)r}r(hgXZThe serialVersion supplied with the request does not match the serialVersion of the targetrhhjvhij)}hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXZThe serialVersion supplied with the request does not match the serialVersion of the targetrr}r(hgjhhjubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubeubhd)r}r(hgUhhhehihjhkhlhm}r(ho]hp]hq]hr]r(Xmodule-CNIdentityrh\eht]rh2auhvKbhwhhb]r(hy)r}r(hgX Identity APIrhhjhihjhkh}hm}r(ho]hp]hq]hr]ht]uhvKbhwhhb]rhX Identity APIrr}r(hgjhhjubaubj)r}r(hgUhhjhihjhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jXCNIdentity (module)Xmodule-CNIdentityUNtrauhvNhwhhb]ubj)r}r(hgXBWarning: this file is automatically generated. Edits will be losthhjhijX.source/apis/generated/generated_CNIdentity.txtrr}rbhkj!hm}r(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]rhXBWarning: this file is automatically generated. Edits will be lostrr}r(hgUhhjubaubj))r}r(hgUhhjhiNhkj,hm}r(ho]hp]hq]hr]rUid7raht]uhvNhwhhb]r(hy)r}rˆ(hgX&Functions defined in :mod:`CNIdentity`hm}rÈ(ho]hp]hq]hr]ht]uhhjhb]rĈ(hXFunctions defined in rňrƈ}rLj(hgXFunctions defined in hhjubj)rȈ}rɈ(hgX:mod:`CNIdentity`rʈhhjhijhkjhm}rˈ(UreftypeXmodjjX CNIdentityU refdomainXpyr̈hr]hq]U refexplicitho]hp]ht]jjjNjX CNIdentityr͈uhvKhb]rΈj)rψ}rЈ(hgjʈhm}rш(ho]hp]r҈(jj̈Xpy-modrӈehq]hr]ht]uhhjȈhb]rԈhX CNIdentityrՈrֈ}r׈(hgUhhjψubahkjubaubehkh}ubj9)r؈}rو(hgUhm}rڈ(hr]hq]ho]hp]ht]UcolsKuhhjhb]rۈ(j>)r܈}r݈(hgUhm}rވ(hr]hq]ho]hp]ht]UcolwidthKuhhj؈hb]hkjBubj>)r߈}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthKuhhj؈hb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthK uhhj؈hb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthK uhhj؈hb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthKuhhj؈hb]hkjBubjO)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj؈hb]rjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTierrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXTierrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXVersionrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXVersionrr }r (hgjhhjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXRESTrhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXRESTrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXFunctionrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXFunctionr r!}r"(hgjhhjubaubahkjfubjY)r#}r$(hgUhm}r%(ho]hp]hq]hr]ht]uhhjhb]r&h)r'}r((hgX Parametersr)hhj#hijhkhhm}r*(ho]hp]hq]hr]ht]uhvK hb]r+hX Parametersr,r-}r.(hgj)hhj'ubaubahkjfubehkjubahkjubj)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhj؈hb]r2(jT)r3}r4(hgUhm}r5(ho]hp]hq]hr]ht]uhhj/hb]r6(jY)r7}r8(hgUhm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:h)r;}r<(hgXTier 2r=hhj7hijhkhhm}r>(ho]hp]hq]hr]ht]uhvKhb]r?hXTier 2r@rA}rB(hgj=hhj;ubaubahkjfubjY)rC}rD(hgUhm}rE(ho]hp]hq]hr]ht]uhhj3hb]rFh)rG}rH(hgX 1.0, (2.0)rIhhjChijhkhhm}rJ(ho]hp]hq]hr]ht]uhvKhb]rKhX 1.0, (2.0)rLrM}rN(hgjIhhjGubaubahkjfubjY)rO}rP(hgUhm}rQ(ho]hp]hq]hr]ht]uhhj3hb]rRh)rS}rT(hgX``POST /accounts``rUhhjOhijhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rWj)rX}rY(hgjUhm}rZ(ho]hp]hq]hr]ht]uhhjShb]r[hXPOST /accountsr\r]}r^(hgUhhjXubahkjubaubahkjfubjY)r_}r`(hgUhm}ra(ho]hp]hq]hr]ht]uhhj3hb]rbh)rc}rd(hgX:func:`registerAccount`rehhj_hijhkhhm}rf(ho]hp]hq]hr]ht]uhvKhb]rgj)rh}ri(hgjehhjchijhkjhm}rj(UreftypeXfuncjjXregisterAccountU refdomainXpyrkhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rlj)rm}rn(hgjehm}ro(ho]hp]rp(jjkXpy-funcrqehq]hr]ht]uhhjhhb]rrhXregisterAccount()rsrt}ru(hgUhhjmubahkjubaubaubahkjfubjY)rv}rw(hgUhm}rx(ho]hp]hq]hr]ht]uhhj3hb]ryh)rz}r{(hgX^(:class:`session`, :class:`person`) ``->`` :class:`Types.Subject`hhjvhijhkhhm}r|(ho]hp]hq]hr]ht]uhvKhb]r}(hX(r~}r(hgX(hhjzubj)r}r(hgX:class:`session`rhhjzhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjzubj)r}r(hgX:class:`person`rhhjzhijhkjhm}r(UreftypeXclassjjX Types.PersonU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpersonrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjzubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjzhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjzubj)r}r(hgX:class:`Types.Subject`rhhjzhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r‰(ho]hp]hq]hr]ht]uhhjhb]rÉh)rĉ}rʼn(hgXTier 2rƉhhjhijhkhhm}rlj(ho]hp]hq]hr]ht]uhvKhb]rȉhXTier 2rɉrʉ}rˉ(hgjƉhhjĉubaubahkjfubjY)r̉}r͉(hgUhm}rΉ(ho]hp]hq]hr]ht]uhhjhb]rωh)rЉ}rщ(hgX 1.0, (2.0)r҉hhj̉hijhkhhm}rӉ(ho]hp]hq]hr]ht]uhvKhb]rԉhX 1.0, (2.0)rՉr։}r׉(hgj҉hhjЉubaubahkjfubjY)r؉}rى(hgUhm}rډ(ho]hp]hq]hr]ht]uhhjhb]rۉh)r܉}r݉(hgX``PUT /accounts/{subject}``rމhhj؉hijhkhhm}r߉(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjމhm}r(ho]hp]hq]hr]ht]uhhj܉hb]rhXPUT /accounts/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`updateAccount`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX updateAccountU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXupdateAccount()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`subject`, :class:`person`) ``->`` :class:`Types.Subject`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r }r (hgX:class:`session`r hhjhijhkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgj hm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhj hb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]r j)r!}r"(hgjhm}r#(ho]hp]r$(jjXpy-classr%ehq]hr]ht]uhhjhb]r&hXsubjectr'r(}r)(hgUhhj!ubahkjubaubhX, r*r+}r,(hgX, hhjubj)r-}r.(hgX:class:`person`r/hhjhijhkjhm}r0(UreftypeXclassjjX Types.PersonU refdomainXpyr1hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]r2j)r3}r4(hgj/hm}r5(ho]hp]r6(jj1Xpy-classr7ehq]hr]ht]uhhj-hb]r8hXpersonr9r:}r;(hgUhhj3ubahkjubaubhX) r<r=}r>(hgX) hhjubj)r?}r@(hgX``->``hm}rA(ho]hp]hq]hr]ht]uhhjhb]rBhX->rCrD}rE(hgUhhj?ubahkjubhX rF}rG(hgX hhjubj)rH}rI(hgX:class:`Types.Subject`rJhhjhijhkjhm}rK(UreftypeXclassjjX Types.SubjectU refdomainXpyrLhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rMj)rN}rO(hgjJhm}rP(ho]hp]rQ(jjLXpy-classrRehq]hr]ht]uhhjHhb]rShX Types.SubjectrTrU}rV(hgUhhjNubahkjubaubeubahkjfubehkjubjT)rW}rX(hgUhm}rY(ho]hp]hq]hr]ht]uhhj/hb]rZ(jY)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjWhb]r^h)r_}r`(hgXTier 2rahhj[hijhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rchXTier 2rdre}rf(hgjahhj_ubaubahkjfubjY)rg}rh(hgUhm}ri(ho]hp]hq]hr]ht]uhhjWhb]rjh)rk}rl(hgX 1.0, (2.0)rmhhjghijhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rohX 1.0, (2.0)rprq}rr(hgjmhhjkubaubahkjfubjY)rs}rt(hgUhm}ru(ho]hp]hq]hr]ht]uhhjWhb]rvh)rw}rx(hgX(``PUT /accounts/verification/{subject}``ryhhjshijhkhhm}rz(ho]hp]hq]hr]ht]uhvKhb]r{j)r|}r}(hgjyhm}r~(ho]hp]hq]hr]ht]uhhjwhb]rhX$PUT /accounts/verification/{subject}rr}r(hgUhhj|ubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjWhb]rh)r}r(hgX:func:`verifyAccount`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX verifyAccountU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXverifyAccount()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjWhb]rh)r}r(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrŠrÊ}rĊ(hgUhhjubahkjubaubhX) rŊrƊ}rNJ(hgX) hhjubj)rȊ}rɊ(hgX``->``hm}rʊ(ho]hp]hq]hr]ht]uhhjhb]rˊhX->r̊r͊}rΊ(hgUhhjȊubahkjubhX booleanrϊrЊ}rъ(hgX booleanhhjubeubahkjfubehkjubjT)rҊ}rӊ(hgUhm}rԊ(ho]hp]hq]hr]ht]uhhj/hb]rՊ(jY)r֊}r׊(hgUhm}r؊(ho]hp]hq]hr]ht]uhhjҊhb]rيh)rڊ}rۊ(hgXTier 2r܊hhj֊hijhkhhm}r݊(ho]hp]hq]hr]ht]uhvKhb]rފhXTier 2rߊr}r(hgj܊hhjڊubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjҊhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjҊhb]rh)r}r(hgX``GET /accounts/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /accounts/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjҊhb]rh)r}r(hgX:func:`getSubjectInfo`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rj)r}r(hgjhhjhijhkjhm}r (UreftypeXfuncjjXgetSubjectInfoU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK hb]r j)r }r (hgjhm}r(ho]hp]r(jj Xpy-funcrehq]hr]ht]uhhjhb]rhXgetSubjectInfo()rr}r(hgUhhj ubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjҊhb]rh)r}r(hgXd(:class:`session`, :class:`subject`) ``->`` :class:`Types.SubjectInfo`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK!hb]r(hX(r}r(hgX(hhjubj)r}r (hgX:class:`session`r!hhjhijhkjhm}r"(UreftypeXclassjjX Types.SessionU refdomainXpyr#hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK!hb]r$j)r%}r&(hgj!hm}r'(ho]hp]r((jj#Xpy-classr)ehq]hr]ht]uhhjhb]r*hXsessionr+r,}r-(hgUhhj%ubahkjubaubhX, r.r/}r0(hgX, hhjubj)r1}r2(hgX:class:`subject`r3hhjhijhkjhm}r4(UreftypeXclassjjX Types.SubjectU refdomainXpyr5hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK!hb]r6j)r7}r8(hgj3hm}r9(ho]hp]r:(jj5Xpy-classr;ehq]hr]ht]uhhj1hb]r<hXsubjectr=r>}r?(hgUhhj7ubahkjubaubhX) r@rA}rB(hgX) hhjubj)rC}rD(hgX``->``hm}rE(ho]hp]hq]hr]ht]uhhjhb]rFhX->rGrH}rI(hgUhhjCubahkjubhX rJ}rK(hgX hhjubj)rL}rM(hgX:class:`Types.SubjectInfo`rNhhjhijhkjhm}rO(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK!hb]rQj)rR}rS(hgjNhm}rT(ho]hp]rU(jjPXpy-classrVehq]hr]ht]uhhjLhb]rWhXTypes.SubjectInforXrY}rZ(hgUhhjRubahkjubaubeubahkjfubehkjubjT)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhj/hb]r^(jY)r_}r`(hgUhm}ra(ho]hp]hq]hr]ht]uhhj[hb]rbh)rc}rd(hgXTier 2rehhj_hijhkhhm}rf(ho]hp]hq]hr]ht]uhvK"hb]rghXTier 2rhri}rj(hgjehhjcubaubahkjfubjY)rk}rl(hgUhm}rm(ho]hp]hq]hr]ht]uhhj[hb]rnh)ro}rp(hgX 1.0, (2.0)rqhhjkhijhkhhm}rr(ho]hp]hq]hr]ht]uhvK#hb]rshX 1.0, (2.0)rtru}rv(hgjqhhjoubaubahkjfubjY)rw}rx(hgUhm}ry(ho]hp]hq]hr]ht]uhhj[hb]rzh)r{}r|(hgXM``GET /accounts?query={query}[&status={status}&start={start}&count={count}]``r}hhjwhijhkhhm}r~(ho]hp]hq]hr]ht]uhvK$hb]rj)r}r(hgj}hm}r(ho]hp]hq]hr]ht]uhhj{hb]rhXIGET /accounts?query={query}[&status={status}&start={start}&count={count}]rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj[hb]rh)r}r(hgX:func:`listSubjects`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK%hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX listSubjectsU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK%hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXlistSubjects()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj[hb]rh)r}r(hgXp(:class:`session`, ``query``, ``status``, ``start``, ``count``) ``->`` :class:`Types.SubjectInfo`hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK&hb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX ``query``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXqueryrr}r(hgUhhjubahkjubhX, rr‹}rË(hgX, hhjubj)rċ}rŋ(hgX ``status``hm}rƋ(ho]hp]hq]hr]ht]uhhjhb]rNjhXstatusrȋrɋ}rʋ(hgUhhjċubahkjubhX, rˋr̋}r͋(hgX, hhjubj)r΋}rϋ(hgX ``start``hm}rЋ(ho]hp]hq]hr]ht]uhhjhb]rыhXstartrҋrӋ}rԋ(hgUhhj΋ubahkjubhX, rՋr֋}r׋(hgX, hhjubj)r؋}rً(hgX ``count``hm}rڋ(ho]hp]hq]hr]ht]uhhjhb]rۋhXcountr܋r݋}rދ(hgUhhj؋ubahkjubhX) rߋr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.SubjectInfo`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.SubjectInforr}r(hgUhhjubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK'hb]rhXTier 2rr}r (hgjhhjubaubahkjfubjY)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r}r(hgX 1.0, (2.0)rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvK(hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /accounts/map``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK)hb]rj)r}r (hgjhm}r!(ho]hp]hq]hr]ht]uhhjhb]r"hXPOST /accounts/mapr#r$}r%(hgUhhjubahkjubaubahkjfubjY)r&}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhjhb]r)h)r*}r+(hgX:func:`mapIdentity`r,hhj&hijhkhhm}r-(ho]hp]hq]hr]ht]uhvK*hb]r.j)r/}r0(hgj,hhj*hijhkjhm}r1(UreftypeXfuncjjX mapIdentityU refdomainXpyr2hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK*hb]r3j)r4}r5(hgj,hm}r6(ho]hp]r7(jj2Xpy-funcr8ehq]hr]ht]uhhj/hb]r9hX mapIdentity()r:r;}r<(hgUhhj4ubahkjubaubaubahkjfubjY)r=}r>(hgUhm}r?(ho]hp]hq]hr]ht]uhhjhb]r@h)rA}rB(hgX(:class:`session`, :class:`primarySubject`, :class:`secondarySubject`) ``->`` booleanhhj=hijhkhhm}rC(ho]hp]hq]hr]ht]uhvK+hb]rD(hX(rE}rF(hgX(hhjAubj)rG}rH(hgX:class:`session`rIhhjAhijhkjhm}rJ(UreftypeXclassjjX Types.SessionU refdomainXpyrKhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK+hb]rLj)rM}rN(hgjIhm}rO(ho]hp]rP(jjKXpy-classrQehq]hr]ht]uhhjGhb]rRhXsessionrSrT}rU(hgUhhjMubahkjubaubhX, rVrW}rX(hgX, hhjAubj)rY}rZ(hgX&:class:`primarySubject`r[hhjAhijhkjhm}r\(UreftypeXclassjjX Types.SubjectU refdomainXpyr]hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK+hb]r^j)r_}r`(hgj[hm}ra(ho]hp]rb(jj]Xpy-classrcehq]hr]ht]uhhjYhb]rdhXprimarySubjectrerf}rg(hgUhhj_ubahkjubaubhX, rhri}rj(hgX, hhjAubj)rk}rl(hgX(:class:`secondarySubject`rmhhjAhijhkjhm}rn(UreftypeXclassjjX Types.SubjectU refdomainXpyrohr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK+hb]rpj)rq}rr(hgjmhm}rs(ho]hp]rt(jjoXpy-classruehq]hr]ht]uhhjkhb]rvhXsecondarySubjectrwrx}ry(hgUhhjqubahkjubaubhX) rzr{}r|(hgX) hhjAubj)r}}r~(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjAhb]rhX->rr}r(hgUhhj}ubahkjubhX booleanrr}r(hgX booleanhhjAubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK,hb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK-hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX"``DELETE /accounts/map/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK.hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXDELETE /accounts/map/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`removeMapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK/hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXremoveMapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK/hb]rj)r}rŒ(hgjhm}rÌ(ho]hp]rČ(jjXpy-funcrŌehq]hr]ht]uhhjhb]rƌhXremoveMapIdentity()rnjrȌ}rɌ(hgUhhjubahkjubaubaubahkjfubjY)rʌ}rˌ(hgUhm}ř(ho]hp]hq]hr]ht]uhhjhb]r͌h)rΌ}rό(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjʌhijhkhhm}rЌ(ho]hp]hq]hr]ht]uhvK0hb]rь(hX(rҌ}rӌ(hgX(hhjΌubj)rԌ}rՌ(hgX:class:`session`r֌hhjΌhijhkjhm}r׌(UreftypeXclassjjX Types.SessionU refdomainXpyr،hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK0hb]rٌj)rڌ}rی(hgj֌hm}r܌(ho]hp]r݌(jj،Xpy-classrތehq]hr]ht]uhhjԌhb]rߌhXsessionrr}r(hgUhhjڌubahkjubaubhX, rr}r(hgX, hhjΌubj)r}r(hgX:class:`subject`rhhjΌhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK0hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjΌubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjΌhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjΌubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgXTier 2r hhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvK1hb]rhXTier 2rr}r(hgj hhj ubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK2hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r!h)r"}r#(hgX``POST /accounts/pendingmap``r$hhjhijhkhhm}r%(ho]hp]hq]hr]ht]uhvK3hb]r&j)r'}r((hgj$hm}r)(ho]hp]hq]hr]ht]uhhj"hb]r*hXPOST /accounts/pendingmapr+r,}r-(hgUhhj'ubahkjubaubahkjfubjY)r.}r/(hgUhm}r0(ho]hp]hq]hr]ht]uhhjhb]r1h)r2}r3(hgX:func:`requestMapIdentity`r4hhj.hijhkhhm}r5(ho]hp]hq]hr]ht]uhvK4hb]r6j)r7}r8(hgj4hhj2hijhkjhm}r9(UreftypeXfuncjjXrequestMapIdentityU refdomainXpyr:hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK4hb]r;j)r<}r=(hgj4hm}r>(ho]hp]r?(jj:Xpy-funcr@ehq]hr]ht]uhhj7hb]rAhXrequestMapIdentity()rBrC}rD(hgUhhj<ubahkjubaubaubahkjfubjY)rE}rF(hgUhm}rG(ho]hp]hq]hr]ht]uhhjhb]rHh)rI}rJ(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjEhijhkhhm}rK(ho]hp]hq]hr]ht]uhvK5hb]rL(hX(rM}rN(hgX(hhjIubj)rO}rP(hgX:class:`session`rQhhjIhijhkjhm}rR(UreftypeXclassjjX Types.SessionU refdomainXpyrShr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK5hb]rTj)rU}rV(hgjQhm}rW(ho]hp]rX(jjSXpy-classrYehq]hr]ht]uhhjOhb]rZhXsessionr[r\}r](hgUhhjUubahkjubaubhX, r^r_}r`(hgX, hhjIubj)ra}rb(hgX:class:`subject`rchhjIhijhkjhm}rd(UreftypeXclassjjX Types.SubjectU refdomainXpyrehr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK5hb]rfj)rg}rh(hgjchm}ri(ho]hp]rj(jjeXpy-classrkehq]hr]ht]uhhjahb]rlhXsubjectrmrn}ro(hgUhhjgubahkjubaubhX) rprq}rr(hgX) hhjIubj)rs}rt(hgX``->``hm}ru(ho]hp]hq]hr]ht]uhhjIhb]rvhX->rwrx}ry(hgUhhjsubahkjubhX booleanrzr{}r|(hgX booleanhhjIubeubahkjfubehkjubjT)r}}r~(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK6hb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK7hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX&``PUT /accounts/pendingmap/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK8hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX"PUT /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX:func:`confirmMapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK9hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXconfirmMapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK9hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXconfirmMapIdentity()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rÍh)rč}rō(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjhijhkhhm}rƍ(ho]hp]hq]hr]ht]uhvK:hb]rǍ(hX(rȍ}rɍ(hgX(hhjčubj)rʍ}rˍ(hgX:class:`session`r̍hhjčhijhkjhm}r͍(UreftypeXclassjjX Types.SessionU refdomainXpyr΍hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK:hb]rύj)rЍ}rэ(hgj̍hm}rҍ(ho]hp]rӍ(jj΍Xpy-classrԍehq]hr]ht]uhhjʍhb]rՍhXsessionr֍r׍}r؍(hgUhhjЍubahkjubaubhX, rٍrڍ}rۍ(hgX, hhjčubj)r܍}rݍ(hgX:class:`subject`rލhhjčhijhkjhm}rߍ(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK:hb]rj)r}r(hgjލhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhj܍hb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjčubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjčhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjčubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK;hb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r,j)r-}r.(hgj*hhj(hijhkjhm}r/(UreftypeXfuncjjXgetPendingMapIdentityU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK>hb]r1j)r2}r3(hgj*hm}r4(ho]hp]r5(jj0Xpy-funcr6ehq]hr]ht]uhhj-hb]r7hXgetPendingMapIdentity()r8r9}r:(hgUhhj2ubahkjubaubaubahkjfubjY)r;}r<(hgUhm}r=(ho]hp]hq]hr]ht]uhhjhb]r>h)r?}r@(hgXd(:class:`session`, :class:`subject`) ``->`` :class:`Types.SubjectInfo`hhj;hijhkhhm}rA(ho]hp]hq]hr]ht]uhvK?hb]rB(hX(rC}rD(hgX(hhj?ubj)rE}rF(hgX:class:`session`rGhhj?hijhkjhm}rH(UreftypeXclassjjX Types.SessionU refdomainXpyrIhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK?hb]rJj)rK}rL(hgjGhm}rM(ho]hp]rN(jjIXpy-classrOehq]hr]ht]uhhjEhb]rPhXsessionrQrR}rS(hgUhhjKubahkjubaubhX, rTrU}rV(hgX, hhj?ubj)rW}rX(hgX:class:`subject`rYhhj?hijhkjhm}rZ(UreftypeXclassjjX Types.SubjectU refdomainXpyr[hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK?hb]r\j)r]}r^(hgjYhm}r_(ho]hp]r`(jj[Xpy-classraehq]hr]ht]uhhjWhb]rbhXsubjectrcrd}re(hgUhhj]ubahkjubaubhX) rfrg}rh(hgX) hhj?ubj)ri}rj(hgX``->``hm}rk(ho]hp]hq]hr]ht]uhhj?hb]rlhX->rmrn}ro(hgUhhjiubahkjubhX rp}rq(hgX hhj?ubj)rr}rs(hgX:class:`Types.SubjectInfo`rthhj?hijhkjhm}ru(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrvhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK?hb]rwj)rx}ry(hgjthm}rz(ho]hp]r{(jjvXpy-classr|ehq]hr]ht]uhhjrhb]r}hXTypes.SubjectInfor~r}r(hgUhhjxubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK@hb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKAhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX)``DELETE /accounts/pendingmap/{subject}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKBhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX%DELETE /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`denyMapIdentity`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKChb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXdenyMapIdentityU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKChb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXdenyMapIdentity()rrŽ}rÎ(hgUhhjubahkjubaubaubahkjfubjY)rĎ}rŎ(hgUhm}rƎ(ho]hp]hq]hr]ht]uhhjhb]rǎh)rȎ}rɎ(hgXQ(:class:`session`, :class:`subject`) ``->`` booleanhhjĎhijhkhhm}rʎ(ho]hp]hq]hr]ht]uhvKDhb]rˎ(hX(r̎}r͎(hgX(hhjȎubj)rΎ}rώ(hgX:class:`session`rЎhhjȎhijhkjhm}rю(UreftypeXclassjjX Types.SessionU refdomainXpyrҎhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKDhb]rӎj)rԎ}rՎ(hgjЎhm}r֎(ho]hp]r׎(jjҎXpy-classr؎ehq]hr]ht]uhhjΎhb]rَhXsessionrڎrێ}r܎(hgUhhjԎubahkjubaubhX, rݎrގ}rߎ(hgX, hhjȎubj)r}r(hgX:class:`subject`rhhjȎhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKDhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjȎubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjȎhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjȎubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKEhb]rhXTier 2r r }r (hgjhhjubaubahkjfubjY)r }r (hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKFhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``POST /groups``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKGhb]r j)r!}r"(hgjhm}r#(ho]hp]hq]hr]ht]uhhjhb]r$hX POST /groupsr%r&}r'(hgUhhj!ubahkjubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX:func:`createGroup`r.hhj(hijhkhhm}r/(ho]hp]hq]hr]ht]uhvKHhb]r0j)r1}r2(hgj.hhj,hijhkjhm}r3(UreftypeXfuncjjX createGroupU refdomainXpyr4hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKHhb]r5j)r6}r7(hgj.hm}r8(ho]hp]r9(jj4Xpy-funcr:ehq]hr]ht]uhhj1hb]r;hX createGroup()r<r=}r>(hgUhhj6ubahkjubaubaubahkjfubjY)r?}r@(hgUhm}rA(ho]hp]hq]hr]ht]uhhjhb]rBh)rC}rD(hgX\(:class:`session`, :class:`group`) ``->`` :class:`Types.Subject`hhj?hijhkhhm}rE(ho]hp]hq]hr]ht]uhvKIhb]rF(hX(rG}rH(hgX(hhjCubj)rI}rJ(hgX:class:`session`rKhhjChijhkjhm}rL(UreftypeXclassjjX Types.SessionU refdomainXpyrMhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKIhb]rNj)rO}rP(hgjKhm}rQ(ho]hp]rR(jjMXpy-classrSehq]hr]ht]uhhjIhb]rThXsessionrUrV}rW(hgUhhjOubahkjubaubhX, rXrY}rZ(hgX, hhjCubj)r[}r\(hgX:class:`group`r]hhjChijhkjhm}r^(UreftypeXclassjjX Types.GroupU refdomainXpyr_hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKIhb]r`j)ra}rb(hgj]hm}rc(ho]hp]rd(jj_Xpy-classreehq]hr]ht]uhhj[hb]rfhXgrouprgrh}ri(hgUhhjaubahkjubaubhX) rjrk}rl(hgX) hhjCubj)rm}rn(hgX``->``hm}ro(ho]hp]hq]hr]ht]uhhjChb]rphX->rqrr}rs(hgUhhjmubahkjubhX rt}ru(hgX hhjCubj)rv}rw(hgX:class:`Types.Subject`rxhhjChijhkjhm}ry(UreftypeXclassjjX Types.SubjectU refdomainXpyrzhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKIhb]r{j)r|}r}(hgjxhm}r~(ho]hp]r(jjzXpy-classrehq]hr]ht]uhhjvhb]rhX Types.Subjectrr}r(hgUhhj|ubahkjubaubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 2rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKJhb]rhXTier 2rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /groups``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKLhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX PUT /groupsrr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`updateGroup`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKMhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjX updateGroupU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrÏehq]hr]ht]uhhjhb]rďhX updateGroup()rŏrƏ}rǏ(hgUhhjubahkjubaubaubahkjfubjY)rȏ}rɏ(hgUhm}rʏ(ho]hp]hq]hr]ht]uhhjhb]rˏh)ȑ}r͏(hgXM(:class:`session`, :class:`group`) ``->`` booleanhhjȏhijhkhhm}rΏ(ho]hp]hq]hr]ht]uhvKNhb]rϏ(hX(rЏ}rя(hgX(hhj̏ubj)rҏ}rӏ(hgX:class:`session`rԏhhj̏hijhkjhm}rՏ(UreftypeXclassjjX Types.SessionU refdomainXpyr֏hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKNhb]r׏j)r؏}rُ(hgjԏhm}rڏ(ho]hp]rۏ(jj֏Xpy-classr܏ehq]hr]ht]uhhjҏhb]rݏhXsessionrޏrߏ}r(hgUhhj؏ubahkjubaubhX, rr}r(hgX, hhj̏ubj)r}r(hgX:class:`group`rhhj̏hijhkjhm}r(UreftypeXclassjjX Types.GroupU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKNhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXgrouprr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhj̏ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj̏hb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhj̏ubeubahkjfubehkjubehkjubehkjubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX(registerAccount() (in module CNIdentity)h.UNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionr j"j uhvNhwhhb]r (j")r }r (hgX*registerAccount(session,person) -> Subjecthhjhijhkj "hm}r (hr]rh.aj"j͈hq]ho]hp]ht]rh.aj"XregisterAccountrj"Uj"uhvK|hwhhb]r(j")r}r(hgX CNIdentity.hhj hijhkj"hm}r(ho]hp]hq]hr]ht]uhvK|hwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhj hijhkj!"hm}r(ho]hp]hq]hr]ht]uhvK|hwhhb]rhXregisterAccountrr}r(hgUhhjubaubj'")r }r!(hgXsession, personhhj hijhkj*"hm}r"(ho]hp]hq]hr]ht]uhvK|hwhhb]r#(j-")r$}r%(hgXsessionhm}r&(ho]hp]hq]hr]ht]uhhj hb]r'hXsessionr(r)}r*(hgUhhj$ubahkj5"ubj-")r+}r,(hgXpersonhm}r-(ho]hp]hq]hr]ht]uhhj hb]r.hXpersonr/r0}r1(hgUhhj+ubahkj5"ubeubj6")r2}r3(hgXSubjecthhj hijhkj9"hm}r4(ho]hp]hq]hr]ht]uhvK|hwhhb]r5hXSubjectr6r7}r8(hgUhhj2ubaubeubj?")r9}r:(hgUhhjhijhkjB"hm}r;(ho]hp]hq]hr]ht]uhvK|hwhhb]r<(h)r=}r>(hgX3Create a new :term:`subject` in the DataONE system.hhj9hijhkhhm}r?(ho]hp]hq]hr]ht]uhvKUhwhhb]r@(hX Create a new rArB}rC(hgX Create a new hhj=ubj)rD}rE(hgX:term:`subject`rFhhj=hijhkjhm}rG(UreftypeXtermjjXsubjectU refdomainXstdrHhr]hq]U refexplicitho]hp]ht]jjuhvKUhb]rIj`2)rJ}rK(hgjFhm}rL(ho]hp]rM(jjHXstd-termrNehq]hr]ht]uhhjDhb]rOhXsubjectrPrQ}rR(hgUhhjJubahkji2ubaubhX in the DataONE system.rSrT}rU(hgX in the DataONE system.hhj=ubeubh)rV}rW(hgXNote that there should probably be a lot more metadata captured about the new user, and there should be a mechanism for specifying the default access control rules for the new account.rXhhj9hijhkhhm}rY(ho]hp]hq]hr]ht]uhvKWhwhhb]rZhXNote that there should probably be a lot more metadata captured about the new user, and there should be a mechanism for specifying the default access control rules for the new account.r[r\}r](hgjXhhjVubaubh)r^}r_(hgUhhj9hiNhkhhm}r`(ho]hp]hq]hr]ht]uhvNhwhhb]ra(h)rb}rc(hgUhhj^hijhkhhm}rd(ho]hp]hq]hr]ht]uhvKYhwhhb]re(h)rf}rg(hgXVersionhhjbhijhkhhm}rh(ho]hp]hq]hr]ht]uhvKhb]rihXVersionrjrk}rl(hgUhhjfubaubh)rm}rn(hgX 1.0, (2.0)rohm}rp(ho]hp]hq]hr]ht]uhhjbhb]rqh)rr}rs(hgjohhjmhijhkhhm}rt(ho]hp]hq]hr]ht]uhvKYhb]ruhX 1.0, (2.0)rvrw}rx(hgjohhjrubaubahkhubeubh)ry}rz(hgUhhj^hijhkhhm}r{(ho]hp]hq]hr]ht]uhvKZhwhhb]r|(h)r}}r~(hgX Use Caseshhjyhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Use Casesrr}r(hgUhhj}ubaubh)r}r(hgX$:doc:`UC16 `rhm}r(ho]hp]hq]hr]ht]uhhjyhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK[hb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXdocrjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvK[hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjehq]hr]ht]uhhjhb]rhXUC16rr}r(hgUhhjubahkji2ubaubaubahkhubeubh)r}r(hgUhhj^hijhkhhm}r(ho]hp]hq]hr]ht]uhvK\hwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX``POST /accounts``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK\hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /accountsrr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj^hb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rÐj #)rĐ}rŐ(hgUhm}rƐ(ho]hp]hq]hr]ht]uhhjhb]rǐ(j#)rȐ}rɐ(hgUhm}rʐ(ho]hp]hq]hr]ht]uhhjĐhb]rːh)r̐}r͐(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rΐ(ho]hp]hq]hr]ht]uhhjȐhb]rϐ(j")rА}rѐ(hgXsessionhm}rҐ(hr]hq]j"ho]hp]ht]uhhj̐hb]rӐhXsessionrԐrՐ}r֐(hgUhhjАubahkj"ubhX (rאrؐ}rِ(hgUhhj̐ubj)rڐ}rې(hgX:class:`Types.Session`rܐhhj̐hijhkjhm}rݐ(UreftypeXclassjjX Types.SessionU refdomainXpyrސhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvK^hb]rߐj)r}r(hgjܐhm}r(ho]hp]r(jjސXpy-classrehq]hr]ht]uhhjڐhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhj̐ubhX -- rr}r(hgUhhj̐ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj̐ubj)r}r(hgX:term:`public user`rhhj̐hijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK]hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj̐ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjĐhb]rh)r}r(hgXperson (Types.Person) -- Information about the Person to be registered with the account, including the real name and email address for the individual. The Subject with the Person must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication, and must not have been registered previously. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r (ho]hp]hq]hr]ht]uhhjhb]r (j")r }r (hgXpersonhm}r (hr]hq]j"ho]hp]ht]uhhjhb]rhXpersonrr}r(hgUhhj ubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Person`rhhjhijhkjhm}r(UreftypeXclassjjX Types.PersonU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKahb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]r hX Types.Personr!r"}r#(hgUhhjubahkjubaubhX)r$}r%(hgUhhjubhX -- r&r'}r((hgUhhjubhXInformation about the Person to be registered with the account, including the real name and email address for the individual. The Subject with the Person must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication, and must not have been registered previously. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r)r*}r+(hgXInformation about the Person to be registered with the account, including the real name and email address for the individual. The Subject with the Person must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication, and must not have been registered previously. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)r,}r-(hgX *File part*hm}r.(ho]hp]hq]hr]ht]uhhjhb]r/hX File partr0r1}r2(hgUhhj,ubahkj$ubhX% of the MIME multipart/mixed message.r3r4}r5(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r6}r7(hgUhm}r8(ho]hp]hq]hr]ht]uhhj^hb]r9(h)r:}r;(hgXReturnshhj6hijhkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r=hXReturnsr>r?}r@(hgUhhj:ubaubh)rA}rB(hgUhm}rC(ho]hp]hq]hr]ht]uhhj6hb]rDh)rE}rF(hgXHThe new subject in the DataONE system. This may be a simple identifier.hm}rG(ho]hp]hq]hr]ht]uhhjAhb]rHhXHThe new subject in the DataONE system. This may be a simple identifier.rIrJ}rK(hgXHThe new subject in the DataONE system. This may be a simple identifier.hhjEubahkhubahkhubehkhubh)rL}rM(hgUhm}rN(ho]hp]hq]hr]ht]uhhj^hb]rO(h)rP}rQ(hgX Return typehhjLhijhkhhm}rR(ho]hp]hq]hr]ht]uhvKhb]rShX Return typerTrU}rV(hgUhhjPubaubh)rW}rX(hgUhm}rY(ho]hp]hq]hr]ht]uhhjLhb]rZh)r[}r\(hgX Types.Subjecthm}r](ho]hp]hq]hr]ht]uhhjWhb]r^j)r_}r`(hgX:class:`Types.Subject`rahhj[hijhkjhm}rb(UreftypeXclassjjX Types.SubjectU refdomainXpyrchr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKdhb]rdj)re}rf(hgjahm}rg(ho]hp]rh(jjcXpy-classriehq]hr]ht]uhhj_hb]rjhX Types.Subjectrkrl}rm(hgUhhjeubahkjubaubahkhubahkhubehkhubh)rn}ro(hgUhm}rp(ho]hp]hq]hr]ht]uhhj^hb]rq(h)rr}rs(hgXRaiseshhjnhijhkhhm}rt(ho]hp]hq]hr]ht]uhvKhb]ruhXRaisesrvrw}rx(hgUhhjrubaubh)ry}rz(hgUhm}r{(ho]hp]hq]hr]ht]uhhjnhb]r|j #)r}}r~(hgUhm}r(ho]hp]hq]hr]ht]uhhjyhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4520)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4520)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4520)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgXrExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=4521)The chosen identity already exists in the systemhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.IdentifierNotUniquerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=409, detailCode=4521)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=409, detailCode=4521)rr}r(hgUhhjubahkjubaubh)r‘}rÑ(hgX0The chosen identity already exists in the systemrđhhjhijhkhhm}rő(ho]hp]hq]hr]ht]uhvKjhb]rƑhX0The chosen identity already exists in the systemrǑrȑ}rɑ(hgjđhhj‘ubaubehkhubahkj;#ubj#)rʑ}rˑ(hgUhm}ȓ(ho]hp]hq]hr]ht]uhhj}hb]r͑h)rΑ}rϑ(hgXExceptions.InvalidCredentials -- (errorCode=401, detailCode=4522)Raised if the supplied credentials are invalid, such as an invalid X.509 certificate.hm}rБ(ho]hp]hq]hr]ht]uhhjʑhb]rё(j)rґ}rӑ(hgUhm}rԑ(Ureftypej#j"U reftargetXExceptions.InvalidCredentialsrՑU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjΑhb]r֑j")rב}rؑ(hgjՑhm}rّ(ho]hp]hq]hr]ht]uhhjґhb]rڑhXExceptions.InvalidCredentialsrۑrܑ}rݑ(hgUhhjבubahkj"ubahkjubhX -- rޑrߑ}r(hgUhhjΑubh)r}r(hgX$``(errorCode=401, detailCode=4522)``rhhjΑhijhkhhm}r(ho]hp]hq]hr]ht]uhvKlhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4522)rr}r(hgUhhjubahkjubaubh)r}r(hgXURaised if the supplied credentials are invalid, such as an invalid X.509 certificate.rhhjΑhijhkhhm}r(ho]hp]hq]hr]ht]uhvKnhb]rhXURaised if the supplied credentials are invalid, such as an invalid X.509 certificate.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4523)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- r r }r (hgUhhjubj)r }r (hgX$``(errorCode=501, detailCode=4523)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=4523)rr}r(hgUhhj ubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj}hb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4524)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r }r!(hgjhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#hXExceptions.InvalidRequestr$r%}r&(hgUhhj ubahkj"ubahkjubhX -- r'r(}r)(hgUhhjubj)r*}r+(hgX$``(errorCode=400, detailCode=4524)``hm}r,(ho]hp]hq]hr]ht]uhhjhb]r-hX (errorCode=400, detailCode=4524)r.r/}r0(hgUhhj*ubahkjubehkhubahkj;#ubj#)r1}r2(hgUhm}r3(ho]hp]hq]hr]ht]uhhj}hb]r4h)r5}r6(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4525)The subject of the session does not match the subject of the person.hm}r7(ho]hp]hq]hr]ht]uhhj1hb]r8(j)r9}r:(hgUhm}r;(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr<U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj5hb]r=j")r>}r?(hgj<hm}r@(ho]hp]hq]hr]ht]uhhj9hb]rAhXExceptions.NotAuthorizedrBrC}rD(hgUhhj>ubahkj"ubahkjubhX -- rErF}rG(hgUhhj5ubh)rH}rI(hgX$``(errorCode=401, detailCode=4525)``rJhhj5hijhkhhm}rK(ho]hp]hq]hr]ht]uhvKthb]rLj)rM}rN(hgjJhm}rO(ho]hp]hq]hr]ht]uhhjHhb]rPhX (errorCode=401, detailCode=4525)rQrR}rS(hgUhhjMubahkjubaubh)rT}rU(hgXDThe subject of the session does not match the subject of the person.rVhhj5hijhkhhm}rW(ho]hp]hq]hr]ht]uhvKvhb]rXhXDThe subject of the session does not match the subject of the person.rYrZ}r[(hgjVhhjTubaubehkhubahkj;#ubj#)r\}r](hgUhm}r^(ho]hp]hq]hr]ht]uhhj}hb]r_h)r`}ra(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4526)hm}rb(ho]hp]hq]hr]ht]uhhj\hb]rc(j)rd}re(hgUhm}rf(Ureftypej#j"U reftargetXExceptions.InvalidTokenrgU refdomainjhr]hq]U refexplicitho]hp]ht]uhhj`hb]rhj")ri}rj(hgjghm}rk(ho]hp]hq]hr]ht]uhhjdhb]rlhXExceptions.InvalidTokenrmrn}ro(hgUhhjiubahkj"ubahkjubhX -- rprq}rr(hgUhhj`ubj)rs}rt(hgX$``(errorCode=401, detailCode=4526)``hm}ru(ho]hp]hq]hr]ht]uhhj`hb]rvhX (errorCode=401, detailCode=4526)rwrx}ry(hgUhhjsubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rz}r{(hgUhhjhiNhkjhm}r|(hr]hq]ho]hp]ht]Uentries]r}(jX&updateAccount() (in module CNIdentity)h$UNtr~auhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX0updateAccount(session,subject,person) -> Subjecthhjhijhkj "hm}r(hr]rh$aj"j͈hq]ho]hp]ht]rh$aj"X updateAccountrj"Uj"uhvKhwhhb]r(j")r}r(hgX CNIdentity.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhjhijhkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX updateAccountrr}r(hgUhhjubaubj'")r}r(hgXsession, subject, personhhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXsubjecthm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkj5"ubj-")r}r(hgXpersonhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXpersonrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXSubjecthhjhijhkj9"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXSubjectrr}r(hgUhhjubaubeubj?")r}r(hgUhhjhijhkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgX|Update an existing :term:`subject` in the DataONE system. The target subject is determined from subject provided in the URL.hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(hXUpdate an existing r’rÒ}rĒ(hgXUpdate an existing hhjubj)rŒ}rƒ(hgX:term:`subject`rǒhhjhijhkjhm}rȒ(UreftypeXtermjjXsubjectU refdomainXstdrɒhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rʒj`2)r˒}r̒(hgjǒhm}r͒(ho]hp]rΒ(jjɒXstd-termrϒehq]hr]ht]uhhjŒhb]rВhXsubjectrђrҒ}rӒ(hgUhhj˒ubahkji2ubaubhXZ in the DataONE system. The target subject is determined from subject provided in the URL.rԒrՒ}r֒(hgXZ in the DataONE system. The target subject is determined from subject provided in the URL.hhjubeubh)rג}rؒ(hgXJThe use calling this method must have write access to the account details.rْhhjhijhkhhm}rڒ(ho]hp]hq]hr]ht]uhvKhwhhb]rےhXJThe use calling this method must have write access to the account details.rܒrݒ}rޒ(hgjْhhjגubaubh)rߒ}r(hgXYNote that there should be a policy for verifying the details that change via this method.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXYNote that there should be a policy for verifying the details that change via this method.rr}r(hgjhhjߒubaubh)r}r(hgUhhjhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgX Use Caseshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r hX Use Casesr r }r (hgUhhjubaubh)r }r(hgX$:doc:`UC16 `rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXdocrjjX/design/UseCases/16_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjehq]hr]ht]uhhjhb]rhXUC16r r!}r"(hgUhhjubahkji2ubaubaubahkhubeubh)r#}r$(hgUhhjhijhkhhm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]r&(h)r'}r((hgXREST URLhhj#hijhkhhm}r)(ho]hp]hq]hr]ht]uhvKhb]r*hXREST URLr+r,}r-(hgUhhj'ubaubh)r.}r/(hgX``PUT /accounts/{subject}``r0hm}r1(ho]hp]hq]hr]ht]uhhj#hb]r2h)r3}r4(hgj0hhj.hijhkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r6j)r7}r8(hgj0hm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:hXPUT /accounts/{subject}r;r<}r=(hgUhhj7ubahkjubaubahkhubeubh)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhjhb]rA(h)rB}rC(hgX Parametershhj>hijhkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rEhX ParametersrFrG}rH(hgUhhjBubaubh)rI}rJ(hgUhm}rK(ho]hp]hq]hr]ht]uhhj>hb]rLj #)rM}rN(hgUhm}rO(ho]hp]hq]hr]ht]uhhjIhb]rP(j#)rQ}rR(hgUhm}rS(ho]hp]hq]hr]ht]uhhjMhb]rTh)rU}rV(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rW(ho]hp]hq]hr]ht]uhhjQhb]rX(j")rY}rZ(hgXsessionhm}r[(hr]hq]j"ho]hp]ht]uhhjUhb]r\hXsessionr]r^}r_(hgUhhjYubahkj"ubhX (r`ra}rb(hgUhhjUubj)rc}rd(hgX:class:`Types.Session`rehhjUhijhkjhm}rf(UreftypeXclassjjX Types.SessionU refdomainXpyrghr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rhj)ri}rj(hgjehm}rk(ho]hp]rl(jjgXpy-classrmehq]hr]ht]uhhjchb]rnhX Types.Sessionrorp}rq(hgUhhjiubahkjubaubhX)rr}rs(hgUhhjUubhX -- rtru}rv(hgUhhjUubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rwrx}ry(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjUubj)rz}r{(hgX:term:`public user`r|hhjUhijhkjhm}r}(UreftypeXtermjjX public userU refdomainXstdr~hr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgj|hm}r(ho]hp]r(jj~Xstd-termrehq]hr]ht]uhhjzhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjUubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjMhb]rh)r}r(hgXsubject (Types.Subject) -- The subject of the person being updated. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXmThe subject of the person being updated. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXmThe subject of the person being updated. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjMhb]rh)r}r(hgXperson (Types.Person) -- New information about the Person. The subject of the Person cannot be updated with this method and must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXpersonhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXpersonrr“}rÓ(hgUhhjubahkj"ubhX (rērœ}rƓ(hgUhhjubj)rǓ}rȓ(hgX:class:`Types.Person`rɓhhjhijhkjhm}rʓ(UreftypeXclassjjX Types.PersonU refdomainXpyr˓hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]r̓j)r͓}rΓ(hgjɓhm}rϓ(ho]hp]rГ(jj˓Xpy-classrѓehq]hr]ht]uhhjǓhb]rғhX Types.Personrӓrԓ}rՓ(hgUhhj͓ubahkjubaubhX)r֓}rד(hgUhhjubhX -- rؓrٓ}rړ(hgUhhjubhXTNew information about the Person. The subject of the Person cannot be updated with this method and must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rۓrܓ}rݓ(hgXTNew information about the Person. The subject of the Person cannot be updated with this method and must match the subject of the X.509 certificate associated with the authenticated SSL session via client-side authentication. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)rޓ}rߓ(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX File partrr}r(hgUhhjޓubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX3The Subject in the DataONE system that was updated.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX3The Subject in the DataONE system that was updated.rr}r(hgX3The Subject in the DataONE system that was updated.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Return typehhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r(hgX Types.Subjecthm}r(ho]hp]hq]hr]ht]uhhj hb]rj)r}r(hgX:class:`Types.Subject`rhhj hijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubahkhubahkhubehkhubh)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#(h)r$}r%(hgXRaiseshhj hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKhb]r'hXRaisesr(r)}r*(hgUhhj$ubaubh)r+}r,(hgUhm}r-(ho]hp]hq]hr]ht]uhhj hb]r.j #)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhj+hb]r2(j#)r3}r4(hgUhm}r5(ho]hp]hq]hr]ht]uhhj/hb]r6h)r7}r8(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4530)hm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:(j)r;}r<(hgUhm}r=(Ureftypej#j"U reftargetXExceptions.ServiceFailurer>U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj7hb]r?j")r@}rA(hgj>hm}rB(ho]hp]hq]hr]ht]uhhj;hb]rChXExceptions.ServiceFailurerDrE}rF(hgUhhj@ubahkj"ubahkjubhX -- rGrH}rI(hgUhhj7ubj)rJ}rK(hgX$``(errorCode=500, detailCode=4530)``hm}rL(ho]hp]hq]hr]ht]uhhj7hb]rMhX (errorCode=500, detailCode=4530)rNrO}rP(hgUhhjJubahkjubehkhubahkj;#ubj#)rQ}rR(hgUhm}rS(ho]hp]hq]hr]ht]uhhj/hb]rTh)rU}rV(hgXExceptions.InvalidCredentials -- (errorCode=401, detailCode=4531)Raised if the supplied credentials are invalid, such as an invalid X.509 certificate.hm}rW(ho]hp]hq]hr]ht]uhhjQhb]rX(j)rY}rZ(hgUhm}r[(Ureftypej#j"U reftargetXExceptions.InvalidCredentialsr\U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjUhb]r]j")r^}r_(hgj\hm}r`(ho]hp]hq]hr]ht]uhhjYhb]rahXExceptions.InvalidCredentialsrbrc}rd(hgUhhj^ubahkj"ubahkjubhX -- rerf}rg(hgUhhjUubh)rh}ri(hgX$``(errorCode=401, detailCode=4531)``rjhhjUhijhkhhm}rk(ho]hp]hq]hr]ht]uhvKhb]rlj)rm}rn(hgjjhm}ro(ho]hp]hq]hr]ht]uhhjhhb]rphX (errorCode=401, detailCode=4531)rqrr}rs(hgUhhjmubahkjubaubh)rt}ru(hgXURaised if the supplied credentials are invalid, such as an invalid X.509 certificate.rvhhjUhijhkhhm}rw(ho]hp]hq]hr]ht]uhvKhb]rxhXURaised if the supplied credentials are invalid, such as an invalid X.509 certificate.ryrz}r{(hgjvhhjtubaubehkhubahkj;#ubj#)r|}r}(hgUhm}r~(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4532)hm}r(ho]hp]hq]hr]ht]uhhj|hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=4532)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=4532)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4533)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=400, detailCode=4533)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4533)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4534)Raised if the subject of the session does not match that of the person.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r”(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrÔU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rĔj")rŔ}rƔ(hgjÔhm}rǔ(ho]hp]hq]hr]ht]uhhjhb]rȔhXExceptions.NotAuthorizedrɔrʔ}r˔(hgUhhjŔubahkj"ubahkjubhX -- r̔r͔}rΔ(hgUhhjubh)rϔ}rД(hgX$``(errorCode=401, detailCode=4534)``rєhhjhijhkhhm}rҔ(ho]hp]hq]hr]ht]uhvKhb]rӔj)rԔ}rՔ(hgjєhm}r֔(ho]hp]hq]hr]ht]uhhjϔhb]rהhX (errorCode=401, detailCode=4534)rؔrٔ}rڔ(hgUhhjԔubahkjubaubh)r۔}rܔ(hgXGRaised if the subject of the session does not match that of the person.rݔhhjhijhkhhm}rޔ(ho]hp]hq]hr]ht]uhvKhb]rߔhXGRaised if the subject of the session does not match that of the person.rr}r(hgjݔhhj۔ubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgX\Exceptions.NotFound -- (errorCode=404, detailCode=4535)Raised if the account does not exist.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=4535)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=4535)rr}r(hgUhhjubahkjubaubh)r}r(hgX%Raised if the account does not exist.rhhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX%Raised if the account does not exist.r r }r (hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4536)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr }r!(hgUhhjubahkj"ubahkjubhX -- r"r#}r$(hgUhhjubj)r%}r&(hgX$``(errorCode=401, detailCode=4536)``hm}r'(ho]hp]hq]hr]ht]uhhjhb]r(hX (errorCode=401, detailCode=4536)r)r*}r+(hgUhhj%ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r,}r-(hgUhhjhiNhkjhm}r.(hr]hq]ho]hp]ht]Uentries]r/(jX&verifyAccount() (in module CNIdentity)hUNtr0auhvNhwhhb]ubj!)r1}r2(hgUhhjhiNhkj!hm}r3(j"j"Xpyr4hr]hq]ho]hp]ht]j"Xfunctionr5j"j5uhvNhwhhb]r6(j")r7}r8(hgX)verifyAccount(session,subject) -> booleanhhj1hijhkj "hm}r9(hr]r:haj"j͈hq]ho]hp]ht]r;haj"X verifyAccountr<j"Uj"uhvKhwhhb]r=(j")r>}r?(hgX CNIdentity.hhj7hijhkj"hm}r@(ho]hp]hq]hr]ht]uhvKhwhhb]rAhX CNIdentity.rBrC}rD(hgUhhj>ubaubj")rE}rF(hgj<hhj7hijhkj!"hm}rG(ho]hp]hq]hr]ht]uhvKhwhhb]rHhX verifyAccountrIrJ}rK(hgUhhjEubaubj'")rL}rM(hgXsession, subjecthhj7hijhkj*"hm}rN(ho]hp]hq]hr]ht]uhvKhwhhb]rO(j-")rP}rQ(hgXsessionhm}rR(ho]hp]hq]hr]ht]uhhjLhb]rShXsessionrTrU}rV(hgUhhjPubahkj5"ubj-")rW}rX(hgXsubjecthm}rY(ho]hp]hq]hr]ht]uhhjLhb]rZhXsubjectr[r\}r](hgUhhjWubahkj5"ubeubj6")r^}r_(hgXbooleanhhj7hijhkj9"hm}r`(ho]hp]hq]hr]ht]uhvKhwhhb]rahXbooleanrbrc}rd(hgUhhj^ubaubeubj?")re}rf(hgUhhj1hijhkjB"hm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rh(h)ri}rj(hgXkVerify that the Person data associated with this Subject is a true representation of the real world person.rkhhjehijhkhhm}rl(ho]hp]hq]hr]ht]uhvKhwhhb]rmhXkVerify that the Person data associated with this Subject is a true representation of the real world person.rnro}rp(hgjkhhjiubaubh)rq}rr(hgXmThis service can only be called by users who have an administrative role for the domain of users in question.rshhjehijhkhhm}rt(ho]hp]hq]hr]ht]uhvKhwhhb]ruhXmThis service can only be called by users who have an administrative role for the domain of users in question.rvrw}rx(hgjshhjqubaubh)ry}rz(hgXYA successful completion of this operation is indicated by returning a HTTP status of 200.r{hhjehijhkhhm}r|(ho]hp]hq]hr]ht]uhvKhwhhb]r}hXYA successful completion of this operation is indicated by returning a HTTP status of 200.r~r}r(hgj{hhjyubaubh)r}r(hgXKAn exeption MUST be returned if the account verification is not successful.rhhjehijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXKAn exeption MUST be returned if the account verification is not successful.rr}r(hgjhhjubaubh)r}r(hgUhhjehiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX(``PUT /accounts/verification/{subject}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX$PUT /accounts/verification/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r•(h)rÕ}rĕ(hgX Parametershhjhijhkhhm}rŕ(ho]hp]hq]hr]ht]uhvKhb]rƕhX ParametersrǕrȕ}rɕ(hgUhhjÕubaubh)rʕ}r˕(hgUhm}r̕(ho]hp]hq]hr]ht]uhhjhb]r͕j #)rΕ}rϕ(hgUhm}rЕ(ho]hp]hq]hr]ht]uhhjʕhb]rѕ(j#)rҕ}rӕ(hgUhm}rԕ(ho]hp]hq]hr]ht]uhhjΕhb]rՕh)r֕}rו(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rؕ(ho]hp]hq]hr]ht]uhhjҕhb]rٕ(j")rڕ}rە(hgXsessionhm}rܕ(hr]hq]j"ho]hp]ht]uhhj֕hb]rݕhXsessionrޕrߕ}r(hgUhhjڕubahkj"ubhX (rr}r(hgUhhj֕ubj)r}r(hgX:class:`Types.Session`rhhj֕hijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhj֕ubhX -- rr}r(hgUhhj֕ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj֕ubj)r}r(hgX:term:`public user`rhhj֕hijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r (hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r r }r (hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj֕ubehkhubahkj;#ubj#)r }r(hgUhm}r(ho]hp]hq]hr]ht]uhhjΕhb]rh)r}r(hgXsubject (Types.Subject) -- The Subject identifier of the Person to be verified. After this service is called for a subject by an authorized user, the account is marked as verified by this user. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhj hb]r(j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r (hgX:class:`Types.Subject`r!hhjhijhkjhm}r"(UreftypeXclassjjX Types.SubjectU refdomainXpyr#hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]r$j)r%}r&(hgj!hm}r'(ho]hp]r((jj#Xpy-classr)ehq]hr]ht]uhhjhb]r*hX Types.Subjectr+r,}r-(hgUhhj%ubahkjubaubhX)r.}r/(hgUhhjubhX -- r0r1}r2(hgUhhjubhXThe Subject identifier of the Person to be verified. After this service is called for a subject by an authorized user, the account is marked as verified by this user. Transmitted as part of the URL path and must be escaped accordingly.r3r4}r5(hgXThe Subject identifier of the Person to be verified. After this service is called for a subject by an authorized user, the account is marked as verified by this user. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r6}r7(hgUhm}r8(ho]hp]hq]hr]ht]uhhjhb]r9(h)r:}r;(hgXReturnshhj6hijhkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r=hXReturnsr>r?}r@(hgUhhj:ubaubh)rA}rB(hgUhm}rC(ho]hp]hq]hr]ht]uhhj6hb]rDh)rE}rF(hgX;True if the account verification succeeds, otherwise false.hm}rG(ho]hp]hq]hr]ht]uhhjAhb]rHhX;True if the account verification succeeds, otherwise false.rIrJ}rK(hgX;True if the account verification succeeds, otherwise false.hhjEubahkhubahkhubehkhubh)rL}rM(hgUhm}rN(ho]hp]hq]hr]ht]uhhjhb]rO(h)rP}rQ(hgX Return typehhjLhijhkhhm}rR(ho]hp]hq]hr]ht]uhvKhb]rShX Return typerTrU}rV(hgUhhjPubaubh)rW}rX(hgUhm}rY(ho]hp]hq]hr]ht]uhhjLhb]rZh)r[}r\(hgXbooleanhm}r](ho]hp]hq]hr]ht]uhhjWhb]r^j)r_}r`(hgUhm}ra(Ureftypej&j"U reftargetXbooleanU refdomainj4hr]hq]U refexplicitho]hp]ht]uhhj[hb]rbhXbooleanrcrd}re(hgUhhj_ubahkjubahkhubahkhubehkhubh)rf}rg(hgUhm}rh(ho]hp]hq]hr]ht]uhhjhb]ri(h)rj}rk(hgXRaiseshhjfhijhkhhm}rl(ho]hp]hq]hr]ht]uhvKhb]rmhXRaisesrnro}rp(hgUhhjjubaubh)rq}rr(hgUhm}rs(ho]hp]hq]hr]ht]uhhjfhb]rtj #)ru}rv(hgUhm}rw(ho]hp]hq]hr]ht]uhhjqhb]rx(j#)ry}rz(hgUhm}r{(ho]hp]hq]hr]ht]uhhjuhb]r|h)r}}r~(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4540)hm}r(ho]hp]hq]hr]ht]uhhjyhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainj4hr]hq]U refexplicitho]hp]ht]uhhj}hb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhj}ubj)r}r(hgX$``(errorCode=500, detailCode=4540)``hm}r(ho]hp]hq]hr]ht]uhhj}hb]rhX (errorCode=500, detailCode=4540)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjuhb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4541)This error is raised if the person attempting to validate the account is not authorized to verify accounts.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainj4hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4541)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4541)rr}r(hgUhhjubahkjubaubh)r}r(hgXkThis error is raised if the person attempting to validate the account is not authorized to verify accounts.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXkThis error is raised if the person attempting to validate the account is not authorized to verify accounts.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r–}rÖ(hgUhm}rĖ(ho]hp]hq]hr]ht]uhhjuhb]rŖh)rƖ}rǖ(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4542)hm}rȖ(ho]hp]hq]hr]ht]uhhj–hb]rɖ(j)rʖ}r˖(hgUhm}r̖(Ureftypej#j"U reftargetXExceptions.NotImplementedr͖U refdomainj4hr]hq]U refexplicitho]hp]ht]uhhjƖhb]rΖj")rϖ}rЖ(hgj͖hm}rі(ho]hp]hq]hr]ht]uhhjʖhb]rҖhXExceptions.NotImplementedrӖrԖ}rՖ(hgUhhjϖubahkj"ubahkjubhX -- r֖rז}rؖ(hgUhhjƖubj)rٖ}rږ(hgX$``(errorCode=501, detailCode=4542)``hm}rۖ(ho]hp]hq]hr]ht]uhhjƖhb]rܖhX (errorCode=501, detailCode=4542)rݖrޖ}rߖ(hgUhhjٖubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjuhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4543)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainj4hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4543)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4543)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjuhb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4544)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestr U refdomainj4hr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=400, detailCode=4544)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4544)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX'getSubjectInfo() (in module CNIdentity)h-UNtr auhvNhwhhb]ubj!)r!}r"(hgUhhjhiNhkj!hm}r#(j"j"Xpyr$hr]hq]ho]hp]ht]j"Xfunctionr%j"j%uhvNhwhhb]r&(j")r'}r((hgX.getSubjectInfo(session,subject) -> SubjectInfohhj!hijhkj "hm}r)(hr]r*h-aj"j͈hq]ho]hp]ht]r+h-aj"XgetSubjectInfor,j"Uj"uhvKhwhhb]r-(j")r.}r/(hgX CNIdentity.hhj'hijhkj"hm}r0(ho]hp]hq]hr]ht]uhvKhwhhb]r1hX CNIdentity.r2r3}r4(hgUhhj.ubaubj")r5}r6(hgj,hhj'hijhkj!"hm}r7(ho]hp]hq]hr]ht]uhvKhwhhb]r8hXgetSubjectInfor9r:}r;(hgUhhj5ubaubj'")r<}r=(hgXsession, subjecthhj'hijhkj*"hm}r>(ho]hp]hq]hr]ht]uhvKhwhhb]r?(j-")r@}rA(hgXsessionhm}rB(ho]hp]hq]hr]ht]uhhj<hb]rChXsessionrDrE}rF(hgUhhj@ubahkj5"ubj-")rG}rH(hgXsubjecthm}rI(ho]hp]hq]hr]ht]uhhj<hb]rJhXsubjectrKrL}rM(hgUhhjGubahkj5"ubeubj6")rN}rO(hgX SubjectInfohhj'hijhkj9"hm}rP(ho]hp]hq]hr]ht]uhvKhwhhb]rQhX SubjectInforRrS}rT(hgUhhjNubaubeubj?")rU}rV(hgUhhj!hijhkjB"hm}rW(ho]hp]hq]hr]ht]uhvKhwhhb]rX(h)rY}rZ(hgXGet the information about a Person (their equivalent identities, and the Groups to which they belong) or the Group (including members).r[hhjUhijhkhhm}r\(ho]hp]hq]hr]ht]uhvKhwhhb]r]hXGet the information about a Person (their equivalent identities, and the Groups to which they belong) or the Group (including members).r^r_}r`(hgj[hhjYubaubh)ra}rb(hgUhhjUhiNhkhhm}rc(ho]hp]hq]hr]ht]uhvNhwhhb]rd(h)re}rf(hgUhhjahijhkhhm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rh(h)ri}rj(hgXVersionhhjehijhkhhm}rk(ho]hp]hq]hr]ht]uhvKhb]rlhXVersionrmrn}ro(hgUhhjiubaubh)rp}rq(hgX 1.0, (2.0)rrhm}rs(ho]hp]hq]hr]ht]uhhjehb]rth)ru}rv(hgjrhhjphijhkhhm}rw(ho]hp]hq]hr]ht]uhvKhb]rxhX 1.0, (2.0)ryrz}r{(hgjrhhjuubaubahkhubeubh)r|}r}(hgUhhjahijhkhhm}r~(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgX Use Caseshhj|hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Use Casesrr}r(hgUhhjubaubh)r}r(hgX$:doc:`UC12 `rhm}r(ho]hp]hq]hr]ht]uhhj|hb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXdocrjjX/design/UseCases/12_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjehq]hr]ht]uhhjhb]rhXUC12rr}r(hgUhhjubahkji2ubaubaubahkhubeubh)r}r(hgUhhjahijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX``GET /accounts/{subject}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /accounts/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjahb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r—(hgUhhjubaubh)r×}rė(hgUhm}rŗ(ho]hp]hq]hr]ht]uhhjhb]rƗj #)rǗ}rȗ(hgUhm}rɗ(ho]hp]hq]hr]ht]uhhj×hb]rʗ(j#)r˗}r̗(hgUhm}r͗(ho]hp]hq]hr]ht]uhhjǗhb]rΗh)rϗ}rЗ(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rї(ho]hp]hq]hr]ht]uhhj˗hb]rҗ(j")rӗ}rԗ(hgXsessionhm}r՗(hr]hq]j"ho]hp]ht]uhhjϗhb]r֗hXsessionrחrؗ}rٗ(hgUhhjӗubahkj"ubhX (rڗrۗ}rܗ(hgUhhjϗubj)rݗ}rޗ(hgX:class:`Types.Session`rߗhhjϗhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjߗhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjݗhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjϗubhX -- rr}r(hgUhhjϗubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjϗubj)r}r(hgX:term:`public user`rhhjϗhijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjϗubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjǗhb]r h)r }r (hgXsubject (Types.Subject) -- The Subject identifier of the Person or Group details to be returned. Transmitted as part of the URL path and must be escaped accordingly.hm}r (ho]hp]hq]hr]ht]uhhjhb]r (j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhj hb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhj ubj)r}r(hgX:class:`Types.Subject`rhhj hijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rj)r}r(hgjhm}r (ho]hp]r!(jjXpy-classr"ehq]hr]ht]uhhjhb]r#hX Types.Subjectr$r%}r&(hgUhhjubahkjubaubhX)r'}r((hgUhhj ubhX -- r)r*}r+(hgUhhj ubhXThe Subject identifier of the Person or Group details to be returned. Transmitted as part of the URL path and must be escaped accordingly.r,r-}r.(hgXThe Subject identifier of the Person or Group details to be returned. Transmitted as part of the URL path and must be escaped accordingly.hhj ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhjahb]r2(h)r3}r4(hgXReturnshhj/hijhkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r6hXReturnsr7r8}r9(hgUhhj3ubaubh)r:}r;(hgUhm}r<(ho]hp]hq]hr]ht]uhhj/hb]r=h)r>}r?(hgX[The Person or Group details are contained in the returned SubjectList for the given Subjecthm}r@(ho]hp]hq]hr]ht]uhhj:hb]rAhX[The Person or Group details are contained in the returned SubjectList for the given SubjectrBrC}rD(hgX[The Person or Group details are contained in the returned SubjectList for the given Subjecthhj>ubahkhubahkhubehkhubh)rE}rF(hgUhm}rG(ho]hp]hq]hr]ht]uhhjahb]rH(h)rI}rJ(hgX Return typehhjEhijhkhhm}rK(ho]hp]hq]hr]ht]uhvKhb]rLhX Return typerMrN}rO(hgUhhjIubaubh)rP}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhjEhb]rSh)rT}rU(hgXTypes.SubjectInfohm}rV(ho]hp]hq]hr]ht]uhhjPhb]rWj)rX}rY(hgX:class:`Types.SubjectInfo`rZhhjThijhkjhm}r[(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyr\hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]r]j)r^}r_(hgjZhm}r`(ho]hp]ra(jj\Xpy-classrbehq]hr]ht]uhhjXhb]rchXTypes.SubjectInfordre}rf(hgUhhj^ubahkjubaubahkhubahkhubehkhubh)rg}rh(hgUhm}ri(ho]hp]hq]hr]ht]uhhjahb]rj(h)rk}rl(hgXRaiseshhjghijhkhhm}rm(ho]hp]hq]hr]ht]uhvKhb]rnhXRaisesrorp}rq(hgUhhjkubaubh)rr}rs(hgUhm}rt(ho]hp]hq]hr]ht]uhhjghb]ruj #)rv}rw(hgUhm}rx(ho]hp]hq]hr]ht]uhhjrhb]ry(j#)rz}r{(hgUhm}r|(ho]hp]hq]hr]ht]uhhjvhb]r}h)r~}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4560)hm}r(ho]hp]hq]hr]ht]uhhjzhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainj$hr]hq]U refexplicitho]hp]ht]uhhj~hb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhj~ubj)r}r(hgX$``(errorCode=501, detailCode=4560)``hm}r(ho]hp]hq]hr]ht]uhhj~hb]rhX (errorCode=501, detailCode=4560)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4561)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainj$hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4561)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4561)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgXExceptions.NotFound -- (errorCode=404, detailCode=4564)Raised if the requested subject is not registered with the DataONE systemhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainj$hr]hq]U refexplicitho]hp]ht]uhhjhb]r˜j")rØ}rĘ(hgjhm}rŘ(ho]hp]hq]hr]ht]uhhjhb]rƘhXExceptions.NotFoundrǘrȘ}rɘ(hgUhhjØubahkj"ubahkjubhX -- rʘr˘}r̘(hgUhhjubh)r͘}rΘ(hgX$``(errorCode=404, detailCode=4564)``rϘhhjhijhkhhm}rИ(ho]hp]hq]hr]ht]uhvKhb]rјj)rҘ}rӘ(hgjϘhm}rԘ(ho]hp]hq]hr]ht]uhhj͘hb]r՘hX (errorCode=404, detailCode=4564)r֘rט}rؘ(hgUhhjҘubahkjubaubh)r٘}rژ(hgXIRaised if the requested subject is not registered with the DataONE systemrۘhhjhijhkhhm}rܘ(ho]hp]hq]hr]ht]uhvKhb]rݘhXIRaised if the requested subject is not registered with the DataONE systemrޘrߘ}r(hgjۘhhj٘ubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4563)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainj$hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4563)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4563)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4564)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r (Ureftypej#j"U reftargetXExceptions.InvalidTokenr U refdomainj$hr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgj hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4564)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4564)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r (jX%listSubjects() (in module CNIdentity)h UNtr!auhvNhwhhb]ubj!)r"}r#(hgUhhjhiNhkj!hm}r$(j"j"Xpyr%hr]hq]ho]hp]ht]j"Xfunctionr&j"j&uhvNhwhhb]r'(j")r(}r)(hgX=listSubjects(session,query,status,start,count) -> SubjectInfohhj"hijhkj "hm}r*(hr]r+h aj"j͈hq]ho]hp]ht]r,h aj"X listSubjectsr-j"Uj"uhvMhwhhb]r.(j")r/}r0(hgX CNIdentity.hhj(hijhkj"hm}r1(ho]hp]hq]hr]ht]uhvMhwhhb]r2hX CNIdentity.r3r4}r5(hgUhhj/ubaubj")r6}r7(hgj-hhj(hijhkj!"hm}r8(ho]hp]hq]hr]ht]uhvMhwhhb]r9hX listSubjectsr:r;}r<(hgUhhj6ubaubj'")r=}r>(hgX$session, query, status, start, counthhj(hijhkj*"hm}r?(ho]hp]hq]hr]ht]uhvMhwhhb]r@(j-")rA}rB(hgXsessionhm}rC(ho]hp]hq]hr]ht]uhhj=hb]rDhXsessionrErF}rG(hgUhhjAubahkj5"ubj-")rH}rI(hgXqueryhm}rJ(ho]hp]hq]hr]ht]uhhj=hb]rKhXqueryrLrM}rN(hgUhhjHubahkj5"ubj-")rO}rP(hgXstatushm}rQ(ho]hp]hq]hr]ht]uhhj=hb]rRhXstatusrSrT}rU(hgUhhjOubahkj5"ubj-")rV}rW(hgXstarthm}rX(ho]hp]hq]hr]ht]uhhj=hb]rYhXstartrZr[}r\(hgUhhjVubahkj5"ubj-")r]}r^(hgXcounthm}r_(ho]hp]hq]hr]ht]uhhj=hb]r`hXcountrarb}rc(hgUhhj]ubahkj5"ubeubj6")rd}re(hgX SubjectInfohhj(hijhkj9"hm}rf(ho]hp]hq]hr]ht]uhvMhwhhb]rghX SubjectInforhri}rj(hgUhhjdubaubeubj?")rk}rl(hgUhhj"hijhkjB"hm}rm(ho]hp]hq]hr]ht]uhvMhwhhb]rn(h)ro}rp(hgXTList the subjects, including users, groups, and systems, that match search criteria.rqhhjkhijhkhhm}rr(ho]hp]hq]hr]ht]uhvKhwhhb]rshXTList the subjects, including users, groups, and systems, that match search criteria.rtru}rv(hgjqhhjoubaubh)rw}rx(hgXThe list can be restricted to subjects whose identifier matches certain substrings, and the size of the resultset can be paged through.ryhhjkhijhkhhm}rz(ho]hp]hq]hr]ht]uhvKhwhhb]r{hXThe list can be restricted to subjects whose identifier matches certain substrings, and the size of the resultset can be paged through.r|r}}r~(hgjyhhjwubaubh)r}r(hgUhhjkhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgXM``GET /accounts?query={query}[&status={status}&start={start}&count={count}]``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXIGET /accounts?query={query}[&status={status}&start={start}&count={count}]rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r™(ho]hp]hq]hr]ht]uhhjhb]rÙj #)rę}rř(hgUhm}rƙ(ho]hp]hq]hr]ht]uhhjhb]rǙ(j#)rș}rə(hgUhm}rʙ(ho]hp]hq]hr]ht]uhhjęhb]r˙h)r̙}r͙(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}rΙ(ho]hp]hq]hr]ht]uhhjșhb]rϙ(j")rЙ}rљ(hgXsessionhm}rҙ(hr]hq]j"ho]hp]ht]uhhj̙hb]rәhXsessionrԙrՙ}r֙(hgUhhjЙubahkj"ubhX (rיrؙ}rٙ(hgUhhj̙ubj)rڙ}rۙ(hgX:class:`Types.Session`rܙhhj̙hijhkjhm}rݙ(UreftypeXclassjjX Types.SessionU refdomainXpyrޙhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvKhb]rߙj)r}r(hgjܙhm}r(ho]hp]r(jjޙXpy-classrehq]hr]ht]uhhjڙhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhj̙ubhX -- rr}r(hgUhhj̙ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhj̙ubj)r}r(hgX:term:`public user`rhhj̙hijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhj̙ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjęhb]rh)r}r(hgXgquery (string) -- A query string criteria to be matched using a case-insensitive substring match against the identifier for the principal, the givenName or familyName of users, and the groupName of groups. The function returns the union of all successful matches against these fields. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r (ho]hp]hq]hr]ht]uhhjhb]r (j")r }r (hgXqueryhm}r (hr]hq]j"ho]hp]ht]uhhjhb]rhXqueryrr}r(hgUhhj ubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgUhm}r(Ureftypej&j"U reftargetXstringrU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjhb]rj&)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXstringrr}r (hgUhhjubahkj&ubahkjubhX)r!}r"(hgUhhjubhX -- r#r$}r%(hgUhhjubhXUA query string criteria to be matched using a case-insensitive substring match against the identifier for the principal, the givenName or familyName of users, and the groupName of groups. The function returns the union of all successful matches against these fields. Transmitted as a URL query parameter, and so must be escaped accordingly.r&r'}r((hgXUA query string criteria to be matched using a case-insensitive substring match against the identifier for the principal, the givenName or familyName of users, and the groupName of groups. The function returns the union of all successful matches against these fields. Transmitted as a URL query parameter, and so must be escaped accordingly.hhjubehkhubahkj;#ubj#)r)}r*(hgUhm}r+(ho]hp]hq]hr]ht]uhhjęhb]r,h)r-}r.(hgXstatus (string) -- When provided, the status field can limit the returned list of Subjects to only those with the given status. Currently the 'verified' status is supported. Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r/(ho]hp]hq]hr]ht]uhhj)hb]r0(j")r1}r2(hgXstatushm}r3(hr]hq]j"ho]hp]ht]uhhj-hb]r4hXstatusr5r6}r7(hgUhhj1ubahkj"ubhX (r8r9}r:(hgUhhj-ubj)r;}r<(hgUhm}r=(Ureftypej&j"U reftargetXstringr>U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj-hb]r?j&)r@}rA(hgj>hm}rB(ho]hp]hq]hr]ht]uhhj;hb]rChXstringrDrE}rF(hgUhhj@ubahkj&ubahkjubhX)rG}rH(hgUhhj-ubhX -- rIrJ}rK(hgUhhj-ubhXWhen provided, the status field can limit the returned list of Subjects to only those with the given status. Currently the 'verified' status is supported. Transmitted as a URL query parameter, and so must be escaped accordingly.rLrM}rN(hgXWhen provided, the status field can limit the returned list of Subjects to only those with the given status. Currently the 'verified' status is supported. Transmitted as a URL query parameter, and so must be escaped accordingly.hhj-ubehkhubahkj;#ubj#)rO}rP(hgUhm}rQ(ho]hp]hq]hr]ht]uhhjęhb]rRh)rS}rT(hgXstart (integer) -- The starting record number for the records to be returned (default = 0). Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rU(ho]hp]hq]hr]ht]uhhjOhb]rV(j")rW}rX(hgXstarthm}rY(hr]hq]j"ho]hp]ht]uhhjShb]rZhXstartr[r\}r](hgUhhjWubahkj"ubhX (r^r_}r`(hgUhhjSubj)ra}rb(hgUhm}rc(Ureftypej&j"U reftargetXintegerrdU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjShb]rej&)rf}rg(hgjdhm}rh(ho]hp]hq]hr]ht]uhhjahb]rihXintegerrjrk}rl(hgUhhjfubahkj&ubahkjubhX)rm}rn(hgUhhjSubhX -- rorp}rq(hgUhhjSubhXThe starting record number for the records to be returned (default = 0). Transmitted as a URL query parameter, and so must be escaped accordingly.rrrs}rt(hgXThe starting record number for the records to be returned (default = 0). Transmitted as a URL query parameter, and so must be escaped accordingly.hhjSubehkhubahkj;#ubj#)ru}rv(hgUhm}rw(ho]hp]hq]hr]ht]uhhjęhb]rxh)ry}rz(hgX:count (integer) -- The maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the total in the response to determine if further pages may be retrieved (default = 100). Transmitted as a URL query parameter, and so must be escaped accordingly.hm}r{(ho]hp]hq]hr]ht]uhhjuhb]r|(j")r}}r~(hgXcounthm}r(hr]hq]j"ho]hp]ht]uhhjyhb]rhXcountrr}r(hgUhhj}ubahkj"ubhX (rr}r(hgUhhjyubj)r}r(hgUhm}r(Ureftypej&j"U reftargetXintegerrU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjyhb]rj&)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXintegerrr}r(hgUhhjubahkj&ubahkjubhX)r}r(hgUhhjyubhX -- rr}r(hgUhhjyubhXThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the rr}r(hgXThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the hhjyubj$)r}r(hgX*total*hm}r(ho]hp]hq]hr]ht]uhhjyhb]rhXtotalrr}r(hgUhhjubahkj$ubhX in the response to determine if further pages may be retrieved (default = 100). Transmitted as a URL query parameter, and so must be escaped accordingly.rr}r(hgX in the response to determine if further pages may be retrieved (default = 100). Transmitted as a URL query parameter, and so must be escaped accordingly.hhjyubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX3The list of people and groups that match the query.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX3The list of people and groups that match the query.rr}r(hgX3The list of people and groups that match the query.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Return typehhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]ršhX Return typerÚrĚ}rŚ(hgUhhjubaubh)rƚ}rǚ(hgUhm}rȚ(ho]hp]hq]hr]ht]uhhjhb]rɚh)rʚ}r˚(hgXTypes.SubjectInfohm}r̚(ho]hp]hq]hr]ht]uhhjƚhb]r͚j)rΚ}rϚ(hgX:class:`Types.SubjectInfo`rКhhjʚhijhkjhm}rњ(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyrҚhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rӚj)rԚ}r՚(hgjКhm}r֚(ho]hp]rך(jjҚXpy-classrؚehq]hr]ht]uhhjΚhb]rٚhXTypes.SubjectInforښrۚ}rܚ(hgUhhjԚubahkjubaubahkhubahkhubehkhubh)rݚ}rޚ(hgUhm}rߚ(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXRaiseshhjݚhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjݚhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2290)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=2290)``hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX (errorCode=500, detailCode=2290)r r }r (hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2270)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr }r!(hgUhhjubahkj"ubahkjubhX -- r"r#}r$(hgUhhjubj)r%}r&(hgX$``(errorCode=401, detailCode=2270)``hm}r'(ho]hp]hq]hr]ht]uhhjhb]r(hX (errorCode=401, detailCode=2270)r)r*}r+(hgUhhj%ubahkjubehkhubahkj;#ubj#)r,}r-(hgUhm}r.(ho]hp]hq]hr]ht]uhhjhb]r/h)r0}r1(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2260)hm}r2(ho]hp]hq]hr]ht]uhhj,hb]r3(j)r4}r5(hgUhm}r6(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr7U refdomainj%hr]hq]U refexplicitho]hp]ht]uhhj0hb]r8j")r9}r:(hgj7hm}r;(ho]hp]hq]hr]ht]uhhj4hb]r<hXExceptions.NotAuthorizedr=r>}r?(hgUhhj9ubahkj"ubahkjubhX -- r@rA}rB(hgUhhj0ubj)rC}rD(hgX$``(errorCode=401, detailCode=2260)``hm}rE(ho]hp]hq]hr]ht]uhhj0hb]rFhX (errorCode=401, detailCode=2260)rGrH}rI(hgUhhjCubahkjubehkhubahkj;#ubj#)rJ}rK(hgUhm}rL(ho]hp]hq]hr]ht]uhhjhb]rMh)rN}rO(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2261)hm}rP(ho]hp]hq]hr]ht]uhhjJhb]rQ(j)rR}rS(hgUhm}rT(Ureftypej#j"U reftargetXExceptions.NotImplementedrUU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjNhb]rVj")rW}rX(hgjUhm}rY(ho]hp]hq]hr]ht]uhhjRhb]rZhXExceptions.NotImplementedr[r\}r](hgUhhjWubahkj"ubahkjubhX -- r^r_}r`(hgUhhjNubj)ra}rb(hgX$``(errorCode=501, detailCode=2261)``hm}rc(ho]hp]hq]hr]ht]uhhjNhb]rdhX (errorCode=501, detailCode=2261)rerf}rg(hgUhhjaubahkjubehkhubahkj;#ubj#)rh}ri(hgUhm}rj(ho]hp]hq]hr]ht]uhhjhb]rkh)rl}rm(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2262)hm}rn(ho]hp]hq]hr]ht]uhhjhhb]ro(j)rp}rq(hgUhm}rr(Ureftypej#j"U reftargetXExceptions.InvalidRequestrsU refdomainj%hr]hq]U refexplicitho]hp]ht]uhhjlhb]rtj")ru}rv(hgjshm}rw(ho]hp]hq]hr]ht]uhhjphb]rxhXExceptions.InvalidRequestryrz}r{(hgUhhjuubahkj"ubahkjubhX -- r|r}}r~(hgUhhjlubj)r}r(hgX$``(errorCode=400, detailCode=2262)``hm}r(ho]hp]hq]hr]ht]uhhjlhb]rhX (errorCode=400, detailCode=2262)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX$mapIdentity() (in module CNIdentity)hLUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX?mapIdentity(session,primarySubject,secondarySubject) -> booleanhhjhijhkj "hm}r(hr]rhLaj"j͈hq]ho]hp]ht]rhLaj"X mapIdentityrj"Uj"uhvMEhwhhb]r(j")r}r(hgX CNIdentity.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvMEhwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhjhijhkj!"hm}r(ho]hp]hq]hr]ht]uhvMEhwhhb]rhX mapIdentityrr}r(hgUhhjubaubj'")r}r(hgX)session, primarySubject, secondarySubjecthhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvMEhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXprimarySubjecthm}r(ho]hp]hq]hr]ht]uhhjhb]rhXprimarySubjectrr}r(hgUhhjubahkj5"ubj-")r}r(hgXsecondarySubjecthm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsecondarySubjectrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjhijhkj9"hm}r(ho]hp]hq]hr]ht]uhvMEhwhhb]r›hXbooleanrÛrě}rś(hgUhhjubaubeubj?")rƛ}rǛ(hgUhhjhijhkjB"hm}rț(ho]hp]hq]hr]ht]uhvMEhwhhb]rɛ(h)rʛ}r˛(hgX`Create a new mapping between the two identities, asserting that they represent the same subject.r̛hhjƛhijhkhhm}r͛(ho]hp]hq]hr]ht]uhvMhwhhb]rΛhX`Create a new mapping between the two identities, asserting that they represent the same subject.rϛrЛ}rћ(hgj̛hhjʛubaubh)rқ}rӛ(hgXMapping identities with this method requires explicit authorization for the user given in the Session object. The caller must have made sure that the primary and secondary identities represent one and the same individual.rԛhhjƛhijhkhhm}r՛(ho]hp]hq]hr]ht]uhvMhwhhb]r֛hXMapping identities with this method requires explicit authorization for the user given in the Session object. The caller must have made sure that the primary and secondary identities represent one and the same individual.rכr؛}rٛ(hgjԛhhjқubaubh)rڛ}rۛ(hgXTSuccessful completion of the request is indicated by returning a HTTP status of 200.rܛhhjƛhijhkhhm}rݛ(ho]hp]hq]hr]ht]uhvMhwhhb]rޛhXTSuccessful completion of the request is indicated by returning a HTTP status of 200.rߛr}r(hgjܛhhjڛubaubh)r}r(hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rhhjƛhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rr}r(hgjhhjubaubh)r}r(hgUhhjƛhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM!hwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM!hb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM"hwhhb]r(h)r }r (hgXREST URLhhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hXREST URLr r}r(hgUhhj ubaubh)r}r(hgX``POST /accounts/map``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvM"hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPOST /accounts/maprr}r(hgUhhjubahkjubaubahkhubeubh)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#(h)r$}r%(hgX Parametershhj hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKhb]r'hX Parametersr(r)}r*(hgUhhj$ubaubh)r+}r,(hgUhm}r-(ho]hp]hq]hr]ht]uhhj hb]r.j #)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhj+hb]r2(j#)r3}r4(hgUhm}r5(ho]hp]hq]hr]ht]uhhj/hb]r6h)r7}r8(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:(j")r;}r<(hgXsessionhm}r=(hr]hq]j"ho]hp]ht]uhhj7hb]r>hXsessionr?r@}rA(hgUhhj;ubahkj"ubhX (rBrC}rD(hgUhhj7ubj)rE}rF(hgX:class:`Types.Session`rGhhj7hijhkjhm}rH(UreftypeXclassjjX Types.SessionU refdomainXpyrIhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM$hb]rJj)rK}rL(hgjGhm}rM(ho]hp]rN(jjIXpy-classrOehq]hr]ht]uhhjEhb]rPhX Types.SessionrQrR}rS(hgUhhjKubahkjubaubhX)rT}rU(hgUhhj7ubhX -- rVrW}rX(hgUhhj7ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.rYrZ}r[(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhj7ubehkhubahkj;#ubj#)r\}r](hgUhm}r^(ho]hp]hq]hr]ht]uhhj/hb]r_h)r`}ra(hgXprimarySubject (Types.Subject) -- The Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rb(ho]hp]hq]hr]ht]uhhj\hb]rc(j")rd}re(hgXprimarySubjecthm}rf(hr]hq]j"ho]hp]ht]uhhj`hb]rghXprimarySubjectrhri}rj(hgUhhjdubahkj"ubhX (rkrl}rm(hgUhhj`ubj)rn}ro(hgX:class:`Types.Subject`rphhj`hijhkjhm}rq(UreftypeXclassjjX Types.SubjectU refdomainXpyrrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM'hb]rsj)rt}ru(hgjphm}rv(ho]hp]rw(jjrXpy-classrxehq]hr]ht]uhhjnhb]ryhX Types.Subjectrzr{}r|(hgUhhjtubahkjubaubhX)r}}r~(hgUhhj`ubhX -- rr}r(hgUhhj`ubhXxThe Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a rr}r(hgXxThe Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a hhj`ubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhj`hb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhj`ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj/hb]rh)r}r(hgXsecondarySubject (Types.Subject) -- The Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsecondarySubjecthm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsecondarySubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Subject`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM*hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXxThe Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a rr}r(hgXxThe Subject identifier that will have a mapped identity to the other given subject. Transmitted as a UTF-8 String as a hhjubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)rœ}rÜ(hgUhm}rĜ(ho]hp]hq]hr]ht]uhhjhb]rŜ(h)rƜ}rǜ(hgXReturnshhjœhijhkhhm}rȜ(ho]hp]hq]hr]ht]uhvKhb]rɜhXReturnsrʜr˜}r̜(hgUhhjƜubaubh)r͜}rΜ(hgUhm}rϜ(ho]hp]hq]hr]ht]uhhjœhb]rМh)rќ}rҜ(hgX@True if the mapping was successfully initiated, false otherwise.hm}rӜ(ho]hp]hq]hr]ht]uhhj͜hb]rԜhX@True if the mapping was successfully initiated, false otherwise.r՜r֜}rל(hgX@True if the mapping was successfully initiated, false otherwise.hhjќubahkhubahkhubehkhubh)r؜}rٜ(hgUhm}rڜ(ho]hp]hq]hr]ht]uhhjhb]rۜ(h)rܜ}rݜ(hgX Return typehhj؜hijhkhhm}rޜ(ho]hp]hq]hr]ht]uhvKhb]rߜhX Return typerr}r(hgUhhjܜubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj؜hb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXRaiseshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r (hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}r (ho]hp]hq]hr]ht]uhhjhb]r (j)r }r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhj hb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhj hb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhj ubj)r}r(hgX$``(errorCode=500, detailCode=2390)``hm}r(ho]hp]hq]hr]ht]uhhj hb]rhX (errorCode=500, detailCode=2390)r r!}r"(hgUhhjubahkjubehkhubahkj;#ubj#)r#}r$(hgUhm}r%(ho]hp]hq]hr]ht]uhhjhb]r&h)r'}r((hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2370)hm}r)(ho]hp]hq]hr]ht]uhhj#hb]r*(j)r+}r,(hgUhm}r-(Ureftypej#j"U reftargetXExceptions.InvalidTokenr.U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj'hb]r/j")r0}r1(hgj.hm}r2(ho]hp]hq]hr]ht]uhhj+hb]r3hXExceptions.InvalidTokenr4r5}r6(hgUhhj0ubahkj"ubahkjubhX -- r7r8}r9(hgUhhj'ubj)r:}r;(hgX$``(errorCode=401, detailCode=2370)``hm}r<(ho]hp]hq]hr]ht]uhhj'hb]r=hX (errorCode=401, detailCode=2370)r>r?}r@(hgUhhj:ubahkjubehkhubahkj;#ubj#)rA}rB(hgUhm}rC(ho]hp]hq]hr]ht]uhhjhb]rDh)rE}rF(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to map these two identitieshm}rG(ho]hp]hq]hr]ht]uhhjAhb]rH(j)rI}rJ(hgUhm}rK(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrLU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjEhb]rMj")rN}rO(hgjLhm}rP(ho]hp]hq]hr]ht]uhhjIhb]rQhXExceptions.NotAuthorizedrRrS}rT(hgUhhjNubahkj"ubahkjubhX -- rUrV}rW(hgUhhjEubh)rX}rY(hgX$``(errorCode=401, detailCode=2360)``rZhhjEhijhkhhm}r[(ho]hp]hq]hr]ht]uhvM3hb]r\j)r]}r^(hgjZhm}r_(ho]hp]hq]hr]ht]uhhjXhb]r`hX (errorCode=401, detailCode=2360)rarb}rc(hgUhhj]ubahkjubaubh)rd}re(hgXKThe supplied principal does not have permission to map these two identitiesrfhhjEhijhkhhm}rg(ho]hp]hq]hr]ht]uhvM5hb]rhhXKThe supplied principal does not have permission to map these two identitiesrirj}rk(hgjfhhjdubaubehkhubahkj;#ubj#)rl}rm(hgUhm}rn(ho]hp]hq]hr]ht]uhhjhb]roh)rp}rq(hgXsExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE systemhm}rr(ho]hp]hq]hr]ht]uhhjlhb]rs(j)rt}ru(hgUhm}rv(Ureftypej#j"U reftargetXExceptions.NotFoundrwU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjphb]rxj")ry}rz(hgjwhm}r{(ho]hp]hq]hr]ht]uhhjthb]r|hXExceptions.NotFoundr}r~}r(hgUhhjyubahkj"ubahkjubhX -- rr}r(hgUhhjpubh)r}r(hgX$``(errorCode=404, detailCode=2340)``rhhjphijhkhhm}r(ho]hp]hq]hr]ht]uhvM7hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2340)rr}r(hgUhhjubahkjubaubh)r}r(hgX<The specified principal does not exist in the DataONE systemrhhjphijhkhhm}r(ho]hp]hq]hr]ht]uhvM9hb]rhX<The specified principal does not exist in the DataONE systemrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=2361)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=2361)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2342)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}rÝ(hgjhm}rĝ(ho]hp]hq]hr]ht]uhhjhb]rŝhXExceptions.InvalidRequestrƝrǝ}rȝ(hgUhhjubahkj"ubahkjubhX -- rɝrʝ}r˝(hgUhhjubj)r̝}r͝(hgX$``(errorCode=400, detailCode=2342)``hm}rΝ(ho]hp]hq]hr]ht]uhhjhb]rϝhX (errorCode=400, detailCode=2342)rНrѝ}rҝ(hgUhhj̝ubahkjubehkhubahkj;#ubj#)rӝ}rԝ(hgUhm}r՝(ho]hp]hq]hr]ht]uhhjhb]r֝h)rם}r؝(hgXExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=2343)The subject of the session and the provided subject are the samehm}rٝ(ho]hp]hq]hr]ht]uhhjӝhb]rڝ(j)r۝}rܝ(hgUhm}rݝ(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerޝU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjםhb]rߝj")r}r(hgjޝhm}r(ho]hp]hq]hr]ht]uhhj۝hb]rhXExceptions.IdentifierNotUniquerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjםubh)r}r(hgX$``(errorCode=409, detailCode=2343)``rhhjםhijhkhhm}r(ho]hp]hq]hr]ht]uhvM?hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=409, detailCode=2343)rr}r(hgUhhjubahkjubaubh)r}r(hgX@The subject of the session and the provided subject are the samerhhjםhijhkhhm}r(ho]hp]hq]hr]ht]uhvMAhb]rhX@The subject of the session and the provided subject are the samerr}r(hgjhhjubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX*removeMapIdentity() (in module CNIdentity)hUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r }r (hgX-removeMapIdentity(session,subject) -> booleanhhjhijhkj "hm}r (hr]r haj"j͈hq]ho]hp]ht]r haj"XremoveMapIdentityrj"Uj"uhvMihwhhb]r(j")r}r(hgX CNIdentity.hhj hijhkj"hm}r(ho]hp]hq]hr]ht]uhvMihwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhj hijhkj!"hm}r(ho]hp]hq]hr]ht]uhvMihwhhb]rhXremoveMapIdentityrr}r(hgUhhjubaubj'")r}r(hgXsession, subjecthhj hijhkj*"hm}r (ho]hp]hq]hr]ht]uhvMihwhhb]r!(j-")r"}r#(hgXsessionhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%hXsessionr&r'}r((hgUhhj"ubahkj5"ubj-")r)}r*(hgXsubjecthm}r+(ho]hp]hq]hr]ht]uhhjhb]r,hXsubjectr-r.}r/(hgUhhj)ubahkj5"ubeubj6")r0}r1(hgXbooleanhhj hijhkj9"hm}r2(ho]hp]hq]hr]ht]uhvMihwhhb]r3hXbooleanr4r5}r6(hgUhhj0ubaubeubj?")r7}r8(hgUhhjhijhkjB"hm}r9(ho]hp]hq]hr]ht]uhvMihwhhb]r:(h)r;}r<(hgXRemoves a previously asserted identity mapping from the Subject in the Session to the Subject given by the parameter. The reciprocol mapping entry is also removed.r=hhj7hijhkhhm}r>(ho]hp]hq]hr]ht]uhvMHhwhhb]r?hXRemoves a previously asserted identity mapping from the Subject in the Session to the Subject given by the parameter. The reciprocol mapping entry is also removed.r@rA}rB(hgj=hhj;ubaubh)rC}rD(hgXDA successful request is indicated by returning a HTTP status of 200.rEhhj7hijhkhhm}rF(ho]hp]hq]hr]ht]uhvMJhwhhb]rGhXDA successful request is indicated by returning a HTTP status of 200.rHrI}rJ(hgjEhhjCubaubh)rK}rL(hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rMhhj7hijhkhhm}rN(ho]hp]hq]hr]ht]uhvMLhwhhb]rOhXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rPrQ}rR(hgjMhhjKubaubh)rS}rT(hgUhhj7hiNhkhhm}rU(ho]hp]hq]hr]ht]uhvNhwhhb]rV(h)rW}rX(hgUhhjShijhkhhm}rY(ho]hp]hq]hr]ht]uhvMNhwhhb]rZ(h)r[}r\(hgXVersionhhjWhijhkhhm}r](ho]hp]hq]hr]ht]uhvKhb]r^hXVersionr_r`}ra(hgUhhj[ubaubh)rb}rc(hgX 1.0, (2.0)rdhm}re(ho]hp]hq]hr]ht]uhhjWhb]rfh)rg}rh(hgjdhhjbhijhkhhm}ri(ho]hp]hq]hr]ht]uhvMNhb]rjhX 1.0, (2.0)rkrl}rm(hgjdhhjgubaubahkhubeubh)rn}ro(hgUhhjShijhkhhm}rp(ho]hp]hq]hr]ht]uhvMOhwhhb]rq(h)rr}rs(hgXREST URLhhjnhijhkhhm}rt(ho]hp]hq]hr]ht]uhvKhb]ruhXREST URLrvrw}rx(hgUhhjrubaubh)ry}rz(hgX"``DELETE /accounts/map/{subject}``r{hm}r|(ho]hp]hq]hr]ht]uhhjnhb]r}h)r~}r(hgj{hhjyhijhkhhm}r(ho]hp]hq]hr]ht]uhvMOhb]rj)r}r(hgj{hm}r(ho]hp]hq]hr]ht]uhhj~hb]rhXDELETE /accounts/map/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjShb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMQhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.ržrÞ}rĞ(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)rŞ}rƞ(hgUhm}rǞ(ho]hp]hq]hr]ht]uhhjhb]rȞh)rɞ}rʞ(hgXsubject (Types.Subject) -- The Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hm}r˞(ho]hp]hq]hr]ht]uhhjŞhb]r̞(j")r͞}rΞ(hgXsubjecthm}rϞ(hr]hq]j"ho]hp]ht]uhhjɞhb]rОhXsubjectrўrҞ}rӞ(hgUhhj͞ubahkj"ubhX (rԞr՞}r֞(hgUhhjɞubj)rמ}r؞(hgX:class:`Types.Subject`rٞhhjɞhijhkjhm}rڞ(UreftypeXclassjjX Types.SubjectU refdomainXpyr۞hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMThb]rܞj)rݞ}rޞ(hgjٞhm}rߞ(ho]hp]r(jj۞Xpy-classrehq]hr]ht]uhhjמhb]rhX Types.Subjectrr}r(hgUhhjݞubahkjubaubhX)r}r(hgUhhjɞubhX -- rr}r(hgUhhjɞubhXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hhjɞubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjShb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:True if the map was successfully created, false otherwise.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX:True if the map was successfully created, false otherwise.rr}r(hgX:True if the map was successfully created, false otherwise.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjShb]r(h)r}r (hgX Return typehhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX Return typer r }r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjShb]r!(h)r"}r#(hgXRaiseshhjhijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r%hXRaisesr&r'}r((hgUhhj"ubaubh)r)}r*(hgUhm}r+(ho]hp]hq]hr]ht]uhhjhb]r,j #)r-}r.(hgUhm}r/(ho]hp]hq]hr]ht]uhhj)hb]r0(j#)r1}r2(hgUhm}r3(ho]hp]hq]hr]ht]uhhj-hb]r4h)r5}r6(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}r7(ho]hp]hq]hr]ht]uhhj1hb]r8(j)r9}r:(hgUhm}r;(Ureftypej#j"U reftargetXExceptions.ServiceFailurer<U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj5hb]r=j")r>}r?(hgj<hm}r@(ho]hp]hq]hr]ht]uhhj9hb]rAhXExceptions.ServiceFailurerBrC}rD(hgUhhj>ubahkj"ubahkjubhX -- rErF}rG(hgUhhj5ubj)rH}rI(hgX$``(errorCode=500, detailCode=2390)``hm}rJ(ho]hp]hq]hr]ht]uhhj5hb]rKhX (errorCode=500, detailCode=2390)rLrM}rN(hgUhhjHubahkjubehkhubahkj;#ubj#)rO}rP(hgUhm}rQ(ho]hp]hq]hr]ht]uhhj-hb]rRh)rS}rT(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2370)hm}rU(ho]hp]hq]hr]ht]uhhjOhb]rV(j)rW}rX(hgUhm}rY(Ureftypej#j"U reftargetXExceptions.InvalidTokenrZU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjShb]r[j")r\}r](hgjZhm}r^(ho]hp]hq]hr]ht]uhhjWhb]r_hXExceptions.InvalidTokenr`ra}rb(hgUhhj\ubahkj"ubahkjubhX -- rcrd}re(hgUhhjSubj)rf}rg(hgX$``(errorCode=401, detailCode=2370)``hm}rh(ho]hp]hq]hr]ht]uhhjShb]rihX (errorCode=401, detailCode=2370)rjrk}rl(hgUhhjfubahkjubehkhubahkj;#ubj#)rm}rn(hgUhm}ro(ho]hp]hq]hr]ht]uhhj-hb]rph)rq}rr(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to map these two identitieshm}rs(ho]hp]hq]hr]ht]uhhjmhb]rt(j)ru}rv(hgUhm}rw(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrxU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjqhb]ryj")rz}r{(hgjxhm}r|(ho]hp]hq]hr]ht]uhhjuhb]r}hXExceptions.NotAuthorizedr~r}r(hgUhhjzubahkj"ubahkjubhX -- rr}r(hgUhhjqubh)r}r(hgX$``(errorCode=401, detailCode=2360)``rhhjqhijhkhhm}r(ho]hp]hq]hr]ht]uhvM]hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2360)rr}r(hgUhhjubahkjubaubh)r}r(hgXKThe supplied principal does not have permission to map these two identitiesrhhjqhijhkhhm}r(ho]hp]hq]hr]ht]uhvM_hb]rhXKThe supplied principal does not have permission to map these two identitiesrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj-hb]rh)r}r(hgXExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=2340)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMahb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2340)rr}r(hgUhhjubahkjubaubh)r}r(hgX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMchb]rhX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rr}rŸ(hgjhhjubaubehkhubahkj;#ubj#)rß}rğ(hgUhm}rş(ho]hp]hq]hr]ht]uhhj-hb]rƟh)rǟ}rȟ(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}rɟ(ho]hp]hq]hr]ht]uhhjßhb]rʟ(j)r˟}r̟(hgUhm}r͟(Ureftypej#j"U reftargetXExceptions.NotImplementedrΟU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjǟhb]rϟj")rП}rџ(hgjΟhm}rҟ(ho]hp]hq]hr]ht]uhhj˟hb]rӟhXExceptions.NotImplementedrԟr՟}r֟(hgUhhjПubahkj"ubahkjubhX -- rןr؟}rٟ(hgUhhjǟubj)rڟ}r۟(hgX$``(errorCode=501, detailCode=2361)``hm}rܟ(ho]hp]hq]hr]ht]uhhjǟhb]rݟhX (errorCode=501, detailCode=2361)rޟrߟ}r(hgUhhjڟubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX+requestMapIdentity() (in module CNIdentity)h?UNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX.requestMapIdentity(session,subject) -> booleanhhjhijhkj "hm}r(hr]rh?aj"j͈hq]ho]hp]ht]rh?aj"XrequestMapIdentityrj"Uj"uhvMhwhhb]r(j")r}r(hgX CNIdentity.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhjhijhkj!"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhXrequestMapIdentityrr}r(hgUhhjubaubj'")r}r(hgXsession, subjecthhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionr r }r (hgUhhjubahkj5"ubj-")r }r (hgXsubjecthm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsubjectrr}r(hgUhhj ubahkj5"ubeubj6")r}r(hgXbooleanhhjhijhkj9"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjhijhkjB"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(h)r}r(hgXRequest a new mapping between the authenticated identity in the session and the given identity, asserting that they represent the same subject.r hhjhijhkhhm}r!(ho]hp]hq]hr]ht]uhvMlhwhhb]r"hXRequest a new mapping between the authenticated identity in the session and the given identity, asserting that they represent the same subject.r#r$}r%(hgj hhjubaubh)r&}r'(hgXMapping identities is a two-step process wherein a map request is made by a primary Subject and a subsequent (confirmation) map request is made by the secondary Subject. This ensures that mappings are performed only by those that have authority to do so.r(hhjhijhkhhm}r)(ho]hp]hq]hr]ht]uhvMnhwhhb]r*hXMapping identities is a two-step process wherein a map request is made by a primary Subject and a subsequent (confirmation) map request is made by the secondary Subject. This ensures that mappings are performed only by those that have authority to do so.r+r,}r-(hgj(hhj&ubaubh)r.}r/(hgXTSuccessful completion of the request is indicated by returning a HTTP status of 200.r0hhjhijhkhhm}r1(ho]hp]hq]hr]ht]uhvMphwhhb]r2hXTSuccessful completion of the request is indicated by returning a HTTP status of 200.r3r4}r5(hgj0hhj.ubaubh)r6}r7(hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.r8hhjhijhkhhm}r9(ho]hp]hq]hr]ht]uhvMrhwhhb]r:hXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.r;r<}r=(hgj8hhj6ubaubh)r>}r?(hgUhhjhiNhkhhm}r@(ho]hp]hq]hr]ht]uhvNhwhhb]rA(h)rB}rC(hgUhhj>hijhkhhm}rD(ho]hp]hq]hr]ht]uhvMthwhhb]rE(h)rF}rG(hgXVersionhhjBhijhkhhm}rH(ho]hp]hq]hr]ht]uhvKhb]rIhXVersionrJrK}rL(hgUhhjFubaubh)rM}rN(hgX 1.0, (2.0)rOhm}rP(ho]hp]hq]hr]ht]uhhjBhb]rQh)rR}rS(hgjOhhjMhijhkhhm}rT(ho]hp]hq]hr]ht]uhvMthb]rUhX 1.0, (2.0)rVrW}rX(hgjOhhjRubaubahkhubeubh)rY}rZ(hgUhhj>hijhkhhm}r[(ho]hp]hq]hr]ht]uhvMuhwhhb]r\(h)r]}r^(hgXREST URLhhjYhijhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r`hXREST URLrarb}rc(hgUhhj]ubaubh)rd}re(hgX``POST /accounts/pendingmap``rfhm}rg(ho]hp]hq]hr]ht]uhhjYhb]rhh)ri}rj(hgjfhhjdhijhkhhm}rk(ho]hp]hq]hr]ht]uhvMuhb]rlj)rm}rn(hgjfhm}ro(ho]hp]hq]hr]ht]uhhjihb]rphXPOST /accounts/pendingmaprqrr}rs(hgUhhjmubahkjubaubahkhubeubh)rt}ru(hgUhm}rv(ho]hp]hq]hr]ht]uhhj>hb]rw(h)rx}ry(hgX Parametershhjthijhkhhm}rz(ho]hp]hq]hr]ht]uhvKhb]r{hX Parametersr|r}}r~(hgUhhjxubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjthb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMwhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXsubject (Types.Subject) -- The Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r }rà(hgX:class:`Types.Subject`rĠhhjhijhkjhm}rŠ(UreftypeXclassjjX Types.SubjectU refdomainXpyrƠhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMzhb]rǠj)rȠ}rɠ(hgjĠhm}rʠ(ho]hp]rˠ(jjƠXpy-classr̠ehq]hr]ht]uhhj hb]r͠hX Types.SubjectrΠrϠ}rР(hgUhhjȠubahkjubaubhX)rѠ}rҠ(hgUhhjubhX -- rӠrԠ}rՠ(hgUhhjubhXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as a UTF-8 String as a r֠rנ}rؠ(hgXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as a UTF-8 String as a hhjubj$)r٠}rڠ(hgX *Param part*hm}r۠(ho]hp]hq]hr]ht]uhhjhb]rܠhX Param partrݠrޠ}rߠ(hgUhhj٠ubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj>hb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX@True if the mapping was successfully initiated, false otherwise.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX@True if the mapping was successfully initiated, false otherwise.rr}r(hgX@True if the mapping was successfully initiated, false otherwise.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj>hb]r(h)r}r(hgX Return typehhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r (hgXbooleanhm}r (ho]hp]hq]hr]ht]uhhjhb]r j)r }r (hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhj ubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj>hb]r(h)r}r(hgXRaiseshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r!j #)r"}r#(hgUhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%(j#)r&}r'(hgUhm}r((ho]hp]hq]hr]ht]uhhj"hb]r)h)r*}r+(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}r,(ho]hp]hq]hr]ht]uhhj&hb]r-(j)r.}r/(hgUhm}r0(Ureftypej#j"U reftargetXExceptions.ServiceFailurer1U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj*hb]r2j")r3}r4(hgj1hm}r5(ho]hp]hq]hr]ht]uhhj.hb]r6hXExceptions.ServiceFailurer7r8}r9(hgUhhj3ubahkj"ubahkjubhX -- r:r;}r<(hgUhhj*ubj)r=}r>(hgX$``(errorCode=500, detailCode=2390)``hm}r?(ho]hp]hq]hr]ht]uhhj*hb]r@hX (errorCode=500, detailCode=2390)rArB}rC(hgUhhj=ubahkjubehkhubahkj;#ubj#)rD}rE(hgUhm}rF(ho]hp]hq]hr]ht]uhhj"hb]rGh)rH}rI(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2370)hm}rJ(ho]hp]hq]hr]ht]uhhjDhb]rK(j)rL}rM(hgUhm}rN(Ureftypej#j"U reftargetXExceptions.InvalidTokenrOU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjHhb]rPj")rQ}rR(hgjOhm}rS(ho]hp]hq]hr]ht]uhhjLhb]rThXExceptions.InvalidTokenrUrV}rW(hgUhhjQubahkj"ubahkjubhX -- rXrY}rZ(hgUhhjHubj)r[}r\(hgX$``(errorCode=401, detailCode=2370)``hm}r](ho]hp]hq]hr]ht]uhhjHhb]r^hX (errorCode=401, detailCode=2370)r_r`}ra(hgUhhj[ubahkjubehkhubahkj;#ubj#)rb}rc(hgUhm}rd(ho]hp]hq]hr]ht]uhhj"hb]reh)rf}rg(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to map these two identitieshm}rh(ho]hp]hq]hr]ht]uhhjbhb]ri(j)rj}rk(hgUhm}rl(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrmU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjfhb]rnj")ro}rp(hgjmhm}rq(ho]hp]hq]hr]ht]uhhjjhb]rrhXExceptions.NotAuthorizedrsrt}ru(hgUhhjoubahkj"ubahkjubhX -- rvrw}rx(hgUhhjfubh)ry}rz(hgX$``(errorCode=401, detailCode=2360)``r{hhjfhijhkhhm}r|(ho]hp]hq]hr]ht]uhvMhb]r}j)r~}r(hgj{hm}r(ho]hp]hq]hr]ht]uhhjyhb]rhX (errorCode=401, detailCode=2360)rr}r(hgUhhj~ubahkjubaubh)r}r(hgXKThe supplied principal does not have permission to map these two identitiesrhhjfhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXKThe supplied principal does not have permission to map these two identitiesrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj"hb]rh)r}r(hgXsExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE systemhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=2340)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2340)rr}r(hgUhhjubahkjubaubh)r}r(hgX<The specified principal does not exist in the DataONE systemrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX<The specified principal does not exist in the DataONE systemrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj"hb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r¡(Ureftypej#j"U reftargetXExceptions.NotImplementedráU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rġj")rš}rơ(hgjáhm}rǡ(ho]hp]hq]hr]ht]uhhjhb]rȡhXExceptions.NotImplementedrɡrʡ}rˡ(hgUhhjšubahkj"ubahkjubhX -- r̡r͡}rΡ(hgUhhjubj)rϡ}rС(hgX$``(errorCode=501, detailCode=2361)``hm}rѡ(ho]hp]hq]hr]ht]uhhjhb]rҡhX (errorCode=501, detailCode=2361)rӡrԡ}rա(hgUhhjϡubahkjubehkhubahkj;#ubj#)r֡}rס(hgUhm}rء(ho]hp]hq]hr]ht]uhhj"hb]r١h)rڡ}rۡ(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2342)hm}rܡ(ho]hp]hq]hr]ht]uhhj֡hb]rݡ(j)rޡ}rߡ(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjڡhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjޡhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjڡubj)r}r(hgX$``(errorCode=400, detailCode=2342)``hm}r(ho]hp]hq]hr]ht]uhhjڡhb]rhX (errorCode=400, detailCode=2342)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj"hb]rh)r}r(hgXExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=2343)The subject of the session and the provided subject are the samehm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.IdentifierNotUniquerr}r(hgUhhjubahkj"ubahkjubhX -- rr }r (hgUhhjubh)r }r (hgX$``(errorCode=409, detailCode=2343)``r hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgj hm}r(ho]hp]hq]hr]ht]uhhj hb]rhX (errorCode=409, detailCode=2343)rr}r(hgUhhjubahkjubaubh)r}r(hgX@The subject of the session and the provided subject are the samerhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX@The subject of the session and the provided subject are the samerr}r(hgjhhjubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r (hgUhhjhiNhkjhm}r!(hr]hq]ho]hp]ht]Uentries]r"(jX+confirmMapIdentity() (in module CNIdentity)hUNtr#auhvNhwhhb]ubj!)r$}r%(hgUhhjhiNhkj!hm}r&(j"j"Xpyr'hr]hq]ho]hp]ht]j"Xfunctionr(j"j(uhvNhwhhb]r)(j")r*}r+(hgX.confirmMapIdentity(session,subject) -> booleanhhj$hijhkj "hm}r,(hr]r-haj"j͈hq]ho]hp]ht]r.haj"XconfirmMapIdentityr/j"Uj"uhvMhwhhb]r0(j")r1}r2(hgX CNIdentity.hhj*hijhkj"hm}r3(ho]hp]hq]hr]ht]uhvMhwhhb]r4hX CNIdentity.r5r6}r7(hgUhhj1ubaubj")r8}r9(hgj/hhj*hijhkj!"hm}r:(ho]hp]hq]hr]ht]uhvMhwhhb]r;hXconfirmMapIdentityr<r=}r>(hgUhhj8ubaubj'")r?}r@(hgXsession, subjecthhj*hijhkj*"hm}rA(ho]hp]hq]hr]ht]uhvMhwhhb]rB(j-")rC}rD(hgXsessionhm}rE(ho]hp]hq]hr]ht]uhhj?hb]rFhXsessionrGrH}rI(hgUhhjCubahkj5"ubj-")rJ}rK(hgXsubjecthm}rL(ho]hp]hq]hr]ht]uhhj?hb]rMhXsubjectrNrO}rP(hgUhhjJubahkj5"ubeubj6")rQ}rR(hgXbooleanhhj*hijhkj9"hm}rS(ho]hp]hq]hr]ht]uhvMhwhhb]rThXbooleanrUrV}rW(hgUhhjQubaubeubj?")rX}rY(hgUhhj$hijhkjB"hm}rZ(ho]hp]hq]hr]ht]uhvMhwhhb]r[(h)r\}r](hgXConfirms a previously initiated identity mapping. If subject A asserts that B is the same identity through :func:`CNIdentity.requestMapIdentity`, then this method is called by B to confirm that assertion.hhjXhijhkhhm}r^(ho]hp]hq]hr]ht]uhvMhwhhb]r_(hXkConfirms a previously initiated identity mapping. If subject A asserts that B is the same identity through r`ra}rb(hgXkConfirms a previously initiated identity mapping. If subject A asserts that B is the same identity through hhj\ubj)rc}rd(hgX%:func:`CNIdentity.requestMapIdentity`rehhj\hijhkjhm}rf(UreftypeXfuncjjXCNIdentity.requestMapIdentityU refdomainXpyrghr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rhj)ri}rj(hgjehm}rk(ho]hp]rl(jjgXpy-funcrmehq]hr]ht]uhhjchb]rnhXCNIdentity.requestMapIdentity()rorp}rq(hgUhhjiubahkjubaubhX<, then this method is called by B to confirm that assertion.rrrs}rt(hgX<, then this method is called by B to confirm that assertion.hhj\ubeubh)ru}rv(hgXDA successful request is indicated by returning a HTTP status of 200.rwhhjXhijhkhhm}rx(ho]hp]hq]hr]ht]uhvMhwhhb]ryhXDA successful request is indicated by returning a HTTP status of 200.rzr{}r|(hgjwhhjuubaubh)r}}r~(hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rhhjXhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rr}r(hgjhhj}ubaubh)r}r(hgUhhjXhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX&``PUT /accounts/pendingmap/{subject}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX"PUT /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r¢hX ParametersrârĢ}rŢ(hgUhhjubaubh)rƢ}rǢ(hgUhm}rȢ(ho]hp]hq]hr]ht]uhhjhb]rɢj #)rʢ}rˢ(hgUhm}r̢(ho]hp]hq]hr]ht]uhhjƢhb]r͢(j#)r΢}rϢ(hgUhm}rТ(ho]hp]hq]hr]ht]uhhjʢhb]rѢh)rҢ}rӢ(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}rԢ(ho]hp]hq]hr]ht]uhhj΢hb]rբ(j")r֢}rע(hgXsessionhm}rآ(hr]hq]j"ho]hp]ht]uhhjҢhb]r٢hXsessionrڢrۢ}rܢ(hgUhhj֢ubahkj"ubhX (rݢrޢ}rߢ(hgUhhjҢubj)r}r(hgX:class:`Types.Session`rhhjҢhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjҢubhX -- rr}r(hgUhhjҢubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhjҢubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjʢhb]rh)r}r(hgXsubject (Types.Subject) -- The Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r }r (hgX:class:`Types.Subject`r hhjhijhkjhm}r (UreftypeXclassjjX Types.SubjectU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rj)r}r(hgj hm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhj hb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#(h)r$}r%(hgXReturnshhj hijhkhhm}r&(ho]hp]hq]hr]ht]uhvKhb]r'hXReturnsr(r)}r*(hgUhhj$ubaubh)r+}r,(hgUhm}r-(ho]hp]hq]hr]ht]uhhj hb]r.h)r/}r0(hgX:True if the map was successfully created, false otherwise.hm}r1(ho]hp]hq]hr]ht]uhhj+hb]r2hX:True if the map was successfully created, false otherwise.r3r4}r5(hgX:True if the map was successfully created, false otherwise.hhj/ubahkhubahkhubehkhubh)r6}r7(hgUhm}r8(ho]hp]hq]hr]ht]uhhjhb]r9(h)r:}r;(hgX Return typehhj6hijhkhhm}r<(ho]hp]hq]hr]ht]uhvKhb]r=hX Return typer>r?}r@(hgUhhj:ubaubh)rA}rB(hgUhm}rC(ho]hp]hq]hr]ht]uhhj6hb]rDh)rE}rF(hgXbooleanhm}rG(ho]hp]hq]hr]ht]uhhjAhb]rHj)rI}rJ(hgUhm}rK(Ureftypej&j"U reftargetXbooleanU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjEhb]rLhXbooleanrMrN}rO(hgUhhjIubahkjubahkhubahkhubehkhubh)rP}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhjhb]rS(h)rT}rU(hgXRaiseshhjPhijhkhhm}rV(ho]hp]hq]hr]ht]uhvKhb]rWhXRaisesrXrY}rZ(hgUhhjTubaubh)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjPhb]r^j #)r_}r`(hgUhm}ra(ho]hp]hq]hr]ht]uhhj[hb]rb(j#)rc}rd(hgUhm}re(ho]hp]hq]hr]ht]uhhj_hb]rfh)rg}rh(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}ri(ho]hp]hq]hr]ht]uhhjchb]rj(j)rk}rl(hgUhm}rm(Ureftypej#j"U reftargetXExceptions.ServiceFailurernU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjghb]roj")rp}rq(hgjnhm}rr(ho]hp]hq]hr]ht]uhhjkhb]rshXExceptions.ServiceFailurertru}rv(hgUhhjpubahkj"ubahkjubhX -- rwrx}ry(hgUhhjgubj)rz}r{(hgX$``(errorCode=500, detailCode=2390)``hm}r|(ho]hp]hq]hr]ht]uhhjghb]r}hX (errorCode=500, detailCode=2390)r~r}r(hgUhhjzubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj_hb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2370)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=2370)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2370)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj_hb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to map these two identitieshm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=2360)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2360)rr}r(hgUhhjubahkjubaubh)r£}rã(hgXKThe supplied principal does not have permission to map these two identitiesrģhhjhijhkhhm}rţ(ho]hp]hq]hr]ht]uhvMhb]rƣhXKThe supplied principal does not have permission to map these two identitiesrǣrȣ}rɣ(hgjģhhj£ubaubehkhubahkj;#ubj#)rʣ}rˣ(hgUhm}ṛ(ho]hp]hq]hr]ht]uhhj_hb]rͣh)rΣ}rϣ(hgXExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.hm}rУ(ho]hp]hq]hr]ht]uhhjʣhb]rѣ(j)rң}rӣ(hgUhm}rԣ(Ureftypej#j"U reftargetXExceptions.NotFoundrգU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjΣhb]r֣j")rף}rأ(hgjգhm}r٣(ho]hp]hq]hr]ht]uhhjңhb]rڣhXExceptions.NotFoundrۣrܣ}rݣ(hgUhhjףubahkj"ubahkjubhX -- rޣrߣ}r(hgUhhjΣubh)r}r(hgX$``(errorCode=404, detailCode=2340)``rhhjΣhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2340)rr}r(hgUhhjubahkjubaubh)r}r(hgX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rhhjΣhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj_hb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainj'hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- r r }r (hgUhhjubj)r }r (hgX$``(errorCode=501, detailCode=2361)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=2361)rr}r(hgUhhj ubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX.getPendingMapIdentity() (in module CNIdentity)h)UNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX5getPendingMapIdentity(session,subject) -> SubjectInfohhjhijhkj "hm}r (hr]r!h)aj"j͈hq]ho]hp]ht]r"h)aj"XgetPendingMapIdentityr#j"Uj"uhvMhwhhb]r$(j")r%}r&(hgX CNIdentity.hhjhijhkj"hm}r'(ho]hp]hq]hr]ht]uhvMhwhhb]r(hX CNIdentity.r)r*}r+(hgUhhj%ubaubj")r,}r-(hgj#hhjhijhkj!"hm}r.(ho]hp]hq]hr]ht]uhvMhwhhb]r/hXgetPendingMapIdentityr0r1}r2(hgUhhj,ubaubj'")r3}r4(hgXsession, subjecthhjhijhkj*"hm}r5(ho]hp]hq]hr]ht]uhvMhwhhb]r6(j-")r7}r8(hgXsessionhm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:hXsessionr;r<}r=(hgUhhj7ubahkj5"ubj-")r>}r?(hgXsubjecthm}r@(ho]hp]hq]hr]ht]uhhj3hb]rAhXsubjectrBrC}rD(hgUhhj>ubahkj5"ubeubj6")rE}rF(hgX SubjectInfohhjhijhkj9"hm}rG(ho]hp]hq]hr]ht]uhvMhwhhb]rHhX SubjectInforIrJ}rK(hgUhhjEubaubeubj?")rL}rM(hgUhhjhijhkjB"hm}rN(ho]hp]hq]hr]ht]uhvMhwhhb]rO(h)rP}rQ(hgX@Gets the SubjectInfo of a previously initiated identity mapping.rRhhjLhijhkhhm}rS(ho]hp]hq]hr]ht]uhvMhwhhb]rThX@Gets the SubjectInfo of a previously initiated identity mapping.rUrV}rW(hgjRhhjPubaubh)rX}rY(hgXDA successful request is indicated by returning a HTTP status of 200.rZhhjLhijhkhhm}r[(ho]hp]hq]hr]ht]uhvMhwhhb]r\hXDA successful request is indicated by returning a HTTP status of 200.r]r^}r_(hgjZhhjXubaubh)r`}ra(hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rbhhjLhijhkhhm}rc(ho]hp]hq]hr]ht]uhvMhwhhb]rdhXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rerf}rg(hgjbhhj`ubaubh)rh}ri(hgUhhjLhiNhkhhm}rj(ho]hp]hq]hr]ht]uhvNhwhhb]rk(h)rl}rm(hgUhhjhhijhkhhm}rn(ho]hp]hq]hr]ht]uhvMhwhhb]ro(h)rp}rq(hgXVersionhhjlhijhkhhm}rr(ho]hp]hq]hr]ht]uhvKhb]rshXVersionrtru}rv(hgUhhjpubaubh)rw}rx(hgX 1.0, (2.0)ryhm}rz(ho]hp]hq]hr]ht]uhhjlhb]r{h)r|}r}(hgjyhhjwhijhkhhm}r~(ho]hp]hq]hr]ht]uhvMhb]rhX 1.0, (2.0)rr}r(hgjyhhj|ubaubahkhubeubh)r}r(hgUhhjhhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX&``GET /accounts/pendingmap/{subject}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX"GET /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r¤(hgUhhjubj)rä}rĤ(hgX:class:`Types.Session`rŤhhjhijhkjhm}rƤ(UreftypeXclassjjX Types.SessionU refdomainXpyrǤhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rȤj)rɤ}rʤ(hgjŤhm}rˤ(ho]hp]r̤(jjǤXpy-classrͤehq]hr]ht]uhhjähb]rΤhX Types.SessionrϤrФ}rѤ(hgUhhjɤubahkjubaubhX)rҤ}rӤ(hgUhhjubhX -- rԤrդ}r֤(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.rפrؤ}r٤(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)rڤ}rۤ(hgUhm}rܤ(ho]hp]hq]hr]ht]uhhjhb]rݤh)rޤ}rߤ(hgXsubject (Types.Subject) -- The Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjڤhb]r(j")r}r(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjޤhb]rhXsubjectrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjޤubj)r}r(hgX:class:`Types.Subject`rhhjޤhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjޤubhX -- rr}r(hgUhhjޤubhXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hhjޤubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]r(h)r}r(hgXReturnshhjhijhkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hXReturnsr r }r (hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXThe SubjectInfohm}r(ho]hp]hq]hr]ht]uhhjhb]rhXThe SubjectInforr}r(hgXThe SubjectInfohhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhhb]r(h)r}r(hgX Return typehhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r hX Return typer!r"}r#(hgUhhjubaubh)r$}r%(hgUhm}r&(ho]hp]hq]hr]ht]uhhjhb]r'h)r(}r)(hgXTypes.SubjectInfohm}r*(ho]hp]hq]hr]ht]uhhj$hb]r+j)r,}r-(hgX:class:`Types.SubjectInfo`r.hhj(hijhkjhm}r/(UreftypeXclassjjXTypes.SubjectInfoU refdomainXpyr0hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]r1j)r2}r3(hgj.hm}r4(ho]hp]r5(jj0Xpy-classr6ehq]hr]ht]uhhj,hb]r7hXTypes.SubjectInfor8r9}r:(hgUhhj2ubahkjubaubahkhubahkhubehkhubh)r;}r<(hgUhm}r=(ho]hp]hq]hr]ht]uhhjhhb]r>(h)r?}r@(hgXRaiseshhj;hijhkhhm}rA(ho]hp]hq]hr]ht]uhvKhb]rBhXRaisesrCrD}rE(hgUhhj?ubaubh)rF}rG(hgUhm}rH(ho]hp]hq]hr]ht]uhhj;hb]rIj #)rJ}rK(hgUhm}rL(ho]hp]hq]hr]ht]uhhjFhb]rM(j#)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhjJhb]rQh)rR}rS(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}rT(ho]hp]hq]hr]ht]uhhjNhb]rU(j)rV}rW(hgUhm}rX(Ureftypej#j"U reftargetXExceptions.ServiceFailurerYU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjRhb]rZj")r[}r\(hgjYhm}r](ho]hp]hq]hr]ht]uhhjVhb]r^hXExceptions.ServiceFailurer_r`}ra(hgUhhj[ubahkj"ubahkjubhX -- rbrc}rd(hgUhhjRubj)re}rf(hgX$``(errorCode=500, detailCode=2390)``hm}rg(ho]hp]hq]hr]ht]uhhjRhb]rhhX (errorCode=500, detailCode=2390)rirj}rk(hgUhhjeubahkjubehkhubahkj;#ubj#)rl}rm(hgUhm}rn(ho]hp]hq]hr]ht]uhhjJhb]roh)rp}rq(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to get the SubjectInfohm}rr(ho]hp]hq]hr]ht]uhhjlhb]rs(j)rt}ru(hgUhm}rv(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrwU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjphb]rxj")ry}rz(hgjwhm}r{(ho]hp]hq]hr]ht]uhhjthb]r|hXExceptions.NotAuthorizedr}r~}r(hgUhhjyubahkj"ubahkjubhX -- rr}r(hgUhhjpubh)r}r(hgX$``(errorCode=401, detailCode=2360)``rhhjphijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2360)rr}r(hgUhhjubahkjubaubh)r}r(hgXFThe supplied principal does not have permission to get the SubjectInforhhjphijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXFThe supplied principal does not have permission to get the SubjectInforr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjJhb]rh)r}r(hgXExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=2340)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2340)rr}r(hgUhhjubahkjubaubh)r}r(hgX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r¥}rå(hgUhm}rĥ(ho]hp]hq]hr]ht]uhhjJhb]rťh)rƥ}rǥ(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}rȥ(ho]hp]hq]hr]ht]uhhj¥hb]rɥ(j)rʥ}r˥(hgUhm}r̥(Ureftypej#j"U reftargetXExceptions.NotImplementedrͥU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjƥhb]rΥj")rϥ}rХ(hgjͥhm}rѥ(ho]hp]hq]hr]ht]uhhjʥhb]rҥhXExceptions.NotImplementedrӥrԥ}rե(hgUhhjϥubahkj"ubahkjubhX -- r֥rץ}rإ(hgUhhjƥubj)r٥}rڥ(hgX$``(errorCode=501, detailCode=2361)``hm}rۥ(ho]hp]hq]hr]ht]uhhjƥhb]rܥhX (errorCode=501, detailCode=2361)rݥrޥ}rߥ(hgUhhj٥ubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjJhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4961)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4961)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4961)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX(denyMapIdentity() (in module CNIdentity)hUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r }r (hgX+denyMapIdentity(session,subject) -> booleanhhjhijhkj "hm}r (hr]r haj"j͈hq]ho]hp]ht]r haj"XdenyMapIdentityrj"Uj"uhvMhwhhb]r(j")r}r(hgX CNIdentity.hhj hijhkj"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhX CNIdentity.rr}r(hgUhhjubaubj")r}r(hgjhhj hijhkj!"hm}r(ho]hp]hq]hr]ht]uhvMhwhhb]rhXdenyMapIdentityrr}r(hgUhhjubaubj'")r}r(hgXsession, subjecthhj hijhkj*"hm}r (ho]hp]hq]hr]ht]uhvMhwhhb]r!(j-")r"}r#(hgXsessionhm}r$(ho]hp]hq]hr]ht]uhhjhb]r%hXsessionr&r'}r((hgUhhj"ubahkj5"ubj-")r)}r*(hgXsubjecthm}r+(ho]hp]hq]hr]ht]uhhjhb]r,hXsubjectr-r.}r/(hgUhhj)ubahkj5"ubeubj6")r0}r1(hgXbooleanhhj hijhkj9"hm}r2(ho]hp]hq]hr]ht]uhvMhwhhb]r3hXbooleanr4r5}r6(hgUhhj0ubaubeubj?")r7}r8(hgUhhjhijhkjB"hm}r9(ho]hp]hq]hr]ht]uhvMhwhhb]r:(h)r;}r<(hgXDenies a previously initiated identity mapping. If subject A asserts that B is the same identity through :func:`CNIdentity.requestMapIdentity`, then this method is called by B to deny that assertion.hhj7hijhkhhm}r=(ho]hp]hq]hr]ht]uhvMhwhhb]r>(hXiDenies a previously initiated identity mapping. If subject A asserts that B is the same identity through r?r@}rA(hgXiDenies a previously initiated identity mapping. If subject A asserts that B is the same identity through hhj;ubj)rB}rC(hgX%:func:`CNIdentity.requestMapIdentity`rDhhj;hijhkjhm}rE(UreftypeXfuncjjXCNIdentity.requestMapIdentityU refdomainXpyrFhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rGj)rH}rI(hgjDhm}rJ(ho]hp]rK(jjFXpy-funcrLehq]hr]ht]uhhjBhb]rMhXCNIdentity.requestMapIdentity()rNrO}rP(hgUhhjHubahkjubaubhX9, then this method is called by B to deny that assertion.rQrR}rS(hgX9, then this method is called by B to deny that assertion.hhj;ubeubh)rT}rU(hgXDA successful request is indicated by returning a HTTP status of 200.rVhhj7hijhkhhm}rW(ho]hp]hq]hr]ht]uhvMhwhhb]rXhXDA successful request is indicated by returning a HTTP status of 200.rYrZ}r[(hgjVhhjTubaubh)r\}r](hgXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.r^hhj7hijhkhhm}r_(ho]hp]hq]hr]ht]uhvMhwhhb]r`hXzA failed request MUST be indicated by returning an appropriate exception and setting the response HTTP status accordingly.rarb}rc(hgj^hhj\ubaubh)rd}re(hgUhhj7hiNhkhhm}rf(ho]hp]hq]hr]ht]uhvNhwhhb]rg(h)rh}ri(hgUhhjdhijhkhhm}rj(ho]hp]hq]hr]ht]uhvMhwhhb]rk(h)rl}rm(hgXVersionhhjhhijhkhhm}rn(ho]hp]hq]hr]ht]uhvKhb]rohXVersionrprq}rr(hgUhhjlubaubh)rs}rt(hgX 1.0, (2.0)ruhm}rv(ho]hp]hq]hr]ht]uhhjhhb]rwh)rx}ry(hgjuhhjshijhkhhm}rz(ho]hp]hq]hr]ht]uhvMhb]r{hX 1.0, (2.0)r|r}}r~(hgjuhhjxubaubahkhubeubh)r}r(hgUhhjdhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX)``DELETE /accounts/pendingmap/{subject}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX%DELETE /accounts/pendingmap/{subject}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjdhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r¦(UreftypeXclassjjX Types.SessionU refdomainXpyræhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rĦj)rŦ}rƦ(hgjhm}rǦ(ho]hp]rȦ(jjæXpy-classrɦehq]hr]ht]uhhjhb]rʦhX Types.Sessionr˦r̦}rͦ(hgUhhjŦubahkjubaubhX)rΦ}rϦ(hgUhhjubhX -- rЦrѦ}rҦ(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.rӦrԦ}rզ(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r֦}rצ(hgUhm}rئ(ho]hp]hq]hr]ht]uhhjhb]r٦h)rڦ}rۦ(hgXsubject (Types.Subject) -- The Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hm}rܦ(ho]hp]hq]hr]ht]uhhj֦hb]rݦ(j")rަ}rߦ(hgXsubjecthm}r(hr]hq]j"ho]hp]ht]uhhjڦhb]rhXsubjectrr}r(hgUhhjަubahkj"ubhX (rr}r(hgUhhjڦubj)r}r(hgX:class:`Types.Subject`rhhjڦhijhkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Subjectrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjڦubhX -- rr}r(hgUhhjڦubhXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXThe Subject identifier to be used for equivalentIdentity. This Subject will not match the Subject named in the certificate. Transmitted as part of the URL path and must be escaped accordingly.hhjڦubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjdhb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r (hgUhhjubaubh)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r}r(hgX:True if the map was successfully created, false otherwise.hm}r(ho]hp]hq]hr]ht]uhhj hb]rhX:True if the map was successfully created, false otherwise.rr}r(hgX:True if the map was successfully created, false otherwise.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjdhb]r(h)r}r(hgX Return typehhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#h)r$}r%(hgXbooleanhm}r&(ho]hp]hq]hr]ht]uhhj hb]r'j)r(}r)(hgUhm}r*(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhj$hb]r+hXbooleanr,r-}r.(hgUhhj(ubahkjubahkhubahkhubehkhubh)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhjdhb]r2(h)r3}r4(hgXRaiseshhj/hijhkhhm}r5(ho]hp]hq]hr]ht]uhvKhb]r6hXRaisesr7r8}r9(hgUhhj3ubaubh)r:}r;(hgUhm}r<(ho]hp]hq]hr]ht]uhhj/hb]r=j #)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhj:hb]rA(j#)rB}rC(hgUhm}rD(ho]hp]hq]hr]ht]uhhj>hb]rEh)rF}rG(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2390)hm}rH(ho]hp]hq]hr]ht]uhhjBhb]rI(j)rJ}rK(hgUhm}rL(Ureftypej#j"U reftargetXExceptions.ServiceFailurerMU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjFhb]rNj")rO}rP(hgjMhm}rQ(ho]hp]hq]hr]ht]uhhjJhb]rRhXExceptions.ServiceFailurerSrT}rU(hgUhhjOubahkj"ubahkjubhX -- rVrW}rX(hgUhhjFubj)rY}rZ(hgX$``(errorCode=500, detailCode=2390)``hm}r[(ho]hp]hq]hr]ht]uhhjFhb]r\hX (errorCode=500, detailCode=2390)r]r^}r_(hgUhhjYubahkjubehkhubahkj;#ubj#)r`}ra(hgUhm}rb(ho]hp]hq]hr]ht]uhhj>hb]rch)rd}re(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2370)hm}rf(ho]hp]hq]hr]ht]uhhj`hb]rg(j)rh}ri(hgUhm}rj(Ureftypej#j"U reftargetXExceptions.InvalidTokenrkU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjdhb]rlj")rm}rn(hgjkhm}ro(ho]hp]hq]hr]ht]uhhjhhb]rphXExceptions.InvalidTokenrqrr}rs(hgUhhjmubahkj"ubahkjubhX -- rtru}rv(hgUhhjdubj)rw}rx(hgX$``(errorCode=401, detailCode=2370)``hm}ry(ho]hp]hq]hr]ht]uhhjdhb]rzhX (errorCode=401, detailCode=2370)r{r|}r}(hgUhhjwubahkjubehkhubahkj;#ubj#)r~}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj>hb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=2360)The supplied principal does not have permission to map these two identitieshm}r(ho]hp]hq]hr]ht]uhhj~hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=2360)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2360)rr}r(hgUhhjubahkjubaubh)r}r(hgXKThe supplied principal does not have permission to map these two identitiesrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXKThe supplied principal does not have permission to map these two identitiesrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj>hb]rh)r}r(hgXExceptions.NotFound -- (errorCode=404, detailCode=2340)The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=2340)``r§hhjhijhkhhm}rç(ho]hp]hq]hr]ht]uhvMhb]rħj)rŧ}rƧ(hgj§hm}rǧ(ho]hp]hq]hr]ht]uhhjhb]rȧhX (errorCode=404, detailCode=2340)rɧrʧ}r˧(hgUhhjŧubahkjubaubh)ŗ}rͧ(hgX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rΧhhjhijhkhhm}rϧ(ho]hp]hq]hr]ht]uhvMhb]rЧhX|The specified principal does not exist in the DataONE system, or the mapping between the subjects has no yet been initiated.rѧrҧ}rӧ(hgjΧhhj̧ubaubehkhubahkj;#ubj#)rԧ}rէ(hgUhm}r֧(ho]hp]hq]hr]ht]uhhj>hb]rקh)rا}r٧(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2361)hm}rڧ(ho]hp]hq]hr]ht]uhhjԧhb]rۧ(j)rܧ}rݧ(hgUhm}rާ(Ureftypej#j"U reftargetXExceptions.NotImplementedrߧU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjاhb]rj")r}r(hgjߧhm}r(ho]hp]hq]hr]ht]uhhjܧhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjاubj)r}r(hgX$``(errorCode=501, detailCode=2361)``hm}r(ho]hp]hq]hr]ht]uhhjاhb]rhX (errorCode=501, detailCode=2361)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX$createGroup() (in module CNIdentity)h UNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX%createGroup(session,group) -> Subjecthhjhijhkj "hm}r(hr]rh aj"j͈hq]ho]hp]ht]rh aj"X createGrouprj"Uj"uhvM#hwhhb]r(j")r}r(hgX CNIdentity.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvM#hwhhb]rhX CNIdentity.rr }r (hgUhhjubaubj")r }r (hgjhhjhijhkj!"hm}r (ho]hp]hq]hr]ht]uhvM#hwhhb]rhX createGrouprr}r(hgUhhj ubaubj'")r}r(hgXsession, grouphhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvM#hwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXgrouphm}r(ho]hp]hq]hr]ht]uhhjhb]r hXgroupr!r"}r#(hgUhhjubahkj5"ubeubj6")r$}r%(hgXSubjecthhjhijhkj9"hm}r&(ho]hp]hq]hr]ht]uhvM#hwhhb]r'hXSubjectr(r)}r*(hgUhhj$ubaubeubj?")r+}r,(hgUhhjhijhkjB"hm}r-(ho]hp]hq]hr]ht]uhvM#hwhhb]r.(h)r/}r0(hgX#Create a group with the given name.r1hhj+hijhkhhm}r2(ho]hp]hq]hr]ht]uhvMhwhhb]r3hX#Create a group with the given name.r4r5}r6(hgj1hhj/ubaubh)r7}r8(hgXGroups are lists of subjects that allow all members of the group to be referenced by listing solely the subject name of the group. Group names must be unique within the DataONE system. Groups can only be modified by Subjects listed as rightsHolders.r9hhj+hijhkhhm}r:(ho]hp]hq]hr]ht]uhvMhwhhb]r;hXGroups are lists of subjects that allow all members of the group to be referenced by listing solely the subject name of the group. Group names must be unique within the DataONE system. Groups can only be modified by Subjects listed as rightsHolders.r<r=}r>(hgj9hhj7ubaubh)r?}r@(hgUhhj+hiNhkhhm}rA(ho]hp]hq]hr]ht]uhvNhwhhb]rB(h)rC}rD(hgUhhj?hijhkhhm}rE(ho]hp]hq]hr]ht]uhvMhwhhb]rF(h)rG}rH(hgXVersionhhjChijhkhhm}rI(ho]hp]hq]hr]ht]uhvKhb]rJhXVersionrKrL}rM(hgUhhjGubaubh)rN}rO(hgX 1.0, (2.0)rPhm}rQ(ho]hp]hq]hr]ht]uhhjChb]rRh)rS}rT(hgjPhhjNhijhkhhm}rU(ho]hp]hq]hr]ht]uhvMhb]rVhX 1.0, (2.0)rWrX}rY(hgjPhhjSubaubahkhubeubh)rZ}r[(hgUhhj?hijhkhhm}r\(ho]hp]hq]hr]ht]uhvM hwhhb]r](h)r^}r_(hgXREST URLhhjZhijhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]rahXREST URLrbrc}rd(hgUhhj^ubaubh)re}rf(hgX``POST /groups``rghm}rh(ho]hp]hq]hr]ht]uhhjZhb]rih)rj}rk(hgjghhjehijhkhhm}rl(ho]hp]hq]hr]ht]uhvM hb]rmj)rn}ro(hgjghm}rp(ho]hp]hq]hr]ht]uhhjjhb]rqhX POST /groupsrrrs}rt(hgUhhjnubahkjubaubahkhubeubh)ru}rv(hgUhm}rw(ho]hp]hq]hr]ht]uhhj?hb]rx(h)ry}rz(hgX Parametershhjuhijhkhhm}r{(ho]hp]hq]hr]ht]uhvKhb]r|hX Parametersr}r~}r(hgUhhjyubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjuhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvM hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r¨(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)rè}rĨ(hgUhm}rŨ(ho]hp]hq]hr]ht]uhhjhb]rƨh)rǨ}rȨ(hgXgroup (Types.Group) -- The Group to be created. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}rɨ(ho]hp]hq]hr]ht]uhhjèhb]rʨ(j")r˨}r̨(hgXgrouphm}rͨ(hr]hq]j"ho]hp]ht]uhhjǨhb]rΨhXgrouprϨrШ}rѨ(hgUhhj˨ubahkj"ubhX (rҨrӨ}rԨ(hgUhhjǨubj)rը}r֨(hgX:class:`Types.Group`rרhhjǨhijhkjhm}rب(UreftypeXclassjjX Types.GroupU refdomainXpyr٨hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]rڨj)rۨ}rܨ(hgjרhm}rݨ(ho]hp]rި(jj٨Xpy-classrߨehq]hr]ht]uhhjըhb]rhX Types.Grouprr}r(hgUhhjۨubahkjubaubhX)r}r(hgUhhjǨubhX -- rr}r(hgUhhjǨubhXThe Group to be created. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXThe Group to be created. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjǨubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhjǨhb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjǨubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj?hb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX*The Subject of the group that was created.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX*The Subject of the group that was created.r r }r (hgX*The Subject of the group that was created.hhjubahkhubahkhubehkhubh)r }r (hgUhm}r(ho]hp]hq]hr]ht]uhhj?hb]r(h)r}r(hgX Return typehhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgX Types.Subjecthm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r (hgX:class:`Types.Subject`r!hhjhijhkjhm}r"(UreftypeXclassjjX Types.SubjectU refdomainXpyr#hr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvMhb]r$j)r%}r&(hgj!hm}r'(ho]hp]r((jj#Xpy-classr)ehq]hr]ht]uhhjhb]r*hX Types.Subjectr+r,}r-(hgUhhj%ubahkjubaubahkhubahkhubehkhubh)r.}r/(hgUhm}r0(ho]hp]hq]hr]ht]uhhj?hb]r1(h)r2}r3(hgXRaiseshhj.hijhkhhm}r4(ho]hp]hq]hr]ht]uhvKhb]r5hXRaisesr6r7}r8(hgUhhj2ubaubh)r9}r:(hgUhm}r;(ho]hp]hq]hr]ht]uhhj.hb]r<j #)r=}r>(hgUhm}r?(ho]hp]hq]hr]ht]uhhj9hb]r@(j#)rA}rB(hgUhm}rC(ho]hp]hq]hr]ht]uhhj=hb]rDh)rE}rF(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2490)hm}rG(ho]hp]hq]hr]ht]uhhjAhb]rH(j)rI}rJ(hgUhm}rK(Ureftypej#j"U reftargetXExceptions.ServiceFailurerLU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjEhb]rMj")rN}rO(hgjLhm}rP(ho]hp]hq]hr]ht]uhhjIhb]rQhXExceptions.ServiceFailurerRrS}rT(hgUhhjNubahkj"ubahkjubhX -- rUrV}rW(hgUhhjEubj)rX}rY(hgX$``(errorCode=500, detailCode=2490)``hm}rZ(ho]hp]hq]hr]ht]uhhjEhb]r[hX (errorCode=500, detailCode=2490)r\r]}r^(hgUhhjXubahkjubehkhubahkj;#ubj#)r_}r`(hgUhm}ra(ho]hp]hq]hr]ht]uhhj=hb]rbh)rc}rd(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2470)hm}re(ho]hp]hq]hr]ht]uhhj_hb]rf(j)rg}rh(hgUhm}ri(Ureftypej#j"U reftargetXExceptions.InvalidTokenrjU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjchb]rkj")rl}rm(hgjjhm}rn(ho]hp]hq]hr]ht]uhhjghb]rohXExceptions.InvalidTokenrprq}rr(hgUhhjlubahkj"ubahkjubhX -- rsrt}ru(hgUhhjcubj)rv}rw(hgX$``(errorCode=401, detailCode=2470)``hm}rx(ho]hp]hq]hr]ht]uhhjchb]ryhX (errorCode=401, detailCode=2470)rzr{}r|(hgUhhjvubahkjubehkhubahkj;#ubj#)r}}r~(hgUhm}r(ho]hp]hq]hr]ht]uhhj=hb]rh)r}r(hgX}Exceptions.NotAuthorized -- (errorCode=401, detailCode=2460)The supplied principal does not have permission to create a grouphm}r(ho]hp]hq]hr]ht]uhhj}hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=2460)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2460)rr}r(hgUhhjubahkjubaubh)r}r(hgXAThe supplied principal does not have permission to create a grouprhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXAThe supplied principal does not have permission to create a grouprr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj=hb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2461)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=2461)``hm}r(ho]hp]hq]hr]ht]uhhjhb]r©hX (errorCode=501, detailCode=2461)rérĩ}rũ(hgUhhjubahkjubehkhubahkj;#ubj#)rƩ}rǩ(hgUhm}rȩ(ho]hp]hq]hr]ht]uhhj=hb]rɩh)rʩ}r˩(hgXeExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=2400)A group by this name already existshm}r̩(ho]hp]hq]hr]ht]uhhjƩhb]rͩ(j)rΩ}rϩ(hgUhm}rЩ(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerѩU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjʩhb]rҩj")rө}rԩ(hgjѩhm}rթ(ho]hp]hq]hr]ht]uhhjΩhb]r֩hXExceptions.IdentifierNotUniquerשrة}r٩(hgUhhjөubahkj"ubahkjubhX -- rکr۩}rܩ(hgUhhjʩubh)rݩ}rީ(hgX$``(errorCode=409, detailCode=2400)``rߩhhjʩhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjߩhm}r(ho]hp]hq]hr]ht]uhhjݩhb]rhX (errorCode=409, detailCode=2400)rr}r(hgUhhjubahkjubaubh)r}r(hgX#A group by this name already existsrhhjʩhijhkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX#A group by this name already existsrr}r(hgjhhjubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX$updateGroup() (in module CNIdentity)hCUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX%updateGroup(session,group) -> booleanhhjhiXEinternal padding after source/apis/generated/generated_CNIdentity.txtrhkj "hm}r(hr]rhCaj"j͈hq]ho]hp]ht]rhCaj"X updateGrouprj"Uj"uhvMJhwhhb]r(j")r}r(hgX CNIdentity.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvMJhwhhb]rhX CNIdentity.rr }r (hgUhhjubaubj")r }r (hgjhhjhijhkj!"hm}r (ho]hp]hq]hr]ht]uhvMJhwhhb]rhX updateGrouprr}r(hgUhhj ubaubj'")r}r(hgXsession, grouphhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvMJhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXgrouphm}r(ho]hp]hq]hr]ht]uhhjhb]r hXgroupr!r"}r#(hgUhhjubahkj5"ubeubj6")r$}r%(hgXbooleanhhjhijhkj9"hm}r&(ho]hp]hq]hr]ht]uhvMJhwhhb]r'hXbooleanr(r)}r*(hgUhhj$ubaubeubj?")r+}r,(hgUhhjhijhkjB"hm}r-(ho]hp]hq]hr]ht]uhvMJhwhhb]r.(h)r/}r0(hgXAdd members to the named group.r1hhj+hijhkhhm}r2(ho]hp]hq]hr]ht]uhvM&hwhhb]r3hXAdd members to the named group.r4r5}r6(hgj1hhj/ubaubh)r7}r8(hgXGroup members can be modified only by the original creator of the group, otherwise a NotAuthorized exception is thrown. Group members are provided as a list of subjects that replace the group membership.r9hhj+hijhkhhm}r:(ho]hp]hq]hr]ht]uhvM(hwhhb]r;hXGroup members can be modified only by the original creator of the group, otherwise a NotAuthorized exception is thrown. Group members are provided as a list of subjects that replace the group membership.r<r=}r>(hgj9hhj7ubaubh)r?}r@(hgX[Successful completion of this operation is indicated by a HTTP response status code of 200.rAhhj+hijhkhhm}rB(ho]hp]hq]hr]ht]uhvM*hwhhb]rChX[Successful completion of this operation is indicated by a HTTP response status code of 200.rDrE}rF(hgjAhhj?ubaubh)rG}rH(hgXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.rIhhj+hijhkhhm}rJ(ho]hp]hq]hr]ht]uhvM,hwhhb]rKhXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.rLrM}rN(hgjIhhjGubaubh)rO}rP(hgUhhj+hiNhkhhm}rQ(ho]hp]hq]hr]ht]uhvNhwhhb]rR(h)rS}rT(hgUhhjOhijhkhhm}rU(ho]hp]hq]hr]ht]uhvM.hwhhb]rV(h)rW}rX(hgXVersionhhjShijhkhhm}rY(ho]hp]hq]hr]ht]uhvKhb]rZhXVersionr[r\}r](hgUhhjWubaubh)r^}r_(hgX 1.0, (2.0)r`hm}ra(ho]hp]hq]hr]ht]uhhjShb]rbh)rc}rd(hgj`hhj^hijhkhhm}re(ho]hp]hq]hr]ht]uhvM.hb]rfhX 1.0, (2.0)rgrh}ri(hgj`hhjcubaubahkhubeubh)rj}rk(hgUhhjOhijhkhhm}rl(ho]hp]hq]hr]ht]uhvM/hwhhb]rm(h)rn}ro(hgXREST URLhhjjhijhkhhm}rp(ho]hp]hq]hr]ht]uhvKhb]rqhXREST URLrrrs}rt(hgUhhjnubaubh)ru}rv(hgX``PUT /groups``rwhm}rx(ho]hp]hq]hr]ht]uhhjjhb]ryh)rz}r{(hgjwhhjuhijhkhhm}r|(ho]hp]hq]hr]ht]uhvM/hb]r}j)r~}r(hgjwhm}r(ho]hp]hq]hr]ht]uhhjzhb]rhX PUT /groupsrr}r(hgUhhj~ubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjOhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXRsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session is used to determine if the request is being made by the creator of the group. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM1hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhX7Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session is used to determine if the request is being made by the creator of the group. Transmitted as part of the SSL handshake process.rr}r(hgX7Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session is used to determine if the request is being made by the creator of the group. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}rª(hgUhm}rê(ho]hp]hq]hr]ht]uhhjhb]rĪh)rŪ}rƪ(hgXAgroup (Types.Group) -- The new Group object that will replace the old Group. The Group.Subject must match the groupName and an update cannot modify this value. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}rǪ(ho]hp]hq]hr]ht]uhhjhb]rȪ(j")rɪ}rʪ(hgXgrouphm}r˪(hr]hq]j"ho]hp]ht]uhhjŪhb]r̪hXgrouprͪrΪ}rϪ(hgUhhjɪubahkj"ubhX (rЪrѪ}rҪ(hgUhhjŪubj)rӪ}rԪ(hgX:class:`Types.Group`rժhhjŪhijhkjhm}r֪(UreftypeXclassjjX Types.GroupU refdomainXpyrתhr]hq]U refexplicitho]hp]ht]jjjNjj͈uhvM4hb]rتj)r٪}rڪ(hgjժhm}r۪(ho]hp]rܪ(jjתXpy-classrݪehq]hr]ht]uhhjӪhb]rުhX Types.Grouprߪr}r(hgUhhj٪ubahkjubaubhX)r}r(hgUhhjŪubhX -- rr}r(hgUhhjŪubhXThe new Group object that will replace the old Group. The Group.Subject must match the groupName and an update cannot modify this value. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXThe new Group object that will replace the old Group. The Group.Subject must match the groupName and an update cannot modify this value. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjŪubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhjŪhb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjŪubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjOhb]r(h)r}r(hgXReturnshhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXATrue if the group that was modified successfully, false otherwisehm}r(ho]hp]hq]hr]ht]uhhjhb]rhXATrue if the group that was modified successfully, false otherwiserr}r (hgXATrue if the group that was modified successfully, false otherwisehhjubahkhubahkhubehkhubh)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjOhb]r (h)r}r(hgX Return typehhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]r hXbooleanr!r"}r#(hgUhhjubahkjubahkhubahkhubehkhubh)r$}r%(hgUhm}r&(ho]hp]hq]hr]ht]uhhjOhb]r'(h)r(}r)(hgXRaiseshhj$hijhkhhm}r*(ho]hp]hq]hr]ht]uhvKhb]r+hXRaisesr,r-}r.(hgUhhj(ubaubh)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhj$hb]r2j #)r3}r4(hgUhm}r5(ho]hp]hq]hr]ht]uhhj/hb]r6(j#)r7}r8(hgUhm}r9(ho]hp]hq]hr]ht]uhhj3hb]r:h)r;}r<(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2590)hm}r=(ho]hp]hq]hr]ht]uhhj7hb]r>(j)r?}r@(hgUhm}rA(Ureftypej#j"U reftargetXExceptions.ServiceFailurerBU refdomainjhr]hq]U refexplicitho]hp]ht]uhhj;hb]rCj")rD}rE(hgjBhm}rF(ho]hp]hq]hr]ht]uhhj?hb]rGhXExceptions.ServiceFailurerHrI}rJ(hgUhhjDubahkj"ubahkjubhX -- rKrL}rM(hgUhhj;ubj)rN}rO(hgX$``(errorCode=500, detailCode=2590)``hm}rP(ho]hp]hq]hr]ht]uhhj;hb]rQhX (errorCode=500, detailCode=2590)rRrS}rT(hgUhhjNubahkjubehkhubahkj;#ubj#)rU}rV(hgUhm}rW(ho]hp]hq]hr]ht]uhhj3hb]rXh)rY}rZ(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2570)hm}r[(ho]hp]hq]hr]ht]uhhjUhb]r\(j)r]}r^(hgUhm}r_(Ureftypej#j"U reftargetXExceptions.InvalidTokenr`U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjYhb]raj")rb}rc(hgj`hm}rd(ho]hp]hq]hr]ht]uhhj]hb]rehXExceptions.InvalidTokenrfrg}rh(hgUhhjbubahkj"ubahkjubhX -- rirj}rk(hgUhhjYubj)rl}rm(hgX$``(errorCode=401, detailCode=2570)``hm}rn(ho]hp]hq]hr]ht]uhhjYhb]rohX (errorCode=401, detailCode=2570)rprq}rr(hgUhhjlubahkjubehkhubahkj;#ubj#)rs}rt(hgUhm}ru(ho]hp]hq]hr]ht]uhhj3hb]rvh)rw}rx(hgX}Exceptions.NotAuthorized -- (errorCode=401, detailCode=2560)The supplied principal does not have permission to add to a grouphm}ry(ho]hp]hq]hr]ht]uhhjshb]rz(j)r{}r|(hgUhm}r}(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr~U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjwhb]rj")r}r(hgj~hm}r(ho]hp]hq]hr]ht]uhhj{hb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjwubh)r}r(hgX$``(errorCode=401, detailCode=2560)``rhhjwhijhkhhm}r(ho]hp]hq]hr]ht]uhvM=hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=2560)rr}r(hgUhhjubahkjubaubh)r}r(hgXAThe supplied principal does not have permission to add to a grouprhhjwhijhkhhm}r(ho]hp]hq]hr]ht]uhvM?hb]rhXAThe supplied principal does not have permission to add to a grouprr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj3hb]rh)r}r(hgXoExceptions.NotFound -- (errorCode=404, detailCode=2540)The specified group does not exist in the DataONE systemhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=2540)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvMAhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=2540)rr}r(hgUhhjubahkjubaubh)r}r«(hgX8The specified group does not exist in the DataONE systemrëhhjhijhkhhm}rī(ho]hp]hq]hr]ht]uhvMChb]rūhX8The specified group does not exist in the DataONE systemrƫrǫ}rȫ(hgjëhhjubaubehkhubahkj;#ubj#)rɫ}rʫ(hgUhm}r˫(ho]hp]hq]hr]ht]uhhj3hb]r̫h)rͫ}rΫ(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2561)hm}rϫ(ho]hp]hq]hr]ht]uhhjɫhb]rЫ(j)rѫ}rҫ(hgUhm}rӫ(Ureftypej#j"U reftargetXExceptions.NotImplementedrԫU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjͫhb]rիj")r֫}r׫(hgjԫhm}rث(ho]hp]hq]hr]ht]uhhjѫhb]r٫hXExceptions.NotImplementedrګr۫}rܫ(hgUhhj֫ubahkj"ubahkjubhX -- rݫrޫ}r߫(hgUhhjͫubj)r}r(hgX$``(errorCode=501, detailCode=2561)``hm}r(ho]hp]hq]hr]ht]uhhjͫhb]rhX (errorCode=501, detailCode=2561)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj3hb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2542)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=400, detailCode=2542)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=2542)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubeubhd)r}r(hgUhhhehihjhkhlhm}r(ho]hp]hq]hr]r(Xmodule-CNReplicationr h_eht]r hGauhvKkhwhhb]r (hy)r }r (hgXReplication APIrhhjhihjhkh}hm}r(ho]hp]hq]hr]ht]uhvKkhwhhb]rhXReplication APIrr}r(hgjhhj ubaubj)r}r(hgUhhjhihjhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jXCNReplication (module)Xmodule-CNReplicationUNtrauhvNhwhhb]ubh)r}r(hgXThe Data Replication API operates in conjunction with the :mod:`MNReplication` API to assist with the replication of data and science metadata content between Member Nodes to ensure that copies of data and metadata can be retrieved from more than one Member Node where possible.hhjhihjhkhhm}r(ho]hp]hq]hr]ht]uhvKrhwhhb]r(hX:The Data Replication API operates in conjunction with the rr}r(hgX:The Data Replication API operates in conjunction with the hhjubj)r }r!(hgX:mod:`MNReplication`r"hhjhihjhkjhm}r#(UreftypeXmodjjX MNReplicationU refdomainXpyr$hr]hq]U refexplicitho]hp]ht]jjjNjX CNReplicationr%uhvKrhb]r&j)r'}r((hgj"hm}r)(ho]hp]r*(jj$Xpy-modr+ehq]hr]ht]uhhj hb]r,hX MNReplicationr-r.}r/(hgUhhj'ubahkjubaubhX API to assist with the replication of data and science metadata content between Member Nodes to ensure that copies of data and metadata can be retrieved from more than one Member Node where possible.r0r1}r2(hgX API to assist with the replication of data and science metadata content between Member Nodes to ensure that copies of data and metadata can be retrieved from more than one Member Node where possible.hhjubeubj)r3}r4(hgXBWarning: this file is automatically generated. Edits will be losthhjhijX1source/apis/generated/generated_CNReplication.txtr5r6}r7bhkj!hm}r8(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]r9hXBWarning: this file is automatically generated. Edits will be lostr:r;}r<(hgUhhj3ubaubj))r=}r>(hgUhhjhiNhkj,hm}r?(ho]hp]hq]hr]r@Uid8rAaht]uhvNhwhhb]rB(hy)rC}rD(hgX)Functions defined in :mod:`CNReplication`hm}rE(ho]hp]hq]hr]ht]uhhj=hb]rF(hXFunctions defined in rGrH}rI(hgXFunctions defined in hhjCubj)rJ}rK(hgX:mod:`CNReplication`rLhhjChij6hkjhm}rM(UreftypeXmodjjX CNReplicationU refdomainXpyrNhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rOj)rP}rQ(hgjLhm}rR(ho]hp]rS(jjNXpy-modrTehq]hr]ht]uhhjJhb]rUhX CNReplicationrVrW}rX(hgUhhjPubahkjubaubehkh}ubj9)rY}rZ(hgUhm}r[(hr]hq]ho]hp]ht]UcolsKuhhj=hb]r\(j>)r]}r^(hgUhm}r_(hr]hq]ho]hp]ht]UcolwidthKuhhjYhb]hkjBubj>)r`}ra(hgUhm}rb(hr]hq]ho]hp]ht]UcolwidthKuhhjYhb]hkjBubj>)rc}rd(hgUhm}re(hr]hq]ho]hp]ht]UcolwidthK uhhjYhb]hkjBubj>)rf}rg(hgUhm}rh(hr]hq]ho]hp]ht]UcolwidthK uhhjYhb]hkjBubj>)ri}rj(hgUhm}rk(hr]hq]ho]hp]ht]UcolwidthKuhhjYhb]hkjBubjO)rl}rm(hgUhm}rn(ho]hp]hq]hr]ht]uhhjYhb]rojT)rp}rq(hgUhm}rr(ho]hp]hq]hr]ht]uhhjlhb]rs(jY)rt}ru(hgUhm}rv(ho]hp]hq]hr]ht]uhhjphb]rwh)rx}ry(hgXTierrzhhjthij6hkhhm}r{(ho]hp]hq]hr]ht]uhvK hb]r|hXTierr}r~}r(hgjzhhjxubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgXVersionrhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXVersionrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgXRESTrhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXRESTrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgXFunctionrhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXFunctionrr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjphb]rh)r}r(hgX Parametersrhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhX Parametersrr}r(hgjhhjubaubahkjfubehkjubahkjubj)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjYhb]r(jT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 4rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 4rr¬}rì(hgjhhjubaubahkjfubjY)rĬ}rŬ(hgUhm}rƬ(ho]hp]hq]hr]ht]uhhjhb]rǬh)rȬ}rɬ(hgX 1.0, (2.0)rʬhhjĬhij6hkhhm}rˬ(ho]hp]hq]hr]ht]uhvKhb]r̬hX 1.0, (2.0)rͬrά}rϬ(hgjʬhhjȬubaubahkjfubjY)rЬ}rѬ(hgUhm}rҬ(ho]hp]hq]hr]ht]uhhjhb]rӬh)rԬ}rլ(hgX#``PUT /replicaNotifications/{pid}``r֬hhjЬhij6hkhhm}r׬(ho]hp]hq]hr]ht]uhvKhb]rجj)r٬}rڬ(hgj֬hm}r۬(ho]hp]hq]hr]ht]uhhjԬhb]rܬhXPUT /replicaNotifications/{pid}rݬrެ}r߬(hgUhhj٬ubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX:func:`setReplicationStatus`rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhij6hkjhm}r(UreftypeXfuncjjXsetReplicationStatusU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXsetReplicationStatus()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX(:class:`session`, :class:`pid`, :class:`nodeRef`, :class:`status`, :class:`failure`) ``->`` booleanhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r (ho]hp]r (jjXpy-classr ehq]hr]ht]uhhjhb]r hXsessionr r}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`pid`rhhjhij6hkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr }r!(hgUhhjubahkjubaubhX, r"r#}r$(hgX, hhjubj)r%}r&(hgX%:class:`nodeRef`r'hhjhij6hkjhm}r((UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyr)hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r*j)r+}r,(hgj'hm}r-(ho]hp]r.(jj)Xpy-classr/ehq]hr]ht]uhhj%hb]r0hXnodeRefr1r2}r3(hgUhhj+ubahkjubaubhX, r4r5}r6(hgX, hhjubj)r7}r8(hgX(:class:`status`r9hhjhij6hkjhm}r:(UreftypeXclassjjXTypes.ReplicationStatusU refdomainXpyr;hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r<j)r=}r>(hgj9hm}r?(ho]hp]r@(jj;Xpy-classrAehq]hr]ht]uhhj7hb]rBhXstatusrCrD}rE(hgUhhj=ubahkjubaubhX, rFrG}rH(hgX, hhjubj)rI}rJ(hgX%:class:`failure`rKhhjhij6hkjhm}rL(UreftypeXclassjjXTypes.BaseExceptionU refdomainXpyrMhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rNj)rO}rP(hgjKhm}rQ(ho]hp]rR(jjMXpy-classrSehq]hr]ht]uhhjIhb]rThXfailurerUrV}rW(hgUhhjOubahkjubaubhX) rXrY}rZ(hgX) hhjubj)r[}r\(hgX``->``hm}r](ho]hp]hq]hr]ht]uhhjhb]r^hX->r_r`}ra(hgUhhj[ubahkjubhX booleanrbrc}rd(hgX booleanhhjubeubahkjfubehkjubjT)re}rf(hgUhm}rg(ho]hp]hq]hr]ht]uhhjhb]rh(jY)ri}rj(hgUhm}rk(ho]hp]hq]hr]ht]uhhjehb]rlh)rm}rn(hgXTier 4rohhjihij6hkhhm}rp(ho]hp]hq]hr]ht]uhvKhb]rqhXTier 4rrrs}rt(hgjohhjmubaubahkjfubjY)ru}rv(hgUhm}rw(ho]hp]hq]hr]ht]uhhjehb]rxh)ry}rz(hgX 1.0, (2.0)r{hhjuhij6hkhhm}r|(ho]hp]hq]hr]ht]uhvKhb]r}hX 1.0, (2.0)r~r}r(hgj{hhjyubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgX``PUT /replicaMetadata/{pid}``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /replicaMetadata/{pid}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgX!:func:`updateReplicationMetadata`rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhij6hkjhm}r(UreftypeXfuncjjXupdateReplicationMetadataU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]rhXupdateReplicationMetadata()rr}r(hgUhhjubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgX(:class:`session`, :class:`pid`, :class:`replicaMetadata`, ``serialVersion``) ``->`` booleanhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr­}rí(hgX, hhjubj)rĭ}rŭ(hgX:class:`pid`rƭhhjhij6hkjhm}rǭ(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrȭhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rɭj)rʭ}r˭(hgjƭhm}r̭(ho]hp]rͭ(jjȭXpy-classrέehq]hr]ht]uhhjĭhb]rϭhXpidrЭrѭ}rҭ(hgUhhjʭubahkjubaubhX, rӭrԭ}rխ(hgX, hhjubj)r֭}r׭(hgX':class:`replicaMetadata`rحhhjhij6hkjhm}r٭(UreftypeXclassjjX Types.ReplicaU refdomainXpyrڭhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rۭj)rܭ}rݭ(hgjحhm}rޭ(ho]hp]r߭(jjڭXpy-classrehq]hr]ht]uhhj֭hb]rhXreplicaMetadatarr}r(hgUhhjܭubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 4rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 4r r }r (hgjhhjubaubahkjfubjY)r }r (hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX1.0, 2.0rhhj hij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX``PUT /replicaPolicies/{id}``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r j)r!}r"(hgjhm}r#(ho]hp]hq]hr]ht]uhhjhb]r$hXPUT /replicaPolicies/{id}r%r&}r'(hgUhhj!ubahkjubaubahkjfubjY)r(}r)(hgUhm}r*(ho]hp]hq]hr]ht]uhhjhb]r+h)r,}r-(hgX:func:`setReplicationPolicy`r.hhj(hij6hkhhm}r/(ho]hp]hq]hr]ht]uhvKhb]r0j)r1}r2(hgj.hhj,hij6hkjhm}r3(UreftypeXfuncjjXsetReplicationPolicyU refdomainXpyr4hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r5j)r6}r7(hgj.hm}r8(ho]hp]r9(jj4Xpy-funcr:ehq]hr]ht]uhhj1hb]r;hXsetReplicationPolicy()r<r=}r>(hgUhhj6ubahkjubaubaubahkjfubjY)r?}r@(hgUhm}rA(ho]hp]hq]hr]ht]uhhjhb]rBh)rC}rD(hgX(:class:`session`, :class:`id`, :class:`policy`, ``serialVersion``) ``->`` booleanhhj?hij6hkhhm}rE(ho]hp]hq]hr]ht]uhvKhb]rF(hX(rG}rH(hgX(hhjCubj)rI}rJ(hgX:class:`session`rKhhjChij6hkjhm}rL(UreftypeXclassjjX Types.SessionU refdomainXpyrMhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rNj)rO}rP(hgjKhm}rQ(ho]hp]rR(jjMXpy-classrSehq]hr]ht]uhhjIhb]rThXsessionrUrV}rW(hgUhhjOubahkjubaubhX, rXrY}rZ(hgX, hhjCubj)r[}r\(hgX:class:`id`r]hhjChij6hkjhm}r^(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr_hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r`j)ra}rb(hgj]hm}rc(ho]hp]rd(jj_Xpy-classreehq]hr]ht]uhhj[hb]rfhXidrgrh}ri(hgUhhjaubahkjubaubhX, rjrk}rl(hgX, hhjCubj)rm}rn(hgX(:class:`policy`rohhjChij6hkjhm}rp(UreftypeXclassjjXTypes.ReplicationPolicyU refdomainXpyrqhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rrj)rs}rt(hgjohm}ru(ho]hp]rv(jjqXpy-classrwehq]hr]ht]uhhjmhb]rxhXpolicyryrz}r{(hgUhhjsubahkjubaubhX, r|r}}r~(hgX, hhjCubj)r}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhjChb]rhX serialVersionrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhjCubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjChb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjCubeubahkjfubehkjubjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTier 4rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXTier 4rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX 1.0, (2.0)rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX 1.0, (2.0)rr}r(hgjhhjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXJ``GET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXFGET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r®h)rî}rĮ(hgX:func:`isNodeAuthorized`rŮhhjhij6hkhhm}rƮ(ho]hp]hq]hr]ht]uhvK hb]rǮj)rȮ}rɮ(hgjŮhhjîhij6hkjhm}rʮ(UreftypeXfuncjjXisNodeAuthorizedU refdomainXpyrˮhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK hb]r̮j)rͮ}rή(hgjŮhm}rϮ(ho]hp]rЮ(jjˮXpy-funcrѮehq]hr]ht]uhhjȮhb]rҮhXisNodeAuthorized()rӮrԮ}rծ(hgUhhjͮubahkjubaubaubahkjfubjY)r֮}r׮(hgUhm}rخ(ho]hp]hq]hr]ht]uhhjhb]rٮh)rڮ}rۮ(hgX{(:class:`session`, :class:`targetNodeSubject`, :class:`pid`) ``->`` booleanhhj֮hij6hkhhm}rܮ(ho]hp]hq]hr]ht]uhvK!hb]rݮ(hX(rޮ}r߮(hgX(hhjڮubj)r}r(hgX:class:`session`rhhjڮhij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK!hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjڮubj)r}r(hgX):class:`targetNodeSubject`rhhjڮhij6hkjhm}r(UreftypeXclassjjX Types.SubjectU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK!hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXtargetNodeSubjectrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjڮubj)r}r(hgX:class:`pid`rhhjڮhij6hkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK!hb]r j)r }r (hgjhm}r (ho]hp]r (jjXpy-classrehq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhj ubahkjubaubhX) rr}r(hgX) hhjڮubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjڮhb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhjڮubeubahkjfubehkjubjT)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#(jY)r$}r%(hgUhm}r&(ho]hp]hq]hr]ht]uhhj hb]hkjfubjY)r'}r((hgUhm}r)(ho]hp]hq]hr]ht]uhhj hb]r*h)r+}r,(hgX 1.0, (2.0)r-hhj'hij6hkhhm}r.(ho]hp]hq]hr]ht]uhvK#hb]r/hX 1.0, (2.0)r0r1}r2(hgj-hhj+ubaubahkjfubjY)r3}r4(hgUhm}r5(ho]hp]hq]hr]ht]uhhj hb]r6h)r7}r8(hgX$``PUT /removeReplicaMetadata/{pid}``r9hhj3hij6hkhhm}r:(ho]hp]hq]hr]ht]uhvK$hb]r;j)r<}r=(hgj9hm}r>(ho]hp]hq]hr]ht]uhhj7hb]r?hX PUT /removeReplicaMetadata/{pid}r@rA}rB(hgUhhj<ubahkjubaubahkjfubjY)rC}rD(hgUhm}rE(ho]hp]hq]hr]ht]uhhj hb]rFh)rG}rH(hgX!:func:`deleteReplicationMetadata`rIhhjChij6hkhhm}rJ(ho]hp]hq]hr]ht]uhvK%hb]rKj)rL}rM(hgjIhhjGhij6hkjhm}rN(UreftypeXfuncjjXdeleteReplicationMetadataU refdomainXpyrOhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK%hb]rPj)rQ}rR(hgjIhm}rS(ho]hp]rT(jjOXpy-funcrUehq]hr]ht]uhhjLhb]rVhXdeleteReplicationMetadata()rWrX}rY(hgUhhjQubahkjubaubaubahkjfubjY)rZ}r[(hgUhm}r\(ho]hp]hq]hr]ht]uhhj hb]r]h)r^}r_(hgX(:class:`session`, :class:`pid`, :class:`nodeId`, ``serialVersion``) ``->`` booleanhhjZhij6hkhhm}r`(ho]hp]hq]hr]ht]uhvK&hb]ra(hX(rb}rc(hgX(hhj^ubj)rd}re(hgX:class:`session`rfhhj^hij6hkjhm}rg(UreftypeXclassjjX Types.SessionU refdomainXpyrhhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK&hb]rij)rj}rk(hgjfhm}rl(ho]hp]rm(jjhXpy-classrnehq]hr]ht]uhhjdhb]rohXsessionrprq}rr(hgUhhjjubahkjubaubhX, rsrt}ru(hgX, hhj^ubj)rv}rw(hgX:class:`pid`rxhhj^hij6hkjhm}ry(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrzhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK&hb]r{j)r|}r}(hgjxhm}r~(ho]hp]r(jjzXpy-classrehq]hr]ht]uhhjvhb]rhXpidrr}r(hgUhhj|ubahkjubaubhX, rr}r(hgX, hhj^ubj)r}r(hgX$:class:`nodeId`rhhj^hij6hkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK&hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnodeIdrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhj^ubj)r}r(hgX``serialVersion``hm}r(ho]hp]hq]hr]ht]uhhj^hb]rhX serialVersionrr}r(hgUhhjubahkjubhX) rr}r(hgX) hhj^ubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhj^hb]rhX->rr}r(hgUhhjubahkjubhX booleanrr}r(hgX booleanhhj^ubeubahkjfubehkjubehkjubehkjubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX0setReplicationStatus() (in module CNReplication)h UNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgXCsetReplicationStatus(session,pid,nodeRef,status,failure) -> booleanhhjhij6hkj "hm}r(hr]rh aj"j%hq]ho]hp]ht]rh aj"XsetReplicationStatusrj"Uj"uhvK[hwhhb]r(j")r}r(hgXCNReplication.hhjhij6hkj"hm}r¯(ho]hp]hq]hr]ht]uhvK[hwhhb]rïhXCNReplication.rįrů}rƯ(hgUhhjubaubj")rǯ}rȯ(hgjhhjhij6hkj!"hm}rɯ(ho]hp]hq]hr]ht]uhvK[hwhhb]rʯhXsetReplicationStatusr˯r̯}rͯ(hgUhhjǯubaubj'")rί}rϯ(hgX&session, pid, nodeRef, status, failurehhjhij6hkj*"hm}rЯ(ho]hp]hq]hr]ht]uhvK[hwhhb]rѯ(j-")rү}rӯ(hgXsessionhm}rԯ(ho]hp]hq]hr]ht]uhhjίhb]rկhXsessionr֯rׯ}rد(hgUhhjүubahkj5"ubj-")rٯ}rگ(hgXpidhm}rۯ(ho]hp]hq]hr]ht]uhhjίhb]rܯhXpidrݯrޯ}r߯(hgUhhjٯubahkj5"ubj-")r}r(hgXnodeRefhm}r(ho]hp]hq]hr]ht]uhhjίhb]rhXnodeRefrr}r(hgUhhjubahkj5"ubj-")r}r(hgXstatushm}r(ho]hp]hq]hr]ht]uhhjίhb]rhXstatusrr}r(hgUhhjubahkj5"ubj-")r}r(hgXfailurehm}r(ho]hp]hq]hr]ht]uhhjίhb]rhXfailurerr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjhij6hkj9"hm}r(ho]hp]hq]hr]ht]uhvK[hwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjhij6hkjB"hm}r(ho]hp]hq]hr]ht]uhvK[hwhhb]r(h)r}r(hgXbUpdate the replication status of the system metadata, ensuring that the change is appropriate for the given state of system metadata. For example, a MN can not change the status to *COMPLETED* unless the CN previously requested replication of the object and the replications status of the object (as indicated in the system metadata) is set to *QUEUED*.hhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK-hwhhb]r(hXUpdate the replication status of the system metadata, ensuring that the change is appropriate for the given state of system metadata. For example, a MN can not change the status to rr}r(hgXUpdate the replication status of the system metadata, ensuring that the change is appropriate for the given state of system metadata. For example, a MN can not change the status to hhjubj$)r}r(hgX *COMPLETED*hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX COMPLETEDr r }r (hgUhhjubahkj$ubhX unless the CN previously requested replication of the object and the replications status of the object (as indicated in the system metadata) is set to rr}r(hgX unless the CN previously requested replication of the object and the replications status of the object (as indicated in the system metadata) is set to hhjubj$)r}r(hgX*QUEUED*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXQUEUEDrr}r(hgUhhjubahkj$ubhX.r}r(hgX.hhjubeubh)r}r(hgX[Successful completion of this operation is indicated by a HTTP response status code of 200.rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK/hwhhb]rhX[Successful completion of this operation is indicated by a HTTP response status code of 200.rr }r!(hgjhhjubaubh)r"}r#(hgXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.r$hhjhij6hkhhm}r%(ho]hp]hq]hr]ht]uhvK1hwhhb]r&hXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.r'r(}r)(hgj$hhj"ubaubh)r*}r+(hgXThe nodeRef, status, and failure parameters are transmitted as part of the HTTP request body encoded as a MIME Multipart/form-data encoded payload.r,hhjhij6hkhhm}r-(ho]hp]hq]hr]ht]uhvK3hwhhb]r.hXThe nodeRef, status, and failure parameters are transmitted as part of the HTTP request body encoded as a MIME Multipart/form-data encoded payload.r/r0}r1(hgj,hhj*ubaubh)r2}r3(hgXNThis method can be only called by Coordinating Nodes and trusted Member Nodes.r4hhjhij6hkhhm}r5(ho]hp]hq]hr]ht]uhvK5hwhhb]r6hXNThis method can be only called by Coordinating Nodes and trusted Member Nodes.r7r8}r9(hgj4hhj2ubaubh)r:}r;(hgUhhjhiNhkhhm}r<(ho]hp]hq]hr]ht]uhvNhwhhb]r=(h)r>}r?(hgUhhj:hij6hkhhm}r@(ho]hp]hq]hr]ht]uhvK7hwhhb]rA(h)rB}rC(hgXVersionhhj>hij6hkhhm}rD(ho]hp]hq]hr]ht]uhvKhb]rEhXVersionrFrG}rH(hgUhhjBubaubh)rI}rJ(hgX 1.0, (2.0)rKhm}rL(ho]hp]hq]hr]ht]uhhj>hb]rMh)rN}rO(hgjKhhjIhij6hkhhm}rP(ho]hp]hq]hr]ht]uhvK7hb]rQhX 1.0, (2.0)rRrS}rT(hgjKhhjNubaubahkhubeubh)rU}rV(hgUhhj:hij6hkhhm}rW(ho]hp]hq]hr]ht]uhvK8hwhhb]rX(h)rY}rZ(hgX Use CaseshhjUhij6hkhhm}r[(ho]hp]hq]hr]ht]uhvKhb]r\hX Use Casesr]r^}r_(hgUhhjYubaubh)r`}ra(hgX$:doc:`UC09 `rbhm}rc(ho]hp]hq]hr]ht]uhhjUhb]rdh)re}rf(hgjbhhj`hij6hkhhm}rg(ho]hp]hq]hr]ht]uhvK9hb]rhj)ri}rj(hgjbhhjehij6hkjhm}rk(UreftypeXdocrljjX/design/UseCases/09_ucU refdomainUhr]hq]U refexplicitho]hp]ht]jjuhvK9hb]rmj`2)rn}ro(hgjbhm}rp(ho]hp]rq(jjlehq]hr]ht]uhhjihb]rrhXUC09rsrt}ru(hgUhhjnubahkji2ubaubaubahkhubeubh)rv}rw(hgUhhj:hij6hkhhm}rx(ho]hp]hq]hr]ht]uhvK:hwhhb]ry(h)rz}r{(hgXREST URLhhjvhij6hkhhm}r|(ho]hp]hq]hr]ht]uhvKhb]r}hXREST URLr~r}r(hgUhhjzubaubh)r}r(hgX#``PUT /replicaNotifications/{pid}``rhm}r(ho]hp]hq]hr]ht]uhhjvhb]rh)r}r(hgjhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvK:hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXPUT /replicaNotifications/{pid}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj:hb]r(h)r}r(hgX Parametershhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvK(UreftypeXclassjjXTypes.ReplicationStatusU refdomainXpyr?hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKEhb]r@j)rA}rB(hgj=hm}rC(ho]hp]rD(jj?Xpy-classrEehq]hr]ht]uhhj;hb]rFhXTypes.ReplicationStatusrGrH}rI(hgUhhjAubahkjubaubhX)rJ}rK(hgUhhj-ubhX -- rLrM}rN(hgUhhj-ubhXhReplication status. See system metadata schema for possible values. Transmitted as a UTF-8 String as a rOrP}rQ(hgXhReplication status. See system metadata schema for possible values. Transmitted as a UTF-8 String as a hhj-ubj$)rR}rS(hgX *Param part*hm}rT(ho]hp]hq]hr]ht]uhhj-hb]rUhX Param partrVrW}rX(hgUhhjRubahkj$ubhX% of the MIME multipart/mixed message.rYrZ}r[(hgX% of the MIME multipart/mixed message.hhj-ubehkhubahkj;#ubj#)r\}r](hgUhm}r^(ho]hp]hq]hr]ht]uhhjhb]r_h)r`}ra(hgXfailure (Types.BaseException) -- A BaseException object or one of it's subclasses, or null. If the status is set to 'failed', this exception object can provide more detail. Appropriate sub-classes include InsufficientResource, NotAuthorized, ServiceFailure, etc. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}rb(ho]hp]hq]hr]ht]uhhj\hb]rc(j")rd}re(hgXfailurehm}rf(hr]hq]j"ho]hp]ht]uhhj`hb]rghXfailurerhri}rj(hgUhhjdubahkj"ubhX (rkrl}rm(hgUhhj`ubj)rn}ro(hgX:class:`Types.BaseException`rphhj`hij6hkjhm}rq(UreftypeXclassjjXTypes.BaseExceptionU refdomainXpyrrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKHhb]rsj)rt}ru(hgjphm}rv(ho]hp]rw(jjrXpy-classrxehq]hr]ht]uhhjnhb]ryhXTypes.BaseExceptionrzr{}r|(hgUhhjtubahkjubaubhX)r}}r~(hgUhhj`ubhX -- rr}r(hgUhhj`ubhXZA BaseException object or one of it's subclasses, or null. If the status is set to 'failed', this exception object can provide more detail. Appropriate sub-classes include InsufficientResource, NotAuthorized, ServiceFailure, etc. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXZA BaseException object or one of it's subclasses, or null. If the status is set to 'failed', this exception object can provide more detail. Appropriate sub-classes include InsufficientResource, NotAuthorized, ServiceFailure, etc. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhj`ubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhj`hb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhj`ubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj:hb]r(h)r}r(hgXReturnshhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXWTrue if the operation is allowed and expected, otherwise an exception should be raised.hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXWTrue if the operation is allowed and expected, otherwise an exception should be raised.rr}r(hgXWTrue if the operation is allowed and expected, otherwise an exception should be raised.hhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj:hb]r(h)r}r(hgX Return typehhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj:hb]r±(h)rñ}rı(hgXRaiseshhjhij6hkhhm}rű(ho]hp]hq]hr]ht]uhvKhb]rƱhXRaisesrDZrȱ}rɱ(hgUhhjñubaubh)rʱ}r˱(hgUhm}ṟ(ho]hp]hq]hr]ht]uhhjhb]rͱj #)rα}rϱ(hgUhm}rб(ho]hp]hq]hr]ht]uhhjʱhb]rѱ(j#)rұ}rӱ(hgUhm}rԱ(ho]hp]hq]hr]ht]uhhjαhb]rձh)rֱ}rױ(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4700)hm}rر(ho]hp]hq]hr]ht]uhhjұhb]rٱ(j)rڱ}r۱(hgUhm}rܱ(Ureftypej#j"U reftargetXExceptions.ServiceFailurerݱU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjֱhb]rޱj")r߱}r(hgjݱhm}r(ho]hp]hq]hr]ht]uhhjڱhb]rhXExceptions.ServiceFailurerr}r(hgUhhj߱ubahkj"ubahkjubhX -- rr}r(hgUhhjֱubj)r}r(hgX$``(errorCode=500, detailCode=4700)``hm}r(ho]hp]hq]hr]ht]uhhjֱhb]rhX (errorCode=500, detailCode=4700)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjαhb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4701)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=4701)``hm}r (ho]hp]hq]hr]ht]uhhjhb]r hX (errorCode=501, detailCode=4701)r r }r (hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjαhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4710)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr }r!(hgUhhjubahkj"ubahkjubhX -- r"r#}r$(hgUhhjubj)r%}r&(hgX$``(errorCode=401, detailCode=4710)``hm}r'(ho]hp]hq]hr]ht]uhhjhb]r(hX (errorCode=401, detailCode=4710)r)r*}r+(hgUhhj%ubahkjubehkhubahkj;#ubj#)r,}r-(hgUhm}r.(ho]hp]hq]hr]ht]uhhjαhb]r/h)r0}r1(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4720)hm}r2(ho]hp]hq]hr]ht]uhhj,hb]r3(j)r4}r5(hgUhm}r6(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr7U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj0hb]r8j")r9}r:(hgj7hm}r;(ho]hp]hq]hr]ht]uhhj4hb]r<hXExceptions.NotAuthorizedr=r>}r?(hgUhhj9ubahkj"ubahkjubhX -- r@rA}rB(hgUhhj0ubj)rC}rD(hgX$``(errorCode=401, detailCode=4720)``hm}rE(ho]hp]hq]hr]ht]uhhj0hb]rFhX (errorCode=401, detailCode=4720)rGrH}rI(hgUhhjCubahkjubehkhubahkj;#ubj#)rJ}rK(hgUhm}rL(ho]hp]hq]hr]ht]uhhjαhb]rMh)rN}rO(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4730)hm}rP(ho]hp]hq]hr]ht]uhhjJhb]rQ(j)rR}rS(hgUhm}rT(Ureftypej#j"U reftargetXExceptions.InvalidRequestrUU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjNhb]rVj")rW}rX(hgjUhm}rY(ho]hp]hq]hr]ht]uhhjRhb]rZhXExceptions.InvalidRequestr[r\}r](hgUhhjWubahkj"ubahkjubhX -- r^r_}r`(hgUhhjNubj)ra}rb(hgX$``(errorCode=400, detailCode=4730)``hm}rc(ho]hp]hq]hr]ht]uhhjNhb]rdhX (errorCode=400, detailCode=4730)rerf}rg(hgUhhjaubahkjubehkhubahkj;#ubj#)rh}ri(hgUhm}rj(ho]hp]hq]hr]ht]uhhjαhb]rkh)rl}rm(hgX7Exceptions.NotFound -- (errorCode=404, detailCode=4740)hm}rn(ho]hp]hq]hr]ht]uhhjhhb]ro(j)rp}rq(hgUhm}rr(Ureftypej#j"U reftargetXExceptions.NotFoundrsU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjlhb]rtj")ru}rv(hgjshm}rw(ho]hp]hq]hr]ht]uhhjphb]rxhXExceptions.NotFoundryrz}r{(hgUhhjuubahkj"ubahkjubhX -- r|r}}r~(hgUhhjlubj)r}r(hgX$``(errorCode=404, detailCode=4740)``hm}r(ho]hp]hq]hr]ht]uhhjlhb]rhX (errorCode=404, detailCode=4740)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX5updateReplicationMetadata() (in module CNReplication)hUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgXOupdateReplicationMetadata(session,pid,replicaMetadata,serialVersion) -> booleanhhjhij6hkj "hm}r(hr]rhaj"j%hq]ho]hp]ht]rhaj"XupdateReplicationMetadatarj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhij6hkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r(hgUhhjubaubj")r}r(hgjhhjhij6hkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXupdateReplicationMetadatarr}r(hgUhhjubaubj'")r}r(hgX,session, pid, replicaMetadata, serialVersionhhjhij6hkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXpidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkj5"ubj-")r}r(hgXreplicaMetadatahm}r(ho]hp]hq]hr]ht]uhhjhb]rhXreplicaMetadatarr}r(hgUhhjubahkj5"ubj-")r}r(hgX serialVersionhm}r(ho]hp]hq]hr]ht]uhhjhb]r²hX serialVersionròrIJ}rŲ(hgUhhjubahkj5"ubeubj6")rƲ}rDz(hgXbooleanhhjhij6hkj9"hm}rȲ(ho]hp]hq]hr]ht]uhvKhwhhb]rɲhXbooleanrʲr˲}r̲(hgUhhjƲubaubeubj?")rͲ}rβ(hgUhhjhij6hkjB"hm}rϲ(ho]hp]hq]hr]ht]uhvKhwhhb]rв(h)rѲ}rҲ(hgXReplaces the replica with matching nodeRef in the system metadata of the specified object. Adds a new replica if the nodeRef of passed in Replica is not already present. Changes the date sys meta modified.rӲhhjͲhij6hkhhm}rԲ(ho]hp]hq]hr]ht]uhvK^hwhhb]rղhXReplaces the replica with matching nodeRef in the system metadata of the specified object. Adds a new replica if the nodeRef of passed in Replica is not already present. Changes the date sys meta modified.rֲrײ}rز(hgjӲhhjѲubaubh)rٲ}rڲ(hgXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.r۲hhjͲhij6hkhhm}rܲ(ho]hp]hq]hr]ht]uhvK`hwhhb]rݲhXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.r޲r߲}r(hgj۲hhjٲubaubh)r}r(hgXQFailure of the operation MUST be indicated by returning an appropriate exception.rhhjͲhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKbhwhhb]rhXQFailure of the operation MUST be indicated by returning an appropriate exception.rr}r(hgjhhjubaubh)r}r(hgX5This method can be only called by Coordinating Nodes.rhhjͲhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKdhwhhb]rhX5This method can be only called by Coordinating Nodes.rr}r(hgjhhjubaubh)r}r(hgUhhjͲhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKfhwhhb]r(h)r}r(hgXVersionhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX 1.0, (2.0)rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKfhb]rhX 1.0, (2.0)r r }r (hgjhhjubaubahkhubeubh)r }r (hgUhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKghwhhb]r(h)r}r(hgXREST URLhhj hij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX``PUT /replicaMetadata/{pid}``rhm}r(ho]hp]hq]hr]ht]uhhj hb]rh)r}r(hgjhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKghb]rj)r }r!(hgjhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#hXPUT /replicaMetadata/{pid}r$r%}r&(hgUhhj ubahkjubaubahkhubeubh)r'}r((hgUhm}r)(ho]hp]hq]hr]ht]uhhjhb]r*(h)r+}r,(hgX Parametershhj'hij6hkhhm}r-(ho]hp]hq]hr]ht]uhvKhb]r.hX Parametersr/r0}r1(hgUhhj+ubaubh)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhj'hb]r5j #)r6}r7(hgUhm}r8(ho]hp]hq]hr]ht]uhhj2hb]r9(j#)r:}r;(hgUhm}r<(ho]hp]hq]hr]ht]uhhj6hb]r=h)r>}r?(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hm}r@(ho]hp]hq]hr]ht]uhhj:hb]rA(j")rB}rC(hgXsessionhm}rD(hr]hq]j"ho]hp]ht]uhhj>hb]rEhXsessionrFrG}rH(hgUhhjBubahkj"ubhX (rIrJ}rK(hgUhhj>ubj)rL}rM(hgX:class:`Types.Session`rNhhj>hij6hkjhm}rO(UreftypeXclassjjX Types.SessionU refdomainXpyrPhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKihb]rQj)rR}rS(hgjNhm}rT(ho]hp]rU(jjPXpy-classrVehq]hr]ht]uhhjLhb]rWhX Types.SessionrXrY}rZ(hgUhhjRubahkjubaubhX)r[}r\(hgUhhj>ubhX -- r]r^}r_(hgUhhj>ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.r`ra}rb(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. Transmitted as part of the SSL handshake process.hhj>ubehkhubahkj;#ubj#)rc}rd(hgUhm}re(ho]hp]hq]hr]ht]uhhj6hb]rfh)rg}rh(hgX^pid (Types.Identifier) -- Transmitted as part of the URL path and must be escaped accordingly.hm}ri(ho]hp]hq]hr]ht]uhhjchb]rj(j")rk}rl(hgXpidhm}rm(hr]hq]j"ho]hp]ht]uhhjghb]rnhXpidrorp}rq(hgUhhjkubahkj"ubhX (rrrs}rt(hgUhhjgubj)ru}rv(hgX:class:`Types.Identifier`rwhhjghij6hkjhm}rx(UreftypeXclassjjXTypes.IdentifierU refdomainXpyryhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKlhb]rzj)r{}r|(hgjwhm}r}(ho]hp]r~(jjyXpy-classrehq]hr]ht]uhhjuhb]rhXTypes.Identifierrr}r(hgUhhj{ubahkjubaubhX)r}r(hgUhhjgubhX -- rr}r(hgUhhjgubhXDTransmitted as part of the URL path and must be escaped accordingly.rr}r(hgXDTransmitted as part of the URL path and must be escaped accordingly.hhjgubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj6hb]rh)r}r(hgXreplicaMetadata (Types.Replica) -- Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXreplicaMetadatahm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXreplicaMetadatarr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Replica`rhhjhij6hkjhm}r(UreftypeXclassjjX Types.ReplicaU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKohb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Replicarr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj6hb]r³h)ró}rij(hgXserialVersion (unsigned long) -- The serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}rų(ho]hp]hq]hr]ht]uhhjhb]rƳ(j")rdz}rȳ(hgX serialVersionhm}rɳ(hr]hq]j"ho]hp]ht]uhhjóhb]rʳhX serialVersionr˳r̳}rͳ(hgUhhjdzubahkj"ubhX (rγrϳ}rг(hgUhhjóubj)rѳ}rҳ(hgUhm}rӳ(Ureftypej&j"U reftargetX unsigned longrԳU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjóhb]rճj&)rֳ}r׳(hgjԳhm}rس(ho]hp]hq]hr]ht]uhhjѳhb]rٳhX unsigned longrڳr۳}rܳ(hgUhhjֳubahkj&ubahkjubhX)rݳ}r޳(hgUhhjóubhX -- r߳r}r(hgUhhjóubhXyThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a rr}r(hgXyThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a hhjóubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhjóhb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjóubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXReturnshhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTrue on successhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXTrue on successrr}r(hgXTrue on successhhjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r }r (hgX Return typehhjhij6hkhhm}r (ho]hp]hq]hr]ht]uhvKhb]r hX Return typer r}r(hgUhhj ubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r (hgUhm}r!(ho]hp]hq]hr]ht]uhhjhb]r"(h)r#}r$(hgXRaiseshhjhij6hkhhm}r%(ho]hp]hq]hr]ht]uhvKhb]r&hXRaisesr'r(}r)(hgUhhj#ubaubh)r*}r+(hgUhm}r,(ho]hp]hq]hr]ht]uhhjhb]r-j #)r.}r/(hgUhm}r0(ho]hp]hq]hr]ht]uhhj*hb]r1(j#)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhj.hb]r5h)r6}r7(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4850)hm}r8(ho]hp]hq]hr]ht]uhhj2hb]r9(j)r:}r;(hgUhm}r<(Ureftypej#j"U reftargetXExceptions.NotImplementedr=U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj6hb]r>j")r?}r@(hgj=hm}rA(ho]hp]hq]hr]ht]uhhj:hb]rBhXExceptions.NotImplementedrCrD}rE(hgUhhj?ubahkj"ubahkjubhX -- rFrG}rH(hgUhhj6ubj)rI}rJ(hgX$``(errorCode=501, detailCode=4850)``hm}rK(ho]hp]hq]hr]ht]uhhj6hb]rLhX (errorCode=501, detailCode=4850)rMrN}rO(hgUhhjIubahkjubehkhubahkj;#ubj#)rP}rQ(hgUhm}rR(ho]hp]hq]hr]ht]uhhj.hb]rSh)rT}rU(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4851)hm}rV(ho]hp]hq]hr]ht]uhhjPhb]rW(j)rX}rY(hgUhm}rZ(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr[U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjThb]r\j")r]}r^(hgj[hm}r_(ho]hp]hq]hr]ht]uhhjXhb]r`hXExceptions.NotAuthorizedrarb}rc(hgUhhj]ubahkj"ubahkjubhX -- rdre}rf(hgUhhjTubj)rg}rh(hgX$``(errorCode=401, detailCode=4851)``hm}ri(ho]hp]hq]hr]ht]uhhjThb]rjhX (errorCode=401, detailCode=4851)rkrl}rm(hgUhhjgubahkjubehkhubahkj;#ubj#)rn}ro(hgUhm}rp(ho]hp]hq]hr]ht]uhhj.hb]rqh)rr}rs(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4852)hm}rt(ho]hp]hq]hr]ht]uhhjnhb]ru(j)rv}rw(hgUhm}rx(Ureftypej#j"U reftargetXExceptions.ServiceFailureryU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjrhb]rzj")r{}r|(hgjyhm}r}(ho]hp]hq]hr]ht]uhhjvhb]r~hXExceptions.ServiceFailurerr}r(hgUhhj{ubahkj"ubahkjubhX -- rr}r(hgUhhjrubj)r}r(hgX$``(errorCode=500, detailCode=4852)``hm}r(ho]hp]hq]hr]ht]uhhjrhb]rhX (errorCode=500, detailCode=4852)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj.hb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4853)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=400, detailCode=4853)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4853)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj.hb]rh)r}r(hgXWExceptions.NotFound -- (errorCode=404, detailCode=4854)The specified pid does not existhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r´(hgX$``(errorCode=404, detailCode=4854)``rôhhjhij6hkhhm}rĴ(ho]hp]hq]hr]ht]uhvKhb]rŴj)rƴ}rǴ(hgjôhm}rȴ(ho]hp]hq]hr]ht]uhhjhb]rɴhX (errorCode=404, detailCode=4854)rʴr˴}r̴(hgUhhjƴubahkjubaubh)rʹ}rδ(hgX The specified pid does not existrϴhhjhij6hkhhm}rд(ho]hp]hq]hr]ht]uhvKhb]rѴhX The specified pid does not existrҴrӴ}rԴ(hgjϴhhjʹubaubehkhubahkj;#ubj#)rմ}rִ(hgUhm}r״(ho]hp]hq]hr]ht]uhhj.hb]rشh)rٴ}rڴ(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4855)The serialVersion supplied with the request does not match the serialVersion of the targethm}r۴(ho]hp]hq]hr]ht]uhhjմhb]rܴ(j)rݴ}r޴(hgUhm}rߴ(Ureftypej#j"U reftargetXExceptions.VersionMismatchrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjٴhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjݴhb]rhXExceptions.VersionMismatchrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjٴubh)r}r(hgX$``(errorCode=409, detailCode=4855)``rhhjٴhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=409, detailCode=4855)rr}r(hgUhhjubahkjubaubh)r}r(hgXZThe serialVersion supplied with the request does not match the serialVersion of the targetrhhjٴhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXZThe serialVersion supplied with the request does not match the serialVersion of the targetrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj.hb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4856)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r (hgUhm}r (Ureftypej#j"U reftargetXExceptions.InvalidTokenr U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r(hgj hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4856)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4856)rr}r(hgUhhjubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r(hgUhhjhiNhkjhm}r (hr]hq]ho]hp]ht]Uentries]r!(jX0setReplicationPolicy() (in module CNReplication)hMUNtr"auhvNhwhhb]ubj!)r#}r$(hgUhhjhiNhkj!hm}r%(j"j"Xpyr&hr]hq]ho]hp]ht]j"Xfunctionr'j"j'uhvNhwhhb]r((j")r)}r*(hgX@setReplicationPolicy(session,id,policy,serialVersion) -> booleanhhj#hij6hkj "hm}r+(hr]r,hMaj"j%hq]ho]hp]ht]r-hMaj"XsetReplicationPolicyr.j"Uj"uhvKhwhhb]r/(j")r0}r1(hgXCNReplication.hhj)hij6hkj"hm}r2(ho]hp]hq]hr]ht]uhvKhwhhb]r3hXCNReplication.r4r5}r6(hgUhhj0ubaubj")r7}r8(hgj.hhj)hij6hkj!"hm}r9(ho]hp]hq]hr]ht]uhvKhwhhb]r:hXsetReplicationPolicyr;r<}r=(hgUhhj7ubaubj'")r>}r?(hgX"session, id, policy, serialVersionhhj)hij6hkj*"hm}r@(ho]hp]hq]hr]ht]uhvKhwhhb]rA(j-")rB}rC(hgXsessionhm}rD(ho]hp]hq]hr]ht]uhhj>hb]rEhXsessionrFrG}rH(hgUhhjBubahkj5"ubj-")rI}rJ(hgXidhm}rK(ho]hp]hq]hr]ht]uhhj>hb]rLhXidrMrN}rO(hgUhhjIubahkj5"ubj-")rP}rQ(hgXpolicyhm}rR(ho]hp]hq]hr]ht]uhhj>hb]rShXpolicyrTrU}rV(hgUhhjPubahkj5"ubj-")rW}rX(hgX serialVersionhm}rY(ho]hp]hq]hr]ht]uhhj>hb]rZhX serialVersionr[r\}r](hgUhhjWubahkj5"ubeubj6")r^}r_(hgXbooleanhhj)hij6hkj9"hm}r`(ho]hp]hq]hr]ht]uhvKhwhhb]rahXbooleanrbrc}rd(hgUhhj^ubaubeubj?")re}rf(hgUhhj#hij6hkjB"hm}rg(ho]hp]hq]hr]ht]uhvKhwhhb]rh(h)ri}rj(hgXSUpdates the replication policy entry for an object by updating the system metadata.rkhhjehij6hkhhm}rl(ho]hp]hq]hr]ht]uhvKhwhhb]rmhXSUpdates the replication policy entry for an object by updating the system metadata.rnro}rp(hgjkhhjiubaubh)rq}rr(hgXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.rshhjehij6hkhhm}rt(ho]hp]hq]hr]ht]uhvKhwhhb]ruhXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.rvrw}rx(hgjshhjqubaubh)ry}rz(hgXQFailure of the operation MUST be indicated by returning an appropriate exception.r{hhjehij6hkhhm}r|(ho]hp]hq]hr]ht]uhvKhwhhb]r}hXQFailure of the operation MUST be indicated by returning an appropriate exception.r~r}r(hgj{hhjyubaubh)r}r(hgX9v2.0: The identifier may be a :term:`PID` or :term:`SID`.hhjehij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(hXv2.0: The identifier may be a rr}r(hgXv2.0: The identifier may be a hhjubj)r}r(hgX :term:`PID`rhhjhij6hkjhm}r(UreftypeXtermjjXpidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXPIDrr}r(hgUhhjubahkji2ubaubhX or rr}r(hgX or hhjubj)r}r(hgX :term:`SID`rhhjhij6hkjhm}r(UreftypeXtermjjXsidU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXSIDrr}r(hgUhhjubahkji2ubaubhX.r}r(hgX.hhjubeubh)r}r(hgUhhjehiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(h)r}r(hgXVersionhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX1.0, 2.0rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rµhX1.0, 2.0rõrĵ}rŵ(hgjhhjubaubahkhubeubh)rƵ}rǵ(hgUhhjhij6hkhhm}rȵ(ho]hp]hq]hr]ht]uhvKhwhhb]rɵ(h)rʵ}r˵(hgXREST URLhhjƵhij6hkhhm}r̵(ho]hp]hq]hr]ht]uhvKhb]r͵hXREST URLrεrϵ}rе(hgUhhjʵubaubh)rѵ}rҵ(hgX``PUT /replicaPolicies/{id}``rӵhm}rԵ(ho]hp]hq]hr]ht]uhhjƵhb]rյh)rֵ}r׵(hgjӵhhjѵhij6hkhhm}rص(ho]hp]hq]hr]ht]uhvKhb]rٵj)rڵ}r۵(hgjӵhm}rܵ(ho]hp]hq]hr]ht]uhhjֵhb]rݵhXPUT /replicaPolicies/{id}r޵rߵ}r(hgUhhjڵubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Parametershhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhij6hkjhm}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r j)r }r (hgjhm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhj ubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhij6hkjhm}r (UreftypeXtermjjX public userU refdomainXstdr!hr]hq]U refexplicitho]hp]ht]jjuhvKhb]r"j`2)r#}r$(hgjhm}r%(ho]hp]r&(jj!Xstd-termr'ehq]hr]ht]uhhjhb]r(hX public userr)r*}r+(hgUhhj#ubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r,r-}r.(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r/}r0(hgUhm}r1(ho]hp]hq]hr]ht]uhhjhb]r2h)r3}r4(hgXid (Types.Identifier) -- The identifier of the policy being updated. May be either a PID or a SID, the latter acting only on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hm}r5(ho]hp]hq]hr]ht]uhhj/hb]r6(j")r7}r8(hgXidhm}r9(hr]hq]j"ho]hp]ht]uhhj3hb]r:hXidr;r<}r=(hgUhhj7ubahkj"ubhX (r>r?}r@(hgUhhj3ubj)rA}rB(hgX:class:`Types.Identifier`rChhj3hij6hkjhm}rD(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrEhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rFj)rG}rH(hgjChm}rI(ho]hp]rJ(jjEXpy-classrKehq]hr]ht]uhhjAhb]rLhXTypes.IdentifierrMrN}rO(hgUhhjGubahkjubaubhX)rP}rQ(hgUhhj3ubhX -- rRrS}rT(hgUhhj3ubhXThe identifier of the policy being updated. May be either a PID or a SID, the latter acting only on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.rUrV}rW(hgXThe identifier of the policy being updated. May be either a PID or a SID, the latter acting only on the HEAD PID. Transmitted as part of the URL path and must be escaped accordingly.hhj3ubehkhubahkj;#ubj#)rX}rY(hgUhm}rZ(ho]hp]hq]hr]ht]uhhjhb]r[h)r\}r](hgXpolicy (Types.ReplicationPolicy) -- Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r^(ho]hp]hq]hr]ht]uhhjXhb]r_(j")r`}ra(hgXpolicyhm}rb(hr]hq]j"ho]hp]ht]uhhj\hb]rchXpolicyrdre}rf(hgUhhj`ubahkj"ubhX (rgrh}ri(hgUhhj\ubj)rj}rk(hgX :class:`Types.ReplicationPolicy`rlhhj\hij6hkjhm}rm(UreftypeXclassjjXTypes.ReplicationPolicyU refdomainXpyrnhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]roj)rp}rq(hgjlhm}rr(ho]hp]rs(jjnXpy-classrtehq]hr]ht]uhhjjhb]ruhXTypes.ReplicationPolicyrvrw}rx(hgUhhjpubahkjubaubhX)ry}rz(hgUhhj\ubhX -- r{r|}r}(hgUhhj\ubhXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r~r}r(hgXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhj\ubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhj\hb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhj\ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXserialVersion (unsigned long) -- The serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgX serialVersionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgUhm}r(Ureftypej&j"U reftargetX unsigned longrU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjhb]rj&)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX unsigned longrr}r(hgUhhjubahkj&ubahkjubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a rr}r(hgXxThe serialVersion of the system metadata that is the intended target for the change. Transmitted as a UTF-8 String as a hhjubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXReturnshhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r¶hXReturnsrörĶ}rŶ(hgUhhjubaubh)rƶ}rǶ(hgUhm}rȶ(ho]hp]hq]hr]ht]uhhjhb]rɶh)rʶ}r˶(hgXTrue on successhm}r̶(ho]hp]hq]hr]ht]uhhjƶhb]rͶhXTrue on successrζr϶}rж(hgXTrue on successhhjʶubahkhubahkhubehkhubh)rѶ}rҶ(hgUhm}rӶ(ho]hp]hq]hr]ht]uhhjhb]rԶ(h)rն}rֶ(hgX Return typehhjѶhij6hkhhm}r׶(ho]hp]hq]hr]ht]uhvKhb]rضhX Return typerٶrڶ}r۶(hgUhhjնubaubh)rܶ}rݶ(hgUhm}r޶(ho]hp]hq]hr]ht]uhhjѶhb]r߶h)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjܶhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXRaiseshhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4880)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedr U refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=4880)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=4880)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r }r!(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4881)hm}r"(ho]hp]hq]hr]ht]uhhjhb]r#(j)r$}r%(hgUhm}r&(Ureftypej#j"U reftargetXExceptions.NotAuthorizedr'U refdomainj&hr]hq]U refexplicitho]hp]ht]uhhj hb]r(j")r)}r*(hgj'hm}r+(ho]hp]hq]hr]ht]uhhj$hb]r,hXExceptions.NotAuthorizedr-r.}r/(hgUhhj)ubahkj"ubahkjubhX -- r0r1}r2(hgUhhj ubj)r3}r4(hgX$``(errorCode=401, detailCode=4881)``hm}r5(ho]hp]hq]hr]ht]uhhj hb]r6hX (errorCode=401, detailCode=4881)r7r8}r9(hgUhhj3ubahkjubehkhubahkj;#ubj#)r:}r;(hgUhm}r<(ho]hp]hq]hr]ht]uhhjhb]r=h)r>}r?(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4882)hm}r@(ho]hp]hq]hr]ht]uhhj:hb]rA(j)rB}rC(hgUhm}rD(Ureftypej#j"U reftargetXExceptions.ServiceFailurerEU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhj>hb]rFj")rG}rH(hgjEhm}rI(ho]hp]hq]hr]ht]uhhjBhb]rJhXExceptions.ServiceFailurerKrL}rM(hgUhhjGubahkj"ubahkjubhX -- rNrO}rP(hgUhhj>ubj)rQ}rR(hgX$``(errorCode=500, detailCode=4882)``hm}rS(ho]hp]hq]hr]ht]uhhj>hb]rThX (errorCode=500, detailCode=4882)rUrV}rW(hgUhhjQubahkjubehkhubahkj;#ubj#)rX}rY(hgUhm}rZ(ho]hp]hq]hr]ht]uhhjhb]r[h)r\}r](hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4883)hm}r^(ho]hp]hq]hr]ht]uhhjXhb]r_(j)r`}ra(hgUhm}rb(Ureftypej#j"U reftargetXExceptions.InvalidRequestrcU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhj\hb]rdj")re}rf(hgjchm}rg(ho]hp]hq]hr]ht]uhhj`hb]rhhXExceptions.InvalidRequestrirj}rk(hgUhhjeubahkj"ubahkjubhX -- rlrm}rn(hgUhhj\ubj)ro}rp(hgX$``(errorCode=400, detailCode=4883)``hm}rq(ho]hp]hq]hr]ht]uhhj\hb]rrhX (errorCode=400, detailCode=4883)rsrt}ru(hgUhhjoubahkjubehkhubahkj;#ubj#)rv}rw(hgUhm}rx(ho]hp]hq]hr]ht]uhhjhb]ryh)rz}r{(hgX7Exceptions.NotFound -- (errorCode=404, detailCode=4884)hm}r|(ho]hp]hq]hr]ht]uhhjvhb]r}(j)r~}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjzhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhj~hb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjzubj)r}r(hgX$``(errorCode=404, detailCode=4884)``hm}r(ho]hp]hq]hr]ht]uhhjzhb]rhX (errorCode=404, detailCode=4884)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4885)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4885)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4885)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4886)The serialVersion supplied with the request does not match the serialVersion of the targethm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.VersionMismatchrU refdomainj&hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]r·hXExceptions.VersionMismatchr÷rķ}rŷ(hgUhhjubahkj"ubahkjubhX -- rƷrǷ}rȷ(hgUhhjubh)rɷ}rʷ(hgX$``(errorCode=409, detailCode=4886)``r˷hhjhij6hkhhm}r̷(ho]hp]hq]hr]ht]uhvKhb]rͷj)rη}rϷ(hgj˷hm}rз(ho]hp]hq]hr]ht]uhhjɷhb]rѷhX (errorCode=409, detailCode=4886)rҷrӷ}rԷ(hgUhhjηubahkjubaubh)rշ}rַ(hgXZThe serialVersion supplied with the request does not match the serialVersion of the targetr׷hhjhij6hkhhm}rط(ho]hp]hq]hr]ht]uhvKhb]rٷhXZThe serialVersion supplied with the request does not match the serialVersion of the targetrڷr۷}rܷ(hgj׷hhjշubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rݷ}r޷(hgUhhjhiNhkjhm}r߷(hr]hq]ho]hp]ht]Uentries]r(jX,isNodeAuthorized() (in module CNReplication)hDUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX:isNodeAuthorized(session,targetNodeSubject,pid) -> booleanhhjhij6hkj "hm}r(hr]rhDaj"j%hq]ho]hp]ht]rhDaj"XisNodeAuthorizedrj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhij6hkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r(hgUhhjubaubj")r}r(hgjhhjhij6hkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXisNodeAuthorizedrr}r(hgUhhjubaubj'")r}r(hgXsession, targetNodeSubject, pidhhjhij6hkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r (hgXtargetNodeSubjecthm}r (ho]hp]hq]hr]ht]uhhjhb]r hXtargetNodeSubjectr r }r(hgUhhjubahkj5"ubj-")r}r(hgXpidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjhij6hkj9"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjhij6hkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r (h)r!}r"(hgXVerifies that a replication event was initiated by a CN by comparing the target node's identifiying subject with a known list of scheduled replication tasks.r#hhjhij6hkhhm}r$(ho]hp]hq]hr]ht]uhvKhwhhb]r%hXVerifies that a replication event was initiated by a CN by comparing the target node's identifiying subject with a known list of scheduled replication tasks.r&r'}r((hgj#hhj!ubaubh)r)}r*(hgXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.r+hhjhij6hkhhm}r,(ho]hp]hq]hr]ht]uhvKhwhhb]r-hXVSuccessful completion of the operation is indicated by returning a HTTP status of 200.r.r/}r0(hgj+hhj)ubaubh)r1}r2(hgXQFailure of the operation MUST be indicated by returning an appropriate exception.r3hhjhij6hkhhm}r4(ho]hp]hq]hr]ht]uhvKhwhhb]r5hXQFailure of the operation MUST be indicated by returning an appropriate exception.r6r7}r8(hgj3hhj1ubaubh)r9}r:(hgUhhjhiNhkhhm}r;(ho]hp]hq]hr]ht]uhvNhwhhb]r<(h)r=}r>(hgUhhj9hij6hkhhm}r?(ho]hp]hq]hr]ht]uhvKhwhhb]r@(h)rA}rB(hgXVersionhhj=hij6hkhhm}rC(ho]hp]hq]hr]ht]uhvKhb]rDhXVersionrErF}rG(hgUhhjAubaubh)rH}rI(hgX 1.0, (2.0)rJhm}rK(ho]hp]hq]hr]ht]uhhj=hb]rLh)rM}rN(hgjJhhjHhij6hkhhm}rO(ho]hp]hq]hr]ht]uhvKhb]rPhX 1.0, (2.0)rQrR}rS(hgjJhhjMubaubahkhubeubh)rT}rU(hgUhhj9hij6hkhhm}rV(ho]hp]hq]hr]ht]uhvKhwhhb]rW(h)rX}rY(hgXREST URLhhjThij6hkhhm}rZ(ho]hp]hq]hr]ht]uhvKhb]r[hXREST URLr\r]}r^(hgUhhjXubaubh)r_}r`(hgXJ``GET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}``rahm}rb(ho]hp]hq]hr]ht]uhhjThb]rch)rd}re(hgjahhj_hij6hkhhm}rf(ho]hp]hq]hr]ht]uhvKhb]rgj)rh}ri(hgjahm}rj(ho]hp]hq]hr]ht]uhhjdhb]rkhXFGET /replicaAuthorizations/{pid}?targetNodeSubject={targetNodeSubject}rlrm}rn(hgUhhjhubahkjubaubahkhubeubh)ro}rp(hgUhm}rq(ho]hp]hq]hr]ht]uhhj9hb]rr(h)rs}rt(hgX Parametershhjohij6hkhhm}ru(ho]hp]hq]hr]ht]uhvKhb]rvhX Parametersrwrx}ry(hgUhhjsubaubh)rz}r{(hgUhm}r|(ho]hp]hq]hr]ht]uhhjohb]r}j #)r~}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjzhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhij6hkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]rh)r}r¸(hgXtargetNodeSubject (Types.Subject) -- The subject that identifies the target node, with a value extracted from the X.509 certificate passed in during the call to MNReplication.replicate(). Transmitted as a URL query parameter, and so must be escaped accordingly.hm}rø(ho]hp]hq]hr]ht]uhhjhb]rĸ(j")rŸ}rƸ(hgXtargetNodeSubjecthm}rǸ(hr]hq]j"ho]hp]ht]uhhjhb]rȸhXtargetNodeSubjectrɸrʸ}r˸(hgUhhjŸubahkj"ubhX (r̸r͸}rθ(hgUhhjubj)rϸ}rи(hgX:class:`Types.Subject`rѸhhjhij6hkjhm}rҸ(UreftypeXclassjjX Types.SubjectU refdomainXpyrӸhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rԸj)rո}rָ(hgjѸhm}r׸(ho]hp]rظ(jjӸXpy-classrٸehq]hr]ht]uhhjϸhb]rڸhX Types.Subjectr۸rܸ}rݸ(hgUhhjոubahkjubaubhX)r޸}r߸(hgUhhjubhX -- rr}r(hgUhhjubhXThe subject that identifies the target node, with a value extracted from the X.509 certificate passed in during the call to MNReplication.replicate(). Transmitted as a URL query parameter, and so must be escaped accordingly.rr}r(hgXThe subject that identifies the target node, with a value extracted from the X.509 certificate passed in during the call to MNReplication.replicate(). Transmitted as a URL query parameter, and so must be escaped accordingly.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj~hb]rh)r}r(hgXpid (Types.Identifier) -- The identifier of the object to be replicated. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXpidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Identifier`rhhjhij6hkjhm}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.Identifierrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- r r }r (hgUhhjubhXsThe identifier of the object to be replicated. Transmitted as part of the URL path and must be escaped accordingly.r r }r(hgXsThe identifier of the object to be replicated. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj9hb]r(h)r}r(hgXReturnshhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXReturnsrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTrue on successhm}r (ho]hp]hq]hr]ht]uhhjhb]r!hXTrue on successr"r#}r$(hgXTrue on successhhjubahkhubahkhubehkhubh)r%}r&(hgUhm}r'(ho]hp]hq]hr]ht]uhhj9hb]r((h)r)}r*(hgX Return typehhj%hij6hkhhm}r+(ho]hp]hq]hr]ht]uhvKhb]r,hX Return typer-r.}r/(hgUhhj)ubaubh)r0}r1(hgUhm}r2(ho]hp]hq]hr]ht]uhhj%hb]r3h)r4}r5(hgXbooleanhm}r6(ho]hp]hq]hr]ht]uhhj0hb]r7j)r8}r9(hgUhm}r:(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhj4hb]r;hXbooleanr<r=}r>(hgUhhj8ubahkjubahkhubahkhubehkhubh)r?}r@(hgUhm}rA(ho]hp]hq]hr]ht]uhhj9hb]rB(h)rC}rD(hgXRaiseshhj?hij6hkhhm}rE(ho]hp]hq]hr]ht]uhvKhb]rFhXRaisesrGrH}rI(hgUhhjCubaubh)rJ}rK(hgUhm}rL(ho]hp]hq]hr]ht]uhhj?hb]rMj #)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhjJhb]rQ(j#)rR}rS(hgUhm}rT(ho]hp]hq]hr]ht]uhhjNhb]rUh)rV}rW(hgXiExceptions.NotImplemented -- (errorCode=501, detailCode=4870)The method functionality is not implemented.hm}rX(ho]hp]hq]hr]ht]uhhjRhb]rY(j)rZ}r[(hgUhm}r\(Ureftypej#j"U reftargetXExceptions.NotImplementedr]U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjVhb]r^j")r_}r`(hgj]hm}ra(ho]hp]hq]hr]ht]uhhjZhb]rbhXExceptions.NotImplementedrcrd}re(hgUhhj_ubahkj"ubahkjubhX -- rfrg}rh(hgUhhjVubh)ri}rj(hgX$``(errorCode=501, detailCode=4870)``rkhhjVhij6hkhhm}rl(ho]hp]hq]hr]ht]uhvKhb]rmj)rn}ro(hgjkhm}rp(ho]hp]hq]hr]ht]uhhjihb]rqhX (errorCode=501, detailCode=4870)rrrs}rt(hgUhhjnubahkjubaubh)ru}rv(hgX,The method functionality is not implemented.rwhhjVhij6hkhhm}rx(ho]hp]hq]hr]ht]uhvKhb]ryhX,The method functionality is not implemented.rzr{}r|(hgjwhhjuubaubehkhubahkj;#ubj#)r}}r~(hgUhm}r(ho]hp]hq]hr]ht]uhhjNhb]rh)r}r(hgXxExceptions.NotAuthorized -- (errorCode=401, detailCode=4871)Replication of PID is not authorized for the subject listed.hm}r(ho]hp]hq]hr]ht]uhhj}hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4871)``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4871)rr}r(hgUhhjubahkjubaubh)r}r(hgX<Replication of PID is not authorized for the subject listed.rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX<Replication of PID is not authorized for the subject listed.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjNhb]rh)r}r(hgX_Exceptions.ServiceFailure -- (errorCode=500, detailCode=4872)An internal server error occurred.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=500, detailCode=4872)``rhhjhij6hkhhm}r¹(ho]hp]hq]hr]ht]uhvKhb]rùj)rĹ}rŹ(hgjhm}rƹ(ho]hp]hq]hr]ht]uhhjhb]rǹhX (errorCode=500, detailCode=4872)rȹrɹ}rʹ(hgUhhjĹubahkjubaubh)r˹}r̹(hgX"An internal server error occurred.r͹hhjhij6hkhhm}rι(ho]hp]hq]hr]ht]uhvKhb]rϹhX"An internal server error occurred.rйrѹ}rҹ(hgj͹hhj˹ubaubehkhubahkj;#ubj#)rӹ}rԹ(hgUhm}rչ(ho]hp]hq]hr]ht]uhhjNhb]rֹh)r׹}rع(hgX`Exceptions.InvalidRequest -- (errorCode=400, detailCode=4873)The replication request is invalid.hm}rٹ(ho]hp]hq]hr]ht]uhhjӹhb]rڹ(j)r۹}rܹ(hgUhm}rݹ(Ureftypej#j"U reftargetXExceptions.InvalidRequestr޹U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj׹hb]r߹j")r}r(hgj޹hm}r(ho]hp]hq]hr]ht]uhhj۹hb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhj׹ubh)r}r(hgX$``(errorCode=400, detailCode=4873)``rhhj׹hij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4873)rr}r(hgUhhjubahkjubaubh)r}r(hgX#The replication request is invalid.rhhj׹hij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX#The replication request is invalid.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjNhb]rh)r}r(hgXdExceptions.NotFound -- (errorCode=404, detailCode=4874)The PID does not exist as an existing object.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundr U refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgj hm}r (ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=4874)``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=4874)rr}r (hgUhhjubahkjubaubh)r!}r"(hgX-The PID does not exist as an existing object.r#hhjhij6hkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r%hX-The PID does not exist as an existing object.r&r'}r((hgj#hhj!ubaubehkhubahkj;#ubj#)r)}r*(hgUhm}r+(ho]hp]hq]hr]ht]uhhjNhb]r,h)r-}r.(hgX^Exceptions.InvalidToken -- (errorCode=401, detailCode=4875)The session information is invalid.hm}r/(ho]hp]hq]hr]ht]uhhj)hb]r0(j)r1}r2(hgUhm}r3(Ureftypej#j"U reftargetXExceptions.InvalidTokenr4U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj-hb]r5j")r6}r7(hgj4hm}r8(ho]hp]hq]hr]ht]uhhj1hb]r9hXExceptions.InvalidTokenr:r;}r<(hgUhhj6ubahkj"ubahkjubhX -- r=r>}r?(hgUhhj-ubh)r@}rA(hgX$``(errorCode=401, detailCode=4875)``rBhhj-hij6hkhhm}rC(ho]hp]hq]hr]ht]uhvKhb]rDj)rE}rF(hgjBhm}rG(ho]hp]hq]hr]ht]uhhj@hb]rHhX (errorCode=401, detailCode=4875)rIrJ}rK(hgUhhjEubahkjubaubh)rL}rM(hgX#The session information is invalid.rNhhj-hij6hkhhm}rO(ho]hp]hq]hr]ht]uhvKhb]rPhX#The session information is invalid.rQrR}rS(hgjNhhjLubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rT}rU(hgUhhjhiNhkjhm}rV(hr]hq]ho]hp]ht]Uentries]rW(jX5deleteReplicationMetadata() (in module CNReplication)h/UNtrXauhvNhwhhb]ubj!)rY}rZ(hgUhhjhiNhkj!hm}r[(j"j"Xpyr\hr]hq]ho]hp]ht]j"Xfunctionr]j"j]uhvNhwhhb]r^(j")r_}r`(hgXFdeleteReplicationMetadata(session,pid,nodeId,serialVersion) -> booleanhhjYhiXHinternal padding after source/apis/generated/generated_CNReplication.txtrahkj "hm}rb(hr]rch/aj"j%hq]ho]hp]ht]rdh/aj"XdeleteReplicationMetadatarej"Uj"uhvM!hwhhb]rf(j")rg}rh(hgXCNReplication.hhj_hijahkj"hm}ri(ho]hp]hq]hr]ht]uhvM!hwhhb]rjhXCNReplication.rkrl}rm(hgUhhjgubaubj")rn}ro(hgjehhj_hijahkj!"hm}rp(ho]hp]hq]hr]ht]uhvM!hwhhb]rqhXdeleteReplicationMetadatarrrs}rt(hgUhhjnubaubj'")ru}rv(hgX#session, pid, nodeId, serialVersionhhj_hijahkj*"hm}rw(ho]hp]hq]hr]ht]uhvM!hwhhb]rx(j-")ry}rz(hgXsessionhm}r{(ho]hp]hq]hr]ht]uhhjuhb]r|hXsessionr}r~}r(hgUhhjyubahkj5"ubj-")r}r(hgXpidhm}r(ho]hp]hq]hr]ht]uhhjuhb]rhXpidrr}r(hgUhhjubahkj5"ubj-")r}r(hgXnodeIdhm}r(ho]hp]hq]hr]ht]uhhjuhb]rhXnodeIdrr}r(hgUhhjubahkj5"ubj-")r}r(hgX serialVersionhm}r(ho]hp]hq]hr]ht]uhhjuhb]rhX serialVersionrr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhj_hijahkj9"hm}r(ho]hp]hq]hr]ht]uhvM!hwhhb]rhXbooleanrr}r(hgUhhjubaubeubj?")r}r(hgUhhjYhijahkjB"hm}r(ho]hp]hq]hr]ht]uhvM!hwhhb]r(h)r}r(hgXoRemoves the replication information for the specified node from the object system metadata identified by *pid*.hhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]r(hXiRemoves the replication information for the specified node from the object system metadata identified by rr}r(hgXiRemoves the replication information for the specified node from the object system metadata identified by hhjubj$)r}r(hgX*pid*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkj$ubhX.r}r(hgX.hhjubeubh)r}r(hgXRemoval of replication metadata is necessary if the Member Node goes offline permanently or for an extended period, or when it is deeemed prudent to migrate an object from one node to another to address resource management issues.rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXRemoval of replication metadata is necessary if the Member Node goes offline permanently or for an extended period, or when it is deeemed prudent to migrate an object from one node to another to address resource management issues.rr}r(hgjhhjubaubh)r}r(hgX5This method can be only called by Coordinating Nodes.rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX5This method can be only called by Coordinating Nodes.rr}r(hgjhhjubaubh)r}r(hgUhhjhiNhkhhm}rº(ho]hp]hq]hr]ht]uhvNhwhhb]rú(h)rĺ}rź(hgUhhjhij6hkhhm}rƺ(ho]hp]hq]hr]ht]uhvKhwhhb]rǺ(h)rȺ}rɺ(hgXVersionhhjĺhij6hkhhm}rʺ(ho]hp]hq]hr]ht]uhvKhb]r˺hXVersionr̺rͺ}rκ(hgUhhjȺubaubh)rϺ}rк(hgX 1.0, (2.0)rѺhm}rҺ(ho]hp]hq]hr]ht]uhhjĺhb]rӺh)rԺ}rպ(hgjѺhhjϺhij6hkhhm}rֺ(ho]hp]hq]hr]ht]uhvKhb]r׺hX 1.0, (2.0)rغrٺ}rں(hgjѺhhjԺubaubahkhubeubh)rۺ}rܺ(hgUhhjhij6hkhhm}rݺ(ho]hp]hq]hr]ht]uhvKhwhhb]r޺(h)rߺ}r(hgXREST URLhhjۺhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjߺubaubh)r}r(hgX$``PUT /removeReplicaMetadata/{pid}``rhm}r(ho]hp]hq]hr]ht]uhhjۺhb]rh)r}r(hgjhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX PUT /removeReplicaMetadata/{pid}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Parametershhjhijahkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r(hgXsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session MUST be a Coordinating Node. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhj hb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhj hb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhj ubj)r}r(hgX:class:`Types.Session`rhhj hij6hkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]r j)r!}r"(hgjhm}r#(ho]hp]r$(jjXpy-classr%ehq]hr]ht]uhhjhb]r&hX Types.Sessionr'r(}r)(hgUhhj!ubahkjubaubhX)r*}r+(hgUhhj ubhX -- r,r-}r.(hgUhhj ubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session MUST be a Coordinating Node. Transmitted as part of the SSL handshake process.r/r0}r1(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session MUST be a Coordinating Node. Transmitted as part of the SSL handshake process.hhj ubehkhubahkj;#ubj#)r2}r3(hgUhm}r4(ho]hp]hq]hr]ht]uhhjhb]r5h)r6}r7(hgXpid (Types.Identifier) -- The identifier of the object whose replication metadata is being modified. Transmitted as part of the URL path and must be escaped accordingly.hm}r8(ho]hp]hq]hr]ht]uhhj2hb]r9(j")r:}r;(hgXpidhm}r<(hr]hq]j"ho]hp]ht]uhhj6hb]r=hXpidr>r?}r@(hgUhhj:ubahkj"ubhX (rArB}rC(hgUhhj6ubj)rD}rE(hgX:class:`Types.Identifier`rFhhj6hij6hkjhm}rG(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrHhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rIj)rJ}rK(hgjFhm}rL(ho]hp]rM(jjHXpy-classrNehq]hr]ht]uhhjDhb]rOhXTypes.IdentifierrPrQ}rR(hgUhhjJubahkjubaubhX)rS}rT(hgUhhj6ubhX -- rUrV}rW(hgUhhj6ubhXThe identifier of the object whose replication metadata is being modified. Transmitted as part of the URL path and must be escaped accordingly.rXrY}rZ(hgXThe identifier of the object whose replication metadata is being modified. Transmitted as part of the URL path and must be escaped accordingly.hhj6ubehkhubahkj;#ubj#)r[}r\(hgUhm}r](ho]hp]hq]hr]ht]uhhjhb]r^h)r_}r`(hgXnodeId (Types.NodeReference) -- The identifier of the node replication information that is being removed from the system metadata record. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}ra(ho]hp]hq]hr]ht]uhhj[hb]rb(j")rc}rd(hgXnodeIdhm}re(hr]hq]j"ho]hp]ht]uhhj_hb]rfhXnodeIdrgrh}ri(hgUhhjcubahkj"ubhX (rjrk}rl(hgUhhj_ubj)rm}rn(hgX:class:`Types.NodeReference`rohhj_hij6hkjhm}rp(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrqhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rrj)rs}rt(hgjohm}ru(ho]hp]rv(jjqXpy-classrwehq]hr]ht]uhhjmhb]rxhXTypes.NodeReferenceryrz}r{(hgUhhjsubahkjubaubhX)r|}r}(hgUhhj_ubhX -- r~r}r(hgUhhj_ubhXThe identifier of the node replication information that is being removed from the system metadata record. Transmitted as a UTF-8 String as a rr}r(hgXThe identifier of the node replication information that is being removed from the system metadata record. Transmitted as a UTF-8 String as a hhj_ubj$)r}r(hgX *Param part*hm}r(ho]hp]hq]hr]ht]uhhj_hb]rhX Param partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r(hgX% of the MIME multipart/mixed message.hhj_ubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX)serialVersion (unsigned long) -- The Types.SystemMetadata.serialVersion of the system metadata being updated. This MUST match the latest version of system metadata available for the object on the Coordinating Node. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgX serialVersionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhX serialVersionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgUhm}r(Ureftypej&j"U reftargetX unsigned longrU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjhb]rj&)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX unsigned longrr}r(hgUhhjubahkj&ubahkjubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXThe rr}r(hgXThe hhjubj)r}r(hgX*:attr:`Types.SystemMetadata.serialVersion`rhhjhij6hkjhm}r(UreftypeXattrjjX"Types.SystemMetadata.serialVersionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj%uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-attrrehq]hr]ht]uhhjhb]rhX"Types.SystemMetadata.serialVersionrr}r»(hgUhhjubahkjubaubhX of the system metadata being updated. This MUST match the latest version of system metadata available for the object on the Coordinating Node. Transmitted as a UTF-8 String as a rûrĻ}rŻ(hgX of the system metadata being updated. This MUST match the latest version of system metadata available for the object on the Coordinating Node. Transmitted as a UTF-8 String as a hhjubj$)rƻ}rǻ(hgX *Param part*hm}rȻ(ho]hp]hq]hr]ht]uhhjhb]rɻhX Param partrʻr˻}r̻(hgUhhjƻubahkj$ubhX% of the MIME multipart/mixed message.rͻrλ}rϻ(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)rл}rѻ(hgUhm}rһ(ho]hp]hq]hr]ht]uhhjhb]rӻ(h)rԻ}rջ(hgXReturnshhjлhijahkhhm}rֻ(ho]hp]hq]hr]ht]uhvKhb]r׻hXReturnsrػrٻ}rڻ(hgUhhjԻubaubh)rۻ}rܻ(hgUhm}rݻ(ho]hp]hq]hr]ht]uhhjлhb]r޻h)r߻}r(hgX:True if the replication metadata was successfully deleted.hm}r(ho]hp]hq]hr]ht]uhhjۻhb]rhX:True if the replication metadata was successfully deleted.rr}r(hgX:True if the replication metadata was successfully deleted.hhj߻ubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Return typehhjhijahkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Return typerr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXbooleanhm}r(ho]hp]hq]hr]ht]uhhjhb]rj)r}r(hgUhm}r(Ureftypej&j"U reftargetXbooleanU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjhb]rhXbooleanrr}r(hgUhhjubahkjubahkhubahkhubehkhubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgXRaiseshhjhijahkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr }r (hgUhhjubaubh)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj hb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXnExceptions.NotImplemented -- (errorCode=501, detailCode=4950)The method functionality if not fully implementedhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r }r!(hgjhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#hXExceptions.NotImplementedr$r%}r&(hgUhhj ubahkj"ubahkjubhX -- r'r(}r)(hgUhhjubh)r*}r+(hgX$``(errorCode=501, detailCode=4950)``r,hhjhij6hkhhm}r-(ho]hp]hq]hr]ht]uhvMhb]r.j)r/}r0(hgj,hm}r1(ho]hp]hq]hr]ht]uhhj*hb]r2hX (errorCode=501, detailCode=4950)r3r4}r5(hgUhhj/ubahkjubaubh)r6}r7(hgX1The method functionality if not fully implementedr8hhjhij6hkhhm}r9(ho]hp]hq]hr]ht]uhvMhb]r:hX1The method functionality if not fully implementedr;r<}r=(hgj8hhj6ubaubehkhubahkj;#ubj#)r>}r?(hgUhm}r@(ho]hp]hq]hr]ht]uhhjhb]rAh)rB}rC(hgXExceptions.ServiceFailure -- (errorCode=500, detailCode=4951)An internal server error occurred that prevented the operation from completing.hm}rD(ho]hp]hq]hr]ht]uhhj>hb]rE(j)rF}rG(hgUhm}rH(Ureftypej#j"U reftargetXExceptions.ServiceFailurerIU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjBhb]rJj")rK}rL(hgjIhm}rM(ho]hp]hq]hr]ht]uhhjFhb]rNhXExceptions.ServiceFailurerOrP}rQ(hgUhhjKubahkj"ubahkjubhX -- rRrS}rT(hgUhhjBubh)rU}rV(hgX$``(errorCode=500, detailCode=4951)``rWhhjBhij6hkhhm}rX(ho]hp]hq]hr]ht]uhvMhb]rYj)rZ}r[(hgjWhm}r\(ho]hp]hq]hr]ht]uhhjUhb]r]hX (errorCode=500, detailCode=4951)r^r_}r`(hgUhhjZubahkjubaubh)ra}rb(hgXOAn internal server error occurred that prevented the operation from completing.rchhjBhij6hkhhm}rd(ho]hp]hq]hr]ht]uhvM hb]rehXOAn internal server error occurred that prevented the operation from completing.rfrg}rh(hgjchhjaubaubehkhubahkj;#ubj#)ri}rj(hgUhm}rk(ho]hp]hq]hr]ht]uhhjhb]rlh)rm}rn(hgXaExceptions.InvalidRequest -- (errorCode=400, detailCode=4952)The request parameters are malformedhm}ro(ho]hp]hq]hr]ht]uhhjihb]rp(j)rq}rr(hgUhm}rs(Ureftypej#j"U reftargetXExceptions.InvalidRequestrtU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjmhb]ruj")rv}rw(hgjthm}rx(ho]hp]hq]hr]ht]uhhjqhb]ryhXExceptions.InvalidRequestrzr{}r|(hgUhhjvubahkj"ubahkjubhX -- r}r~}r(hgUhhjmubh)r}r(hgX$``(errorCode=400, detailCode=4952)``rhhjmhij6hkhhm}r(ho]hp]hq]hr]ht]uhvM hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4952)rr}r(hgUhhjubahkjubaubh)r}r(hgX$The request parameters are malformedrhhjmhij6hkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhX$The request parameters are malformedrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXZExceptions.InvalidToken -- (errorCode=401, detailCode=4953)The supplied session is invalidhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidTokenrU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidTokenrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4953)``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4953)rr}r(hgUhhjubahkjubaubh)r}r(hgXThe supplied session is invalidrhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rhXThe supplied session is invalidrr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r¼h)rü}rļ(hgXExceptions.NotFound -- (errorCode=404, detailCode=4956)The object identified by pid or the node reference specified by nodeId could not be located in the system metadata for the object.hm}rż(ho]hp]hq]hr]ht]uhhjhb]rƼ(j)rǼ}rȼ(hgUhm}rɼ(Ureftypej#j"U reftargetXExceptions.NotFoundrʼU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjühb]r˼j")r̼}rͼ(hgjʼhm}rμ(ho]hp]hq]hr]ht]uhhjǼhb]rϼhXExceptions.NotFoundrмrѼ}rҼ(hgUhhj̼ubahkj"ubahkjubhX -- rӼrԼ}rռ(hgUhhjüubh)rּ}r׼(hgX$``(errorCode=404, detailCode=4956)``rؼhhjühij6hkhhm}rټ(ho]hp]hq]hr]ht]uhvMhb]rڼj)rۼ}rܼ(hgjؼhm}rݼ(ho]hp]hq]hr]ht]uhhjּhb]r޼hX (errorCode=404, detailCode=4956)r߼r}r(hgUhhjۼubahkjubaubh)r}r(hgXThe object identified by *pid* or the node reference specified by *nodeId* could not be located in the system metadata for the object.hhjühij6hkhhm}r(ho]hp]hq]hr]ht]uhvMhb]r(hXThe object identified by rr}r(hgXThe object identified by hhjubj$)r}r(hgX*pid*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXpidrr}r(hgUhhjubahkj$ubhX$ or the node reference specified by rr}r(hgX$ or the node reference specified by hhjubj$)r}r(hgX*nodeId*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhXnodeIdrr}r(hgUhhjubahkj$ubhX< could not be located in the system metadata for the object.rr}r(hgX< could not be located in the system metadata for the object.hhjubeubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4954)The subject identified by the session information does not have appropriate priviledges for modifiying the content or accessing the service.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainj\hr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r }r (hgjhm}r (ho]hp]hq]hr]ht]uhhjhb]r hXExceptions.NotAuthorizedrr}r(hgUhhj ubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4954)``rhhjhij6hkhhm}r(ho]hp]hq]hr]ht]uhvMhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4954)rr}r(hgUhhjubahkjubaubh)r }r!(hgXThe subject identified by the *session* information does not have appropriate priviledges for modifiying the content or accessing the service.hhjhij6hkhhm}r"(ho]hp]hq]hr]ht]uhvMhb]r#(hXThe subject identified by the r$r%}r&(hgXThe subject identified by the hhj ubj$)r'}r((hgX *session*hm}r)(ho]hp]hq]hr]ht]uhhj hb]r*hXsessionr+r,}r-(hgUhhj'ubahkj$ubhXg information does not have appropriate priviledges for modifiying the content or accessing the service.r.r/}r0(hgXg information does not have appropriate priviledges for modifiying the content or accessing the service.hhj ubeubehkhubahkj;#ubj#)r1}r2(hgUhm}r3(ho]hp]hq]hr]ht]uhhjhb]r4h)r5}r6(hgXExceptions.VersionMismatch -- (errorCode=409, detailCode=4955)The serialVersion does not match the current Types.SystemMetadata.serialVersion value of the object system metadata.hm}r7(ho]hp]hq]hr]ht]uhhj1hb]r8(j)r9}r:(hgUhm}r;(Ureftypej#j"U reftargetXExceptions.VersionMismatchr<U refdomainj\hr]hq]U refexplicitho]hp]ht]uhhj5hb]r=j")r>}r?(hgj<hm}r@(ho]hp]hq]hr]ht]uhhj9hb]rAhXExceptions.VersionMismatchrBrC}rD(hgUhhj>ubahkj"ubahkjubhX -- rErF}rG(hgUhhj5ubh)rH}rI(hgX$``(errorCode=409, detailCode=4955)``rJhhj5hij6hkhhm}rK(ho]hp]hq]hr]ht]uhvMhb]rLj)rM}rN(hgjJhm}rO(ho]hp]hq]hr]ht]uhhjHhb]rPhX (errorCode=409, detailCode=4955)rQrR}rS(hgUhhjMubahkjubaubh)rT}rU(hgX~The *serialVersion* does not match the current :attr:`Types.SystemMetadata.serialVersion` value of the object system metadata.hhj5hij6hkhhm}rV(ho]hp]hq]hr]ht]uhvMhb]rW(hXThe rXrY}rZ(hgXThe hhjTubj$)r[}r\(hgX*serialVersion*hm}r](ho]hp]hq]hr]ht]uhhjThb]r^hX serialVersionr_r`}ra(hgUhhj[ubahkj$ubhX does not match the current rbrc}rd(hgX does not match the current hhjTubj)re}rf(hgX*:attr:`Types.SystemMetadata.serialVersion`rghhjThij6hkjhm}rh(UreftypeXattrjjX"Types.SystemMetadata.serialVersionU refdomainXpyrihr]hq]U refexplicitho]hp]ht]jjjNjj%uhvMhb]rjj)rk}rl(hgjghm}rm(ho]hp]rn(jjiXpy-attrroehq]hr]ht]uhhjehb]rphX"Types.SystemMetadata.serialVersionrqrr}rs(hgUhhjkubahkjubaubhX% value of the object system metadata.rtru}rv(hgX% value of the object system metadata.hhjTubeubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rw}rx(hgUhhjhihjhkj!hm}ry(j#j$hr]hq]ho]hp]ht]uhvKyhwhhb]ubj93)rz}r{(hgUhhjhiNhkj<3hm}r|(ho]hp]hq]hr]ht]uhvNhwhhb]r}(h)r~}r(hgXsThis old stuff is commented out but kept here for revisiting later .. function:: getDefaultReplicationPolicy (sess)rhhjzhihjhkhhm}r(ho]hp]hq]hr]ht]uhvK{hb]rhXsThis old stuff is commented out but kept here for revisiting later .. function:: getDefaultReplicationPolicy (sess)rr}r(hgjhhj~ubaubj)r}r(hgUhm}r(hr]hq]ho]hp]ht]Uentries]r(jX.getMNReplicateList() (in module CNReplication)h=UNtrauhhjzhb]hkjubj!)r}r(hgUhhjzhkj!hm}r(j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionrj"juhwhhb]r(j")r}r(hgXgetMNReplicateList()hhjhihjhkj "hm}r(hr]rh=aj"j%hq]ho]hp]ht]rh=aj"XgetMNReplicateListrj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhihjhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r(hgUhhjubaubj")r}r(hgjhhjhihjhkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXgetMNReplicateListrr}r(hgUhhjubaubj'")r}r(hgUhhjhihjhkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj?")r}r(hgUhhjhihjhkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj)r}r(hgUhm}r(hr]hq]ho]hp]ht]Uentries]r(jX0getReplicationPolicy() (in module CNReplication)h*UNtrauhhjzhb]hkjubj!)r}r(hgUhhjzhkj!hm}r(j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionrj"juhwhhb]r(j")r}r(hgXgetReplicationPolicy (sess, ID)hhjhihjhkj "hm}r(hr]rh*aj"j%hq]ho]hp]ht]rh*aj"XgetReplicationPolicyrj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhihjhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r½(hgUhhjubaubj")rý}rĽ(hgjhhjhihjhkj!"hm}rŽ(ho]hp]hq]hr]ht]uhvKhwhhb]rƽhXgetReplicationPolicyrǽrȽ}rɽ(hgUhhjýubaubj'")rʽ}r˽(hgXsess, IDhhjhihjhkj*"hm}r̽(ho]hp]hq]hr]ht]uhvKhwhhb]rͽ(j-")rν}rϽ(hgXsesshm}rн(ho]hp]hq]hr]ht]uhhjʽhb]rѽhXsessrҽrӽ}rԽ(hgUhhjνubahkj5"ubj-")rս}rֽ(hgXIDhm}r׽(ho]hp]hq]hr]ht]uhhjʽhb]rؽhXIDrٽrڽ}r۽(hgUhhjսubahkj5"ubeubeubj?")rܽ}rݽ(hgUhhjhihjhkjB"hm}r޽(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj)r߽}r(hgUhm}r(hr]hq]ho]hp]ht]Uentries]r(jX/isReplicationNeeded() (in module CNReplication)hJUNtrauhhjzhb]hkjubj!)r}r(hgUhhjzhkj!hm}r(j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionrj"juhwhhb]r(j")r}r(hgXisReplicationNeeded ()hhjhihjhkj "hm}r(hr]rhJaj"j%hq]ho]hp]ht]rhJaj"XisReplicationNeededrj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhihjhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r(hgUhhjubaubj")r}r(hgjhhjhihjhkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXisReplicationNeededrr}r(hgUhhjubaubj'")r}r(hgUhhjhihjhkj*"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj?")r}r(hgUhhjhihjhkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj)r}r(hgUhm}r(hr]hq]ho]hp]ht]Uentries]r(jX-replicateMetadata() (in module CNReplication)h:UNtrauhhjzhb]hkjubj!)r }r (hgUhhjzhkj!hm}r (j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionr j"j uhwhhb]r (j")r}r(hgXreplicateMetadata ()hhj hihjhkj "hm}r(hr]rh:aj"j%hq]ho]hp]ht]rh:aj"XreplicateMetadatarj"Uj"uhvKhwhhb]r(j")r}r(hgXCNReplication.hhjhihjhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXCNReplication.rr}r(hgUhhjubaubj")r}r(hgjhhjhihjhkj!"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXreplicateMetadatar r!}r"(hgUhhjubaubj'")r#}r$(hgUhhjhihjhkj*"hm}r%(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj?")r&}r'(hgUhhj hihjhkjB"hm}r((ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj)r)}r*(hgUhm}r+(hr]hq]ho]hp]ht]Uentries]r,(jX7setDefaultReplicationPolicy() (in module CNReplication)hUNtr-auhhjzhb]hkjubj!)r.}r/(hgUhhjzhkj!hm}r0(j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionr1j"j1uhwhhb]r2(j")r3}r4(hgX*setDefaultReplicationPolicy (sess, policy)hhj.hihjhkj "hm}r5(hr]r6haj"j%hq]ho]hp]ht]r7haj"XsetDefaultReplicationPolicyr8j"Uj"uhvKhwhhb]r9(j")r:}r;(hgXCNReplication.hhj3hihjhkj"hm}r<(ho]hp]hq]hr]ht]uhvKhwhhb]r=hXCNReplication.r>r?}r@(hgUhhj:ubaubj")rA}rB(hgj8hhj3hihjhkj!"hm}rC(ho]hp]hq]hr]ht]uhvKhwhhb]rDhXsetDefaultReplicationPolicyrErF}rG(hgUhhjAubaubj'")rH}rI(hgX sess, policyhhj3hihjhkj*"hm}rJ(ho]hp]hq]hr]ht]uhvKhwhhb]rK(j-")rL}rM(hgXsesshm}rN(ho]hp]hq]hr]ht]uhhjHhb]rOhXsessrPrQ}rR(hgUhhjLubahkj5"ubj-")rS}rT(hgXpolicyhm}rU(ho]hp]hq]hr]ht]uhhjHhb]rVhXpolicyrWrX}rY(hgUhhjSubahkj5"ubeubeubj?")rZ}r[(hgUhhj.hihjhkjB"hm}r\(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubj)r]}r^(hgUhm}r_(hr]hq]ho]hp]ht]Uentries]r`(jX0setReplicationPolicy() (in module CNReplication)X"CNReplication.setReplicationPolicyUNtraauhhjzhb]hkjubj!)rb}rc(hgUhhjzhkj!hm}rd(j"j"Xpyhr]hq]ho]hp]ht]j"Xfunctionrej"jeuhwhhb]rf(j")rg}rh(hgX'setReplicationPolicy (sess, policy, ID)hhjbhihjhkj "hm}ri(hr]j"j%hq]ho]hp]ht]j"XsetReplicationPolicyrjj"Uj"uhvKhwhhb]rk(j")rl}rm(hgXCNReplication.hhjghihjhkj"hm}rn(ho]hp]hq]hr]ht]uhvKhwhhb]rohXCNReplication.rprq}rr(hgUhhjlubaubj")rs}rt(hgjjhhjghihjhkj!"hm}ru(ho]hp]hq]hr]ht]uhvKhwhhb]rvhXsetReplicationPolicyrwrx}ry(hgUhhjsubaubj'")rz}r{(hgXsess, policy, IDhhjghihjhkj*"hm}r|(ho]hp]hq]hr]ht]uhvKhwhhb]r}(j-")r~}r(hgXsesshm}r(ho]hp]hq]hr]ht]uhhjzhb]rhXsessrr}r(hgUhhj~ubahkj5"ubj-")r}r(hgXpolicyhm}r(ho]hp]hq]hr]ht]uhhjzhb]rhXpolicyrr}r(hgUhhjubahkj5"ubj-")r}r(hgXIDhm}r(ho]hp]hq]hr]ht]uhhjzhb]rhXIDrr}r(hgUhhjubahkj5"ubeubeubj?")r}r(hgUhhjbhihjhkjB"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]ubeubeubeubhd)r}r(hgUhhhehihjhkhlhm}r(ho]hp]hq]hr]r(Xmodule-CNRegisterrhaeht]rhKauhvKhwhhb]r(hy)r}r(hgX Register APIrhhjhihjhkh}hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX Register APIrr}r(hgjhhjubaubj)r}r(hgUhhjhihjhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jXCNRegister (module)Xmodule-CNRegisterUNtrauhvNhwhhb]ubh)r}r(hgXnThe register API methods are used to maintain a registry of nodes participating in the DataONE infrastructure.rhhjhihjhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXnThe register API methods are used to maintain a registry of nodes participating in the DataONE infrastructure.rr}r(hgjhhjubaubh)r}r(hgXNote that the node registry is much the same as the Object collection with a restriction on the returned object formats to be Member Nodes or Coordinating Nodes. It may be prudent for the implementation of the registration API to leverage the existing functionality of the object collection rather than implementing a parallel data store. In this case, the "science metadata" could be a DC description of the node, and the "data" might be the detailed registration information including node capabilities, scheduling and so forth.rhhjhihjhkhhm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhXNote that the node registry is much the same as the Object collection with a restriction on the returned object formats to be Member Nodes or Coordinating Nodes. It may be prudent for the implementation of the registration API to leverage the existing functionality of the object collection rather than implementing a parallel data store. In this case, the "science metadata" could be a DC description of the node, and the "data" might be the detailed registration information including node capabilities, scheduling and so forth.rr}r(hgjhhjubaubj)r}r(hgXBWarning: this file is automatically generated. Edits will be losthhjhijX.source/apis/generated/generated_CNRegister.txtrr}rbhkj!hm}r(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]rhXBWarning: this file is automatically generated. Edits will be lostrr¾}rþ(hgUhhjubaubj))rľ}rž(hgUhhjhiNhkj,hm}rƾ(ho]hp]hq]hr]rǾUid9rȾaht]uhvNhwhhb]rɾ(hy)rʾ}r˾(hgX&Functions defined in :mod:`CNRegister`hm}r̾(ho]hp]hq]hr]ht]uhhjľhb]r;(hXFunctions defined in rξrϾ}rо(hgXFunctions defined in hhjʾubj)rѾ}rҾ(hgX:mod:`CNRegister`rӾhhjʾhijhkjhm}rԾ(UreftypeXmodjjX CNRegisterU refdomainXpyrվhr]hq]U refexplicitho]hp]ht]jjjNjX CNRegisterr־uhvKhb]r׾j)rؾ}rپ(hgjӾhm}rھ(ho]hp]r۾(jjվXpy-modrܾehq]hr]ht]uhhjѾhb]rݾhX CNRegisterr޾r߾}r(hgUhhjؾubahkjubaubehkh}ubj9)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolsKuhhjľhb]r(j>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthK uhhjhb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthK uhhjhb]hkjBubj>)r}r(hgUhm}r(hr]hq]ho]hp]ht]UcolwidthKuhhjhb]hkjBubjO)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rjT)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(jY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTierrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXTierrr}r(hgjhhjubaubahkjfubjY)r}r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r h)r }r (hgXVersionrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXVersionrr}r(hgjhhj ubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXRESTrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK hb]rhXRESTrr}r(hgjhhjubaubahkjfubjY)r }r!(hgUhm}r"(ho]hp]hq]hr]ht]uhhjhb]r#h)r$}r%(hgXFunctionr&hhj hijhkhhm}r'(ho]hp]hq]hr]ht]uhvK hb]r(hXFunctionr)r*}r+(hgj&hhj$ubaubahkjfubjY)r,}r-(hgUhm}r.(ho]hp]hq]hr]ht]uhhjhb]r/h)r0}r1(hgX Parametersr2hhj,hijhkhhm}r3(ho]hp]hq]hr]ht]uhvK hb]r4hX Parametersr5r6}r7(hgj2hhj0ubaubahkjfubehkjubahkjubj)r8}r9(hgUhm}r:(ho]hp]hq]hr]ht]uhhjhb]r;(jT)r<}r=(hgUhm}r>(ho]hp]hq]hr]ht]uhhj8hb]r?(jY)r@}rA(hgUhm}rB(ho]hp]hq]hr]ht]uhhj<hb]rCh)rD}rE(hgXTier 2rFhhj@hijhkhhm}rG(ho]hp]hq]hr]ht]uhvKhb]rHhXTier 2rIrJ}rK(hgjFhhjDubaubahkjfubjY)rL}rM(hgUhm}rN(ho]hp]hq]hr]ht]uhhj<hb]rOh)rP}rQ(hgX1.0, 2.0rRhhjLhijhkhhm}rS(ho]hp]hq]hr]ht]uhvKhb]rThX1.0, 2.0rUrV}rW(hgjRhhjPubaubahkjfubjY)rX}rY(hgUhm}rZ(ho]hp]hq]hr]ht]uhhj<hb]r[h)r\}r](hgX``PUT /node/{nodeid}``r^hhjXhijhkhhm}r_(ho]hp]hq]hr]ht]uhvKhb]r`j)ra}rb(hgj^hm}rc(ho]hp]hq]hr]ht]uhhj\hb]rdhXPUT /node/{nodeid}rerf}rg(hgUhhjaubahkjubaubahkjfubjY)rh}ri(hgUhm}rj(ho]hp]hq]hr]ht]uhhj<hb]rkh)rl}rm(hgX:func:`updateNodeCapabilities`rnhhjhhijhkhhm}ro(ho]hp]hq]hr]ht]uhvKhb]rpj)rq}rr(hgjnhhjlhijhkjhm}rs(UreftypeXfuncjjXupdateNodeCapabilitiesU refdomainXpyrthr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]ruj)rv}rw(hgjnhm}rx(ho]hp]ry(jjtXpy-funcrzehq]hr]ht]uhhjqhb]r{hXupdateNodeCapabilities()r|r}}r~(hgUhhjvubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj<hb]rh)r}r(hgXq(:class:`session`, :class:`nodeid`, :class:`node`) ``->`` booleanrhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX$:class:`nodeid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnodeidrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnoderr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r¿(ho]hp]hq]hr]ht]uhhjhb]rÿhX->rĿrſ}rƿ(hgUhhjubahkjubhX booleanrǿrȿ}rɿ(hgX booleanhhjubeubahkjfubehkjubjT)rʿ}r˿(hgUhm}r̿(ho]hp]hq]hr]ht]uhhj8hb]rͿ(jY)rο}rϿ(hgUhm}rп(ho]hp]hq]hr]ht]uhhjʿhb]rѿh)rҿ}rӿ(hgXTier 2rԿhhjοhijhkhhm}rտ(ho]hp]hq]hr]ht]uhvKhb]rֿhXTier 2r׿rؿ}rٿ(hgjԿhhjҿubaubahkjfubjY)rڿ}rۿ(hgUhm}rܿ(ho]hp]hq]hr]ht]uhhjʿhb]rݿh)r޿}r߿(hgX1.0, 2.0rhhjڿhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX1.0, 2.0rr}r(hgjhhj޿ubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjʿhb]rh)r}r(hgX``GET /node/{nodeid}``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /node/{nodeid}rr}r(hgUhhjubahkjubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjʿhb]rh)r}r(hgX:func:`getNodeCapabilities`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rj)r}r(hgjhhjhijhkjhm}r(UreftypeXfuncjjXgetNodeCapabilitiesU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-funcrehq]hr]ht]uhhjhb]r hXgetNodeCapabilities()r r }r (hgUhhjubahkjubaubaubahkjfubjY)r }r(hgUhm}r(ho]hp]hq]hr]ht]uhhjʿhb]rh)r}r(hgXA(:class:`nodeid`) ``->`` :class:`Types.Node`rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX$:class:`nodeid`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r (ho]hp]r!(jjXpy-classr"ehq]hr]ht]uhhjhb]r#hXnodeidr$r%}r&(hgUhhjubahkjubaubhX) r'r(}r)(hgX) hhjubj)r*}r+(hgX``->``hm}r,(ho]hp]hq]hr]ht]uhhjhb]r-hX->r.r/}r0(hgUhhj*ubahkjubhX r1}r2(hgX hhjubj)r3}r4(hgX:class:`Types.Node`r5hhjhijhkjhm}r6(UreftypeXclassjjX Types.NodeU refdomainXpyr7hr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]r8j)r9}r:(hgj5hm}r;(ho]hp]r<(jj7Xpy-classr=ehq]hr]ht]uhhj3hb]r>hX Types.Noder?r@}rA(hgUhhj9ubahkjubaubeubahkjfubehkjubjT)rB}rC(hgUhm}rD(ho]hp]hq]hr]ht]uhhj8hb]rE(jY)rF}rG(hgUhm}rH(ho]hp]hq]hr]ht]uhhjBhb]rIh)rJ}rK(hgXTier 2rLhhjFhijhkhhm}rM(ho]hp]hq]hr]ht]uhvKhb]rNhXTier 2rOrP}rQ(hgjLhhjJubaubahkjfubjY)rR}rS(hgUhm}rT(ho]hp]hq]hr]ht]uhhjBhb]rUh)rV}rW(hgX1.0, 2.0rXhhjRhijhkhhm}rY(ho]hp]hq]hr]ht]uhvKhb]rZhX1.0, 2.0r[r\}r](hgjXhhjVubaubahkjfubjY)r^}r_(hgUhm}r`(ho]hp]hq]hr]ht]uhhjBhb]rah)rb}rc(hgX``POST /node``rdhhj^hijhkhhm}re(ho]hp]hq]hr]ht]uhvKhb]rfj)rg}rh(hgjdhm}ri(ho]hp]hq]hr]ht]uhhjbhb]rjhX POST /noderkrl}rm(hgUhhjgubahkjubaubahkjfubjY)rn}ro(hgUhm}rp(ho]hp]hq]hr]ht]uhhjBhb]rqh)rr}rs(hgX:func:`register`rthhjnhijhkhhm}ru(ho]hp]hq]hr]ht]uhvKhb]rvj)rw}rx(hgjthhjrhijhkjhm}ry(UreftypeXfuncjjXregisterU refdomainXpyrzhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]r{j)r|}r}(hgjthm}r~(ho]hp]r(jjzXpy-funcrehq]hr]ht]uhhjwhb]rhX register()rr}r(hgUhhj|ubahkjubaubaubahkjfubjY)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjBhb]rh)r}r(hgX`(:class:`session`, :class:`node`) ``->`` :class:`Types.NodeReference`rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]r(hX(r}r(hgX(hhjubj)r}r(hgX:class:`session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkjubaubhX, rr}r(hgX, hhjubj)r}r(hgX:class:`node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXnoderr}r(hgUhhjubahkjubaubhX) rr}r(hgX) hhjubj)r}r(hgX``->``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX->rr}r(hgUhhjubahkjubhX r}r(hgX hhjubj)r}r(hgX:class:`Types.NodeReference`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.NodeReferencerr}r(hgUhhjubahkjubaubeubahkjfubehkjubehkjubehkjubeubj)r}r(hgUhhjhiNhkjhm}r(hr]hq]ho]hp]ht]Uentries]r(jX/updateNodeCapabilities() (in module CNRegister)hUNtrauhvNhwhhb]ubj!)r}r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX6updateNodeCapabilities(session,nodeid,node) -> booleanhhjhijhkj "hm}r(hr]rhaj"j־hq]ho]hp]ht]rhaj"XupdateNodeCapabilitiesrj"Uj"uhvKOhwhhb]r(j")r}r(hgX CNRegister.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvKOhwhhb]rhX CNRegister.rr}r(hgUhhjubaubj")r}r(hgjhhjhijhkj!"hm}r(ho]hp]hq]hr]ht]uhvKOhwhhb]rhXupdateNodeCapabilitiesrr}r(hgUhhjubaubj'")r}r(hgXsession, nodeid, nodehhjhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvKOhwhhb]r(j-")r}r(hgXsessionhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj5"ubj-")r}r(hgXnodeidhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXnodeidrr}r(hgUhhjubahkj5"ubj-")r}r(hgXnodehm}r(ho]hp]hq]hr]ht]uhhjhb]rhXnoderr}r(hgUhhjubahkj5"ubeubj6")r}r(hgXbooleanhhjhijhkj9"hm}r(ho]hp]hq]hr]ht]uhvKOhwhhb]rhXbooleanr r }r (hgUhhjubaubeubj?")r }r (hgUhhjhijhkjB"hm}r(ho]hp]hq]hr]ht]uhvKOhwhhb]r(h)r}r(hgXWFor updating the capabilities of the specified node. Most information is replaced by information in the new node, however, the node identifier, nodeType, ping, syncrhonization.lastHarvested, and synchronization.lastCompleteHarvest are preserved from the existing entry. Services in the old record not included in the new Node will be removed.rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvK#hwhhb]rhXWFor updating the capabilities of the specified node. Most information is replaced by information in the new node, however, the node identifier, nodeType, ping, syncrhonization.lastHarvested, and synchronization.lastCompleteHarvest are preserved from the existing entry. Services in the old record not included in the new Node will be removed.rr}r(hgjhhjubaubh)r}r(hgX[Successful completion of this operation is indicated by a HTTP response status code of 200.rhhj hijhkhhm}r(ho]hp]hq]hr]ht]uhvK%hwhhb]rhX[Successful completion of this operation is indicated by a HTTP response status code of 200.rr}r(hgjhhjubaubh)r }r!(hgXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.r"hhj hijhkhhm}r#(ho]hp]hq]hr]ht]uhvK'hwhhb]r$hXbUnsuccessful completion of this operation MUST be indicated by returning an appropriate exception.r%r&}r'(hgj"hhj ubaubh)r(}r)(hgX<v2.0: The structure of :class:`v2_0.Types.Node` has changed.hhj hijhkhhm}r*(ho]hp]hq]hr]ht]uhvK)hwhhb]r+(hXv2.0: The structure of r,r-}r.(hgXv2.0: The structure of hhj(ubj)r/}r0(hgX:class:`v2_0.Types.Node`r1hhj(hijhkjhm}r2(UreftypeXclassjjXv2_0.Types.NodeU refdomainXpyr3hr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK)hb]r4j)r5}r6(hgj1hm}r7(ho]hp]r8(jj3Xpy-classr9ehq]hr]ht]uhhj/hb]r:hXv2_0.Types.Noder;r<}r=(hgUhhj5ubahkjubaubhX has changed.r>r?}r@(hgX has changed.hhj(ubeubh)rA}rB(hgUhhj hiNhkhhm}rC(ho]hp]hq]hr]ht]uhvNhwhhb]rD(h)rE}rF(hgUhhjAhijhkhhm}rG(ho]hp]hq]hr]ht]uhvK+hwhhb]rH(h)rI}rJ(hgXVersionhhjEhijhkhhm}rK(ho]hp]hq]hr]ht]uhvKhb]rLhXVersionrMrN}rO(hgUhhjIubaubh)rP}rQ(hgX1.0, 2.0rRhm}rS(ho]hp]hq]hr]ht]uhhjEhb]rTh)rU}rV(hgjRhhjPhijhkhhm}rW(ho]hp]hq]hr]ht]uhvK+hb]rXhX1.0, 2.0rYrZ}r[(hgjRhhjUubaubahkhubeubh)r\}r](hgUhhjAhijhkhhm}r^(ho]hp]hq]hr]ht]uhvK,hwhhb]r_(h)r`}ra(hgXREST URLhhj\hijhkhhm}rb(ho]hp]hq]hr]ht]uhvKhb]rchXREST URLrdre}rf(hgUhhj`ubaubh)rg}rh(hgX``PUT /node/{nodeid}``rihm}rj(ho]hp]hq]hr]ht]uhhj\hb]rkh)rl}rm(hgjihhjghijhkhhm}rn(ho]hp]hq]hr]ht]uhvK,hb]roj)rp}rq(hgjihm}rr(ho]hp]hq]hr]ht]uhhjlhb]rshXPUT /node/{nodeid}rtru}rv(hgUhhjpubahkjubaubahkhubeubh)rw}rx(hgUhm}ry(ho]hp]hq]hr]ht]uhhjAhb]rz(h)r{}r|(hgX Parametershhjwhijhkhhm}r}(ho]hp]hq]hr]ht]uhvKhb]r~hX Parametersrr}r(hgUhhj{ubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjwhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK.hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK-hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXnodeid (Types.NodeReference) -- The identifier of the existing node entry being updated. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXnodeidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXnodeidrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.NodeReference`rhhjhijhkjhm}r(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK1hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXTypes.NodeReferencerr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhX}The identifier of the existing node entry being updated. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgX}The identifier of the existing node entry being updated. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXnode (Types.Node) -- An instance of :class`Types.Node` that contains the updated information. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXnodehm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXnoderr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK4hb]rj)r}r(hgjhm}r(ho]hp]r (jjXpy-classr ehq]hr]ht]uhhjhb]r hX Types.Noder r }r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXAn instance of :class`Types.Node` that contains the updated information. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rr}r(hgXAn instance of :class`Types.Node` that contains the updated information. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)r}r(hgX *File part*hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX File partrr}r(hgUhhjubahkj$ubhX% of the MIME multipart/mixed message.rr}r (hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)r!}r"(hgUhm}r#(ho]hp]hq]hr]ht]uhhjAhb]r$(h)r%}r&(hgXReturnshhj!hijhkhhm}r'(ho]hp]hq]hr]ht]uhvKhb]r(hXReturnsr)r*}r+(hgUhhj%ubaubh)r,}r-(hgUhm}r.(ho]hp]hq]hr]ht]uhhj!hb]r/h)r0}r1(hgXTrue if operation is successfulhm}r2(ho]hp]hq]hr]ht]uhhj,hb]r3hXTrue if operation is successfulr4r5}r6(hgXTrue if operation is successfulhhj0ubahkhubahkhubehkhubh)r7}r8(hgUhm}r9(ho]hp]hq]hr]ht]uhhjAhb]r:(h)r;}r<(hgX Return typehhj7hijhkhhm}r=(ho]hp]hq]hr]ht]uhvKhb]r>hX Return typer?r@}rA(hgUhhj;ubaubh)rB}rC(hgUhm}rD(ho]hp]hq]hr]ht]uhhj7hb]rEh)rF}rG(hgXbooleanhm}rH(ho]hp]hq]hr]ht]uhhjBhb]rIj)rJ}rK(hgUhm}rL(Ureftypej&j"U reftargetXbooleanU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjFhb]rMhXbooleanrNrO}rP(hgUhhjJubahkjubahkhubahkhubehkhubh)rQ}rR(hgUhm}rS(ho]hp]hq]hr]ht]uhhjAhb]rT(h)rU}rV(hgXRaiseshhjQhijhkhhm}rW(ho]hp]hq]hr]ht]uhvKhb]rXhXRaisesrYrZ}r[(hgUhhjUubaubh)r\}r](hgUhm}r^(ho]hp]hq]hr]ht]uhhjQhb]r_j #)r`}ra(hgUhm}rb(ho]hp]hq]hr]ht]uhhj\hb]rc(j#)rd}re(hgUhm}rf(ho]hp]hq]hr]ht]uhhj`hb]rgh)rh}ri(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4820)The service is not implemented.hm}rj(ho]hp]hq]hr]ht]uhhjdhb]rk(j)rl}rm(hgUhm}rn(Ureftypej#j"U reftargetXExceptions.NotImplementedroU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhhb]rpj")rq}rr(hgjohm}rs(ho]hp]hq]hr]ht]uhhjlhb]rthXExceptions.NotImplementedrurv}rw(hgUhhjqubahkj"ubahkjubhX -- rxry}rz(hgUhhjhubh)r{}r|(hgX$``(errorCode=501, detailCode=4820)``r}hhjhhijhkhhm}r~(ho]hp]hq]hr]ht]uhvK9hb]rj)r}r(hgj}hm}r(ho]hp]hq]hr]ht]uhhj{hb]rhX (errorCode=501, detailCode=4820)rr}r(hgUhhjubahkjubaubh)r}r(hgXThe service is not implemented.rhhjhhijhkhhm}r(ho]hp]hq]hr]ht]uhvK;hb]rhXThe service is not implemented.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj`hb]rh)r}r(hgXExceptions.NotAuthorized -- (errorCode=401, detailCode=4821)The Subject does not have authority to modify the node registration information.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=401, detailCode=4821)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK=hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4821)rr}r(hgUhhjubahkjubaubh)r}r(hgXXThe :term:`Subject` does not have authority to modify the node registration information.hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvK?hb]r(hXThe rr}r(hgXThe hhjubj)r}r(hgX:term:`Subject`rhhjhijhkjhm}r(UreftypeXtermjjXsubjectU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvK?hb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhXSubjectrr}r(hgUhhjubahkji2ubaubhXE does not have authority to modify the node registration information.rr}r(hgXE does not have authority to modify the node registration information.hhjubeubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj`hb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4822)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4822)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4822)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj`hb]rh)r}r(hgXWExceptions.InvalidRequest -- (errorCode=400, detailCode=4823)The request was malformed.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=400, detailCode=4823)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKChb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4823)r r }r (hgUhhjubahkjubaubh)r }r (hgXThe request was malformed.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKEhb]rhXThe request was malformed.rr}r(hgjhhj ubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj`hb]rh)r}r(hgXmExceptions.NotFound -- (errorCode=404, detailCode=4824)The requested nodeid is not available in the registry.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]r j")r!}r"(hgjhm}r#(ho]hp]hq]hr]ht]uhhjhb]r$hXExceptions.NotFoundr%r&}r'(hgUhhj!ubahkj"ubahkjubhX -- r(r)}r*(hgUhhjubh)r+}r,(hgX$``(errorCode=404, detailCode=4824)``r-hhjhijhkhhm}r.(ho]hp]hq]hr]ht]uhvKGhb]r/j)r0}r1(hgj-hm}r2(ho]hp]hq]hr]ht]uhhj+hb]r3hX (errorCode=404, detailCode=4824)r4r5}r6(hgUhhj0ubahkjubaubh)r7}r8(hgX6The requested nodeid is not available in the registry.r9hhjhijhkhhm}r:(ho]hp]hq]hr]ht]uhvKIhb]r;hX6The requested nodeid is not available in the registry.r<r=}r>(hgj9hhj7ubaubehkhubahkj;#ubj#)r?}r@(hgUhm}rA(ho]hp]hq]hr]ht]uhhj`hb]rBh)rC}rD(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4825)hm}rE(ho]hp]hq]hr]ht]uhhj?hb]rF(j)rG}rH(hgUhm}rI(Ureftypej#j"U reftargetXExceptions.InvalidTokenrJU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjChb]rKj")rL}rM(hgjJhm}rN(ho]hp]hq]hr]ht]uhhjGhb]rOhXExceptions.InvalidTokenrPrQ}rR(hgUhhjLubahkj"ubahkjubhX -- rSrT}rU(hgUhhjCubj)rV}rW(hgX$``(errorCode=401, detailCode=4825)``hm}rX(ho]hp]hq]hr]ht]uhhjChb]rYhX (errorCode=401, detailCode=4825)rZr[}r\(hgUhhjVubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r]}r^(hgUhhjhiNhkjhm}r_(hr]hq]ho]hp]ht]Uentries]r`(jX,getNodeCapabilities() (in module CNRegister)hIUNtraauhvNhwhhb]ubj!)rb}rc(hgUhhjhiNhkj!hm}rd(j"j"Xpyrehr]hq]ho]hp]ht]j"Xfunctionrfj"jfuhvNhwhhb]rg(j")rh}ri(hgX#getNodeCapabilities(nodeid) -> Nodehhjbhijhkj "hm}rj(hr]rkhIaj"j־hq]ho]hp]ht]rlhIaj"XgetNodeCapabilitiesrmj"Uj"uhvKnhwhhb]rn(j")ro}rp(hgX CNRegister.hhjhhijhkj"hm}rq(ho]hp]hq]hr]ht]uhvKnhwhhb]rrhX CNRegister.rsrt}ru(hgUhhjoubaubj")rv}rw(hgjmhhjhhijhkj!"hm}rx(ho]hp]hq]hr]ht]uhvKnhwhhb]ryhXgetNodeCapabilitiesrzr{}r|(hgUhhjvubaubj'")r}}r~(hgXnodeidhhjhhijhkj*"hm}r(ho]hp]hq]hr]ht]uhvKnhwhhb]rj-")r}r(hgXnodeidhm}r(ho]hp]hq]hr]ht]uhhj}hb]rhXnodeidrr}r(hgUhhjubahkj5"ubaubj6")r}r(hgXNodehhjhhijhkj9"hm}r(ho]hp]hq]hr]ht]uhvKnhwhhb]rhXNoderr}r(hgUhhjubaubeubj?")r}r(hgUhhjbhijhkjB"hm}r(ho]hp]hq]hr]ht]uhvKnhwhhb]r(h)r}r(hgXpFor retrieving the capabilities of the specified node if it is registered on the Coordinating Node being called.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKRhwhhb]rhXpFor retrieving the capabilities of the specified node if it is registered on the Coordinating Node being called.rr}r(hgjhhjubaubh)r}r(hgX<v2.0: The structure of :class:`v2_0.Types.Node` has changed.hhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKThwhhb]r(hXv2.0: The structure of rr}r(hgXv2.0: The structure of hhjubj)r}r(hgX:class:`v2_0.Types.Node`rhhjhijhkjhm}r(UreftypeXclassjjXv2_0.Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKThb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhXv2_0.Types.Noderr}r(hgUhhjubahkjubaubhX has changed.rr}r(hgX has changed.hhjubeubh)r}r(hgUhhjhiNhkhhm}r(ho]hp]hq]hr]ht]uhvNhwhhb]r(h)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKVhwhhb]r(h)r}r(hgXVersionhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX1.0, 2.0rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKVhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKWhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX``GET /node/{nodeid}``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKWhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXGET /node/{nodeid}rr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXnodeid (Types.NodeReference) -- The identifier of the existing node entry being looked up. Transmitted as part of the URL path and must be escaped accordingly.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXnodeidhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXnodeidrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.NodeReference`r hhjhijhkjhm}r (UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyr hr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKYhb]r j)r }r(hgj hm}r(ho]hp]r(jj Xpy-classrehq]hr]ht]uhhjhb]rhXTypes.NodeReferencerr}r(hgUhhj ubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXThe identifier of the existing node entry being looked up. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hgXThe identifier of the existing node entry being looked up. Transmitted as part of the URL path and must be escaped accordingly.hhjubehkhubahkhubehkhubh)r}r(hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]r!(h)r"}r#(hgXReturnshhjhijhkhhm}r$(ho]hp]hq]hr]ht]uhvKhb]r%hXReturnsr&r'}r((hgUhhj"ubaubh)r)}r*(hgUhm}r+(ho]hp]hq]hr]ht]uhhjhb]r,h)r-}r.(hgXEAn instance of :class`Types.Node` that contains the Node information.hm}r/(ho]hp]hq]hr]ht]uhhj)hb]r0hXEAn instance of :class`Types.Node` that contains the Node information.r1r2}r3(hgXEAn instance of :class`Types.Node` that contains the Node information.hhj-ubahkhubahkhubehkhubh)r4}r5(hgUhm}r6(ho]hp]hq]hr]ht]uhhjhb]r7(h)r8}r9(hgX Return typehhj4hijhkhhm}r:(ho]hp]hq]hr]ht]uhvKhb]r;hX Return typer<r=}r>(hgUhhj8ubaubh)r?}r@(hgUhm}rA(ho]hp]hq]hr]ht]uhhj4hb]rBh)rC}rD(hgX Types.Nodehm}rE(ho]hp]hq]hr]ht]uhhj?hb]rFj)rG}rH(hgX:class:`Types.Node`rIhhjChijhkjhm}rJ(UreftypeXclassjjX Types.NodeU refdomainXpyrKhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK\hb]rLj)rM}rN(hgjIhm}rO(ho]hp]rP(jjKXpy-classrQehq]hr]ht]uhhjGhb]rRhX Types.NoderSrT}rU(hgUhhjMubahkjubaubahkhubahkhubehkhubh)rV}rW(hgUhm}rX(ho]hp]hq]hr]ht]uhhjhb]rY(h)rZ}r[(hgXRaiseshhjVhijhkhhm}r\(ho]hp]hq]hr]ht]uhvKhb]r]hXRaisesr^r_}r`(hgUhhjZubaubh)ra}rb(hgUhm}rc(ho]hp]hq]hr]ht]uhhjVhb]rdj #)re}rf(hgUhm}rg(ho]hp]hq]hr]ht]uhhjahb]rh(j#)ri}rj(hgUhm}rk(ho]hp]hq]hr]ht]uhhjehb]rlh)rm}rn(hgX\Exceptions.NotImplemented -- (errorCode=501, detailCode=4826)The service is not implemented.hm}ro(ho]hp]hq]hr]ht]uhhjihb]rp(j)rq}rr(hgUhm}rs(Ureftypej#j"U reftargetXExceptions.NotImplementedrtU refdomainjehr]hq]U refexplicitho]hp]ht]uhhjmhb]ruj")rv}rw(hgjthm}rx(ho]hp]hq]hr]ht]uhhjqhb]ryhXExceptions.NotImplementedrzr{}r|(hgUhhjvubahkj"ubahkjubhX -- r}r~}r(hgUhhjmubh)r}r(hgX$``(errorCode=501, detailCode=4826)``rhhjmhijhkhhm}r(ho]hp]hq]hr]ht]uhvK^hb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=4826)rr}r(hgUhhjubahkjubaubh)r}r(hgXThe service is not implemented.rhhjmhijhkhhm}r(ho]hp]hq]hr]ht]uhvK`hb]rhXThe service is not implemented.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4827)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjehr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4827)``hm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4827)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgXWExceptions.InvalidRequest -- (errorCode=400, detailCode=4828)The request was malformed.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjehr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=400, detailCode=4828)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKdhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4828)rr}r(hgUhhjubahkjubaubh)r}r(hgXThe request was malformed.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKfhb]rhXThe request was malformed.rr}r(hgjhhjubaubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjehb]rh)r}r(hgXmExceptions.NotFound -- (errorCode=404, detailCode=4829)The requested nodeid is not available in the registry.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotFoundrU refdomainjehr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotFoundrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubh)r}r(hgX$``(errorCode=404, detailCode=4829)``rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=404, detailCode=4829)rr}r(hgUhhjubahkjubaubh)r}r(hgX6The requested nodeid is not available in the registry.rhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKjhb]rhX6The requested nodeid is not available in the registry.rr}r(hgjhhjubaubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)r}r (hgUhhjhiNhkjhm}r (hr]hq]ho]hp]ht]Uentries]r (jX!register() (in module CNRegister)hUNtr auhvNhwhhb]ubj!)r }r(hgUhhjhiNhkj!hm}r(j"j"Xpyrhr]hq]ho]hp]ht]j"Xfunctionrj"juhvNhwhhb]r(j")r}r(hgX'register(session,node) -> NodeReferencehhj hiXEinternal padding after source/apis/generated/generated_CNRegister.txtrhkj "hm}r(hr]rhaj"j־hq]ho]hp]ht]rhaj"Xregisterrj"Uj"uhvKhwhhb]r(j")r}r(hgX CNRegister.hhjhijhkj"hm}r(ho]hp]hq]hr]ht]uhvKhwhhb]rhX CNRegister.rr }r!(hgUhhjubaubj")r"}r#(hgjhhjhijhkj!"hm}r$(ho]hp]hq]hr]ht]uhvKhwhhb]r%hXregisterr&r'}r((hgUhhj"ubaubj'")r)}r*(hgX session, nodehhjhijhkj*"hm}r+(ho]hp]hq]hr]ht]uhvKhwhhb]r,(j-")r-}r.(hgXsessionhm}r/(ho]hp]hq]hr]ht]uhhj)hb]r0hXsessionr1r2}r3(hgUhhj-ubahkj5"ubj-")r4}r5(hgXnodehm}r6(ho]hp]hq]hr]ht]uhhj)hb]r7hXnoder8r9}r:(hgUhhj4ubahkj5"ubeubj6")r;}r<(hgX NodeReferencehhjhijhkj9"hm}r=(ho]hp]hq]hr]ht]uhvKhwhhb]r>hX NodeReferencer?r@}rA(hgUhhj;ubaubeubj?")rB}rC(hgUhhj hijhkjB"hm}rD(ho]hp]hq]hr]ht]uhvKhwhhb]rE(h)rF}rG(hgX|Register a new node in the system. If the node already exists, then a :exc:`IdentifierNotUnique` exception MUST be returned.rHhhjBhijhkhhm}rI(ho]hp]hq]hr]ht]uhvKqhwhhb]rJ(hXFRegister a new node in the system. If the node already exists, then a rKrL}rM(hgXFRegister a new node in the system. If the node already exists, then a hhjFubj)rN}rO(hgX:exc:`IdentifierNotUnique`rPhhjFhijhkjhm}rQ(UreftypeXexcjjXIdentifierNotUniqueU refdomainXpyrRhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKqhb]rSj)rT}rU(hgjPhm}rV(ho]hp]rW(jjRXpy-excrXehq]hr]ht]uhhjNhb]rYhXIdentifierNotUniquerZr[}r\(hgUhhjTubahkjubaubhX exception MUST be returned.r]r^}r_(hgX exception MUST be returned.hhjFubeubh)r`}ra(hgX<v2.0: The structure of :class:`v2_0.Types.Node` has changed.rbhhjBhijhkhhm}rc(ho]hp]hq]hr]ht]uhvKshwhhb]rd(hXv2.0: The structure of rerf}rg(hgXv2.0: The structure of hhj`ubj)rh}ri(hgX:class:`v2_0.Types.Node`rjhhj`hijhkjhm}rk(UreftypeXclassjjXv2_0.Types.NodeU refdomainXpyrlhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKshb]rmj)rn}ro(hgjjhm}rp(ho]hp]rq(jjlXpy-classrrehq]hr]ht]uhhjhhb]rshXv2_0.Types.Nodertru}rv(hgUhhjnubahkjubaubhX has changed.rwrx}ry(hgX has changed.hhj`ubeubh)rz}r{(hgUhhjBhiNhkhhm}r|(ho]hp]hq]hr]ht]uhvNhwhhb]r}(h)r~}r(hgUhhjzhijhkhhm}r(ho]hp]hq]hr]ht]uhvKuhwhhb]r(h)r}r(hgXVersionhhj~hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXVersionrr}r(hgUhhjubaubh)r}r(hgX1.0, 2.0rhm}r(ho]hp]hq]hr]ht]uhhj~hb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKuhb]rhX1.0, 2.0rr}r(hgjhhjubaubahkhubeubh)r}r(hgUhhjzhijhkhhm}r(ho]hp]hq]hr]ht]uhvKvhwhhb]r(h)r}r(hgXREST URLhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXREST URLrr}r(hgUhhjubaubh)r}r(hgX``POST /node``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgjhhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKvhb]rj)r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX POST /noderr}r(hgUhhjubahkjubaubahkhubeubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjzhb]r(h)r}r(hgX Parametershhjhijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhX Parametersrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXTsession (Types.Session) -- Session information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the public user if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXsessionhm}r(hr]hq]j"ho]hp]ht]uhhjhb]rhXsessionrr}r(hgUhhjubahkj"ubhX (rr}r(hgUhhjubj)r}r(hgX:class:`Types.Session`rhhjhijhkjhm}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKxhb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Sessionrr}r(hgUhhjubahkjubaubhX)r}r(hgUhhjubhX -- rr}r(hgUhhjubhXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the rr}r(hgXSession information that contains the identity of the calling user as retrieved from the X.509 certificate which must be traceable to the CILogon service. The subject of the session defaults to the hhjubj)r}r(hgX:term:`public user`rhhjhijhkjhm}r(UreftypeXtermjjX public userU refdomainXstdrhr]hq]U refexplicitho]hp]ht]jjuhvKwhb]rj`2)r}r(hgjhm}r(ho]hp]r(jjXstd-termrehq]hr]ht]uhhjhb]rhX public userrr}r(hgUhhjubahkji2ubaubhXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rr}r(hgXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hhjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXAnode (Types.Node) -- An instance of Types.Node that fully describes the node being registered. Note that some attributes will be set by the Coordinating Node. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a File part of the MIME multipart/mixed message.hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j")r}r(hgXnodehm}r(hr]hq]j"ho]hp]ht]uhhjhb]r hXnoder r }r (hgUhhjubahkj"ubhX (r r}r(hgUhhjubj)r}r(hgX:class:`Types.Node`rhhjhijhkjhm}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK{hb]rj)r}r(hgjhm}r(ho]hp]r(jjXpy-classrehq]hr]ht]uhhjhb]rhX Types.Noderr}r(hgUhhjubahkjubaubhX)r}r (hgUhhjubhX -- r!r"}r#(hgUhhjubhXAn instance of r$r%}r&(hgXAn instance of hhjubj)r'}r((hgX:class:`Types.Node`r)hhjhijhkjhm}r*(UreftypeXclassjjX Types.NodeU refdomainXpyr+hr]hq]U refexplicitho]hp]ht]jjjNjj־uhvKzhb]r,j)r-}r.(hgj)hm}r/(ho]hp]r0(jj+Xpy-classr1ehq]hr]ht]uhhj'hb]r2hX Types.Noder3r4}r5(hgUhhj-ubahkjubaubhX that fully describes the node being registered. Note that some attributes will be set by the Coordinating Node. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r6r7}r8(hgX that fully describes the node being registered. Note that some attributes will be set by the Coordinating Node. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hhjubj$)r9}r:(hgX *File part*hm}r;(ho]hp]hq]hr]ht]uhhjhb]r<hX File partr=r>}r?(hgUhhj9ubahkj$ubhX% of the MIME multipart/mixed message.r@rA}rB(hgX% of the MIME multipart/mixed message.hhjubehkhubahkj;#ubehkj#ubahkhubehkhubh)rC}rD(hgUhm}rE(ho]hp]hq]hr]ht]uhhjzhb]rF(h)rG}rH(hgXReturnshhjChijhkhhm}rI(ho]hp]hq]hr]ht]uhvKhb]rJhXReturnsrKrL}rM(hgUhhjGubaubh)rN}rO(hgUhm}rP(ho]hp]hq]hr]ht]uhhjChb]rQh)rR}rS(hgXQThe identifier of the new node entry if successful, otherwise an error is raised.hm}rT(ho]hp]hq]hr]ht]uhhjNhb]rUhXQThe identifier of the new node entry if successful, otherwise an error is raised.rVrW}rX(hgXQThe identifier of the new node entry if successful, otherwise an error is raised.rYhhjRubahkhubahkhubehkhubh)rZ}r[(hgUhm}r\(ho]hp]hq]hr]ht]uhhjzhb]r](h)r^}r_(hgX Return typehhjZhijhkhhm}r`(ho]hp]hq]hr]ht]uhvKhb]rahX Return typerbrc}rd(hgUhhj^ubaubh)re}rf(hgUhm}rg(ho]hp]hq]hr]ht]uhhjZhb]rhh)ri}rj(hgXTypes.NodeReferencehm}rk(ho]hp]hq]hr]ht]uhhjehb]rlj)rm}rn(hgX:class:`Types.NodeReference`rohhjihijhkjhm}rp(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrqhr]hq]U refexplicitho]hp]ht]jjjNjj־uhvK~hb]rrj)rs}rt(hgjohm}ru(ho]hp]rv(jjqXpy-classrwehq]hr]ht]uhhjmhb]rxhXTypes.NodeReferenceryrz}r{(hgUhhjsubahkjubaubahkhubahkhubehkhubh)r|}r}(hgUhm}r~(ho]hp]hq]hr]ht]uhhjzhb]r(h)r}r(hgXRaiseshhj|hijhkhhm}r(ho]hp]hq]hr]ht]uhvKhb]rhXRaisesrr}r(hgUhhjubaubh)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhj|hb]rj #)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]r(j#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4840)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotImplementedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotImplementedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=501, detailCode=4840)``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=501, detailCode=4840)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4841)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.NotAuthorizedrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.NotAuthorizedrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=401, detailCode=4841)``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=401, detailCode=4841)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4842)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.ServiceFailurerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.ServiceFailurerr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=500, detailCode=4842)``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=500, detailCode=4842)rr}r(hgUhhjubahkjubehkhubahkj;#ubj#)r}r(hgUhm}r(ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4843)hm}r(ho]hp]hq]hr]ht]uhhjhb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.InvalidRequestrU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.InvalidRequestrr}r(hgUhhjubahkj"ubahkjubhX -- rr}r(hgUhhjubj)r}r(hgX$``(errorCode=400, detailCode=4843)``rhm}r(ho]hp]hq]hr]ht]uhhjhb]rhX (errorCode=400, detailCode=4843)rr }r (hgUhhjubahkjubehkhubahkj;#ubj#)r }r (hgUhm}r (ho]hp]hq]hr]ht]uhhjhb]rh)r}r(hgXBExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=4844)hm}r(ho]hp]hq]hr]ht]uhhj hb]r(j)r}r(hgUhm}r(Ureftypej#j"U reftargetXExceptions.IdentifierNotUniquerU refdomainjhr]hq]U refexplicitho]hp]ht]uhhjhb]rj")r}r(hgjhm}r(ho]hp]hq]hr]ht]uhhjhb]rhXExceptions.IdentifierNotUniquerr}r(hgUhhjubahkj"ubahkjubhX -- rr }r!(hgUhhjubj)r"}r#(hgX$``(errorCode=409, detailCode=4844)``r$hm}r%(ho]hp]hq]hr]ht]uhhjhb]r&hX (errorCode=409, detailCode=4844)r'r(}r)(hgUhhj"ubahkjubehkhubahkj;#ubj#)r*}r+(hgUhm}r,(ho]hp]hq]hr]ht]uhhjhb]r-h)r.}r/(hgX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4845)hm}r0(ho]hp]hq]hr]ht]uhhj*hb]r1(j)r2}r3(hgUhm}r4(Ureftypej#j"U reftargetXExceptions.InvalidTokenr5U refdomainjhr]hq]U refexplicitho]hp]ht]uhhj.hb]r6j")r7}r8(hgj5hm}r9(ho]hp]hq]hr]ht]uhhj2hb]r:hXExceptions.InvalidTokenr;r<}r=(hgUhhj7ubahkj"ubahkjubhX -- r>r?}r@(hgUhhj.ubj)rA}rB(hgX$``(errorCode=401, detailCode=4845)``rChm}rD(ho]hp]hq]hr]ht]uhhj.hb]rEhX (errorCode=401, detailCode=4845)rFrG}rH(hgUhhjAubahkjubehkhubahkj;#ubehkj#ubahkhubehkhubeubeubeubj)rI}rJ(hgX xxxx notes xxxx .. function:: addNodeCapabilities (nodeID, capabilities) -> boolean Adds the supplied capabilities to the system metadata describing the Member Node. :param nodeID: A PID that identifies the Member Node. :param capabilities: A capabilities document that describes the resources and supported services of the Member Node. :returns: True if the operation succeeds :rtype: Boolean .. function:: register (token, capabilitiesURL) -> boolean Used to register a new Member Node. :param token: An authentication token with priviledges to rgister a new Member Node. :param capabilitiesURL: The URL from which capabilities will be retrieved. :raises exceptions.NotAuthorized: The supplied identity does not have authority to register a node. :raises Exceptions.NotFound: The supplied capabilitiesURL does not resolve to a capabilities document :rtype: Boolean :returns: True if the registration operation succeeds .. function:: registerForNotification (token, dataOwnerID) .. function:: verifyCapabilities (nodeID, capabilities) -> boolean Evaluates the supplied capabilities document. This may involve additional interaction with the MN as various aspects are evaluated. .. todo:: The :func:`verifyCapabilities` will need to check functionality of the MN so need to define a few service hooks for checking these properties. State of Health API ~~~~~~~~~~~~~~~~~~~ The Health API contains methods for determining the status of the DataONE infrastructure, including both the CNs and MNs. .. module:: CN_health :synopsis: Methods for reporting on the state of health of a CN and on the entire DataONE infrastructure :: generateReport(token) -> statusReport .. function:: actOnPendingEvent (event) .. function:: reportPendingEvent (event) .. function:: Admin Application .. function:: notify (adminID, nodeID, service) .. function:: generateReport(token) -> statusReport Returns a status report for all of the registered Member Nodes. The informatio returned is used to give administrators information necessary to maintain the infrastructure. .. note:: This method is used by Use Case 10 "MN Status Reports" for V0.3. However instead of a complete set of detailed status reports, the V0.3 implementation of the use case will utilize the ``MN_health.heartbeat()`` method to compile very basic information about the MNs. Later versions of this method will use the richer ``MN_health.getStatus(token)`` method. :param token: Identity with authority to generate reports. :rtype: Status report, ideally in XML + stylsheet or at least XHTML.hhjhihjhkj!hm}rK(j#j$hr]hq]ho]hp]ht]uhvKhwhhb]rLhX xxxx notes xxxx .. function:: addNodeCapabilities (nodeID, capabilities) -> boolean Adds the supplied capabilities to the system metadata describing the Member Node. :param nodeID: A PID that identifies the Member Node. :param capabilities: A capabilities document that describes the resources and supported services of the Member Node. :returns: True if the operation succeeds :rtype: Boolean .. function:: register (token, capabilitiesURL) -> boolean Used to register a new Member Node. :param token: An authentication token with priviledges to rgister a new Member Node. :param capabilitiesURL: The URL from which capabilities will be retrieved. :raises exceptions.NotAuthorized: The supplied identity does not have authority to register a node. :raises Exceptions.NotFound: The supplied capabilitiesURL does not resolve to a capabilities document :rtype: Boolean :returns: True if the registration operation succeeds .. function:: registerForNotification (token, dataOwnerID) .. function:: verifyCapabilities (nodeID, capabilities) -> boolean Evaluates the supplied capabilities document. This may involve additional interaction with the MN as various aspects are evaluated. .. todo:: The :func:`verifyCapabilities` will need to check functionality of the MN so need to define a few service hooks for checking these properties. State of Health API ~~~~~~~~~~~~~~~~~~~ The Health API contains methods for determining the status of the DataONE infrastructure, including both the CNs and MNs. .. module:: CN_health :synopsis: Methods for reporting on the state of health of a CN and on the entire DataONE infrastructure :: generateReport(token) -> statusReport .. function:: actOnPendingEvent (event) .. function:: reportPendingEvent (event) .. function:: Admin Application .. function:: notify (adminID, nodeID, service) .. function:: generateReport(token) -> statusReport Returns a status report for all of the registered Member Nodes. The informatio returned is used to give administrators information necessary to maintain the infrastructure. .. note:: This method is used by Use Case 10 "MN Status Reports" for V0.3. However instead of a complete set of detailed status reports, the V0.3 implementation of the use case will utilize the ``MN_health.heartbeat()`` method to compile very basic information about the MNs. Later versions of this method will use the richer ``MN_health.getStatus(token)`` method. :param token: Identity with authority to generate reports. :rtype: Status report, ideally in XML + stylsheet or at least XHTML.rMrN}rO(hgUhhjIubaubeubeubahgUU transformerrPNU footnote_refsrQ}rRUrefnamesrS}rT(jI:]rUjF:aX xmlstarlet]rVj/:auUsymbol_footnotesrW]rXUautofootnote_refsrY]rZUsymbol_footnote_refsr[]r\U citationsr]]r^hwhU current_liner_NUtransform_messagesr`]racdocutils.nodes system_message rb)rc}rd(hgUhm}re(ho]UlevelKhr]hq]Usourcej)hp]ht]UtypeUINFOrfuhb]rgh)rh}ri(hgUhm}rj(ho]hp]hq]hr]ht]uhhjchb]rkhX-Hyperlink target "index-0" is not referenced.rlrm}rn(hgUhhjhubahkhubahkUsystem_messageroubaUreporterrpNUid_startrqK U autofootnotesrr]rsU citation_refsrt}ruUindirect_targetsrv]rwUsettingsrx(cdocutils.frontend Values ryorz}r{(Ufootnote_backlinksr|KUrecord_dependenciesr}NU rfc_base_urlr~Uhttps://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrjfU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh}NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerhjUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]Ufile_insertion_enabledrU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hajh]ja:h jhjh j*_h j(hjhMj)hj\hjrjIwjY:)r}r(hgUhhjEwhihjhkj]:hm}r(ho]hr]rjIwahq]Uismodhp]ht]uhvNhwhhb]ubh jh^j}h#j|h%j17h)jh*jh,johj*hj7h1j%h8jdh;j3h6jSihAjuhCjjjY:)r}r(hgUhhjhihjhkj]:hm}r(ho]hr]rjahq]Uismodhp]ht]uhvNhwhhb]ubhLjjUjY:)r}r(hgUhhjUhihjhkj]:hm}r(ho]hr]rjUahq]Uismodhp]ht]uhvNhwhhb]ubhjyhj@hjMhXjZ:jAj=jȾjľj4}j0}jjjUjUjwjwjjj")j)j/j*jBjBj}jY:)r}r(hgUhhj}hihjhkj]:hm}r(ho]hr]rj}ahq]Uismodhp]ht]uhvNhwhhb]ubhIjhh4jgPhjj jY:)r}r(hgUhhjhihjhkj]:hm}r(ho]hr]rj ahq]Uismodhp]ht]uhvNhwhhb]ubjjY:)r}r(hgUhhjhihjhkj]:hm}r(ho]hr]rjahq]Uismodhp]ht]uhvNhwhhb]ubhjm8h jFgjjY:)r}r(hgUhhjhihjhkj]:hm}r(ho]hr]rjahq]Uismodhp]ht]uhvNhwhhb]ubh/j_h_jh$jhjh jq:h"jGhjah'jy{hj h-j'hZjh[j)h5jjoj)jY:)r}r(hgUhhj)hihjhkj]:hm}r(ho]hr]rj)ahq]Uismodhp]ht]uhvNhwhhb]ubh9jRhjChJjhDjhj&Dh?jh`heh:jh0jshjNhj3hjKhYjEwh\jhWjUh+j!mh.j hj h3j "h7jIh@j#hEj=uUsubstitution_namesr}rhkhwhm}r(ho]hr]hq]Usourcehjhp]ht]uU footnotesr]rUrefidsr}rjB]rjBasub.