cdocutils.nodes document q)q}q(U nametypesq}q(X storage apiqNXread apiqNXd1_instance_generatorqXMNAuthorization.isAuthorizedq XMNRead.getSystemMetadataq XMNStorage.archiveq XMNStorage.updateq X package apiq NXMNRead.getChecksumqXMNCore.getLogRecordsqXmember node apisqNXMNQuery.listQueryEnginesqXMNPackage.getPackageqX xmlstarletqX MNView.viewqXview apiqNX query apiqNXMNReplication.replicateqXMNRead.synchronizationFailedqXcore apiqNX MNRead.getqXMNRead.getReplicaqXMNRead.listObjectsqXMNStorage.updateSystemMetadataqXMNView.listViewsqX!MNQuery.getQueryEngineDescriptionqXreplication apiq NXMNStorage.createq!X MNQuery.queryq"X MNCore.pingq#Xmime multipart/form-dataq$Xauthorization apiq%NXMNRead.systemMetadataChangedq&XMNRead.describeq'XMNStorage.generateIdentifierq(XMNCore.getCapabilitiesq)XMNStorage.deleteq*uUsubstitution_defsq+}q,Uparse_messagesq-]q.Ucurrent_sourceq/NU decorationq0NUautofootnote_startq1KUnameidsq2}q3(hU storage-apiq4hUread-apiq5hUd1-instance-generatorq6h h h h h h h h h U package-apiq7hhhhhUmember-node-apisq8hhhhhU xmlstarletq9hhhUview-apiq:hU query-apiq;hhhhhUcore-apiqh%Uauthorization-apiq?h&h&h'h'h(h(h)h)h*h*uUchildrenq@]qAcdocutils.nodes section qB)qC}qD(U rawsourceqEUUparentqFhUsourceqGXa/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/apis/MN_APIs.txtqHUtagnameqIUsectionqJU attributesqK}qL(UdupnamesqM]UclassesqN]UbackrefsqO]UidsqP]qQh8aUnamesqR]qShauUlineqTKUdocumentqUhh@]qV(cdocutils.nodes title qW)qX}qY(hEXMember Node APIsqZhFhChGhHhIUtitleq[hK}q\(hM]hN]hO]hP]hR]uhTKhUhh@]q]cdocutils.nodes Text q^XMember Node APIsq_q`}qa(hEhZhFhXubaubcdocutils.nodes paragraph qb)qc}qd(hEXThe service interfaces described here are exposed through the Member Node REST interface to support interactions with Coordinating Nodes and DataONE clients.qehFhChGhHhIU paragraphqfhK}qg(hM]hN]hO]hP]hR]uhTKhUhh@]qhh^XThe service interfaces described here are exposed through the Member Node REST interface to support interactions with Coordinating Nodes and DataONE clients.qiqj}qk(hEhehFhcubaubhb)ql}qm(hEXKThe following table provides a list of API methods exposed by Member Nodes.qnhFhChGhHhIhfhK}qo(hM]hN]hO]hP]hR]uhTKhUhh@]qph^XKThe following table provides a list of API methods exposed by Member Nodes.qqqr}qs(hEhnhFhlubaubcdocutils.nodes field_list qt)qu}qv(hEUhFhChGhHhIU field_listqwhK}qx(hM]hN]hO]hP]hR]uhTK hUhh@]qy(cdocutils.nodes field qz)q{}q|(hEUhFhuhGhHhIUfieldq}hK}q~(hM]hN]hO]hP]hR]uhTK hUhh@]q(cdocutils.nodes field_name q)q}q(hEXTierqhFh{hGhHhIU field_nameqhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XTierqq}q(hEhhFhubaubcdocutils.nodes field_body q)q}q(hEX'The tier in which a method is grouped. hK}q(hM]hN]hO]hP]hR]uhFh{h@]qhb)q}q(hEX&The tier in which a method is grouped.qhFhhGhHhIhfhK}q(hM]hN]hO]hP]hR]uhTK h@]qh^X&The tier in which a method is grouped.qq}q(hEhhFhubaubahIU field_bodyqubeubhz)q}q(hEUhFhuhGhHhIh}hK}q(hM]hN]hO]hP]hR]uhTKhUhh@]q(h)q}q(hEXVersionqhFhhGhHhIhhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XVersionqq}q(hEhhFhubaubh)q}q(hEXVersion 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. hK}q(hM]hN]hO]hP]hR]uhFhh@]qhb)q}q(hEXVersion 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.qhFhhGhHhIhfhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XVersion 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.qq}q(hEhhFhubaubahIhubeubhz)q}q(hEUhFhuhGhHhIh}hK}q(hM]hN]hO]hP]hR]uhTKhUhh@]q(h)q}q(hEXRESTqhFhhGhHhIhhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XRESTqq}q(hEhhFhubaubh)q}q(hEXThe 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. hK}q(hM]hN]hO]hP]hR]uhFhh@]qhb)q}q(hEXThe 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.qhFhhGhHhIhfhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XThe 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(hEhhFhubaubahIhubeubhz)q}q(hEUhFhuhGhHhIh}hK}q(hM]hN]hO]hP]hR]uhTKhUhh@]q(h)q}q(hEXFunctionqhFhhGhHhIhhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^XFunctionqхq}q(hEhhFhubaubh)q}q(hEX4The function name, associated with an API grouping. hK}q(hM]hN]hO]hP]hR]uhFhh@]qhb)q}q(hEX3The function name, associated with an API grouping.qhFhhGhHhIhfhK}q(hM]hN]hO]hP]hR]uhTK!h@]qh^X3The function name, associated with an API grouping.q݅q}q(hEhhFhubaubahIhubeubhz)q}q(hEUhFhuhGhHhIh}hK}q(hM]hN]hO]hP]hR]uhTK#hUhh@]q(h)q}q(hEX ParametersqhFhhGhHhIhhK}q(hM]hN]hO]hP]hR]uhTKh@]qh^X Parametersq酁q}q(hEhhFhubaubh)q}q(hEXjIndicates the parameters used when calling the method (sent in the message payload) and the return type. hK}q(hM]hN]hO]hP]hR]uhFhh@]qhb)q}q(hEXhIndicates the parameters used when calling the method (sent in the message payload) and the return type.qhFhhGhHhIhfhK}q(hM]hN]hO]hP]hR]uhTK%h@]qh^XhIndicates the parameters used when calling the method (sent in the message payload) and the return type.qq}q(hEhhFhubaubahIhubeubeubcdocutils.nodes comment q)q}q(hEX_@startuml images/class_mn.png package MemberNode { package Tier1 { class MNCore { Boolean : ping() Log : getLogRecords() } class MNRead { } class MNQuery { } } package Tier2 { class MNAuthorization{ } } package Tier3 { class MNStorage { } } package Tier4 { class MNReplication { } } } @endumlhFhChGhHhIUcommentqhK}q(U xml:spaceqUpreserveqhP]hO]hM]hN]hR]uhTKJhUhh@]qh^X_@startuml images/class_mn.png package MemberNode { package Tier1 { class MNCore { Boolean : ping() Log : getLogRecords() } class MNRead { } class MNQuery { } } package Tier2 { class MNAuthorization{ } } package Tier3 { class MNStorage { } } package Tier4 { class MNReplication { } } } @endumlrr}r(hEUhFhubaubh)r}r(hEXBWarning: this file is automatically generated. Edits will be losthFhChGcdocutils.nodes reprunicode rX5source/apis/generated/generated_MN_function_table.txtrr}rbhIhhK}r (hhhP]hO]hM]hN]hR]uhTKhUhh@]r h^XBWarning: this file is automatically generated. Edits will be lostr r }r (hEUhFjubaubcdocutils.nodes table r)r}r(hEUhFhChGNhIUtablerhK}r(hM]hN]hO]hP]rUid1rahR]uhTNhUhh@]r(hW)r}r(hEXMethods for MN componentrhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XMethods for MN componentrr}r(hEjhFjubahIh[ubcdocutils.nodes tgroup r)r}r (hEUhK}r!(hP]hO]hM]hN]hR]UcolsKuhFjh@]r"(cdocutils.nodes colspec r#)r$}r%(hEUhK}r&(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIUcolspecr'ubj#)r(}r)(hEUhK}r*(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIj'ubj#)r+}r,(hEUhK}r-(hP]hO]hM]hN]hR]UcolwidthK uhFjh@]hIj'ubj#)r.}r/(hEUhK}r0(hP]hO]hM]hN]hR]UcolwidthK uhFjh@]hIj'ubj#)r1}r2(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIj'ubcdocutils.nodes thead r4)r5}r6(hEUhK}r7(hM]hN]hO]hP]hR]uhFjh@]r8cdocutils.nodes row r9)r:}r;(hEUhK}r<(hM]hN]hO]hP]hR]uhFj5h@]r=(cdocutils.nodes entry r>)r?}r@(hEUhK}rA(hM]hN]hO]hP]hR]uhFj:h@]rBhb)rC}rD(hEXTierrEhFj?hGjhIhfhK}rF(hM]hN]hO]hP]hR]uhTK h@]rGh^XTierrHrI}rJ(hEjEhFjCubaubahIUentryrKubj>)rL}rM(hEUhK}rN(hM]hN]hO]hP]hR]uhFj:h@]rOhb)rP}rQ(hEXVersionrRhFjLhGjhIhfhK}rS(hM]hN]hO]hP]hR]uhTK h@]rTh^XVersionrUrV}rW(hEjRhFjPubaubahIjKubj>)rX}rY(hEUhK}rZ(hM]hN]hO]hP]hR]uhFj:h@]r[hb)r\}r](hEXRESTr^hFjXhGjhIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r`h^XRESTrarb}rc(hEj^hFj\ubaubahIjKubj>)rd}re(hEUhK}rf(hM]hN]hO]hP]hR]uhFj:h@]rghb)rh}ri(hEXFunctionrjhFjdhGjhIhfhK}rk(hM]hN]hO]hP]hR]uhTK h@]rlh^XFunctionrmrn}ro(hEjjhFjhubaubahIjKubj>)rp}rq(hEUhK}rr(hM]hN]hO]hP]hR]uhFj:h@]rshb)rt}ru(hEX ParametersrvhFjphGjhIhfhK}rw(hM]hN]hO]hP]hR]uhTK h@]rxh^X Parametersryrz}r{(hEjvhFjtubaubahIjKubehIUrowr|ubahIUtheadr}ubcdocutils.nodes tbody r~)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``GET /monitor/ping``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rcdocutils.nodes literal r)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /monitor/pingrr}r(hEUhFjubahIUliteralrubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`MNCore.ping`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rcsphinx.addnodes pending_xref r)r}r(hEjhFjhGjhIU pending_xrefrhK}r(UreftypeXfuncUrefwarnrU reftargetrX MNCore.pingU refdomainXpyrhP]hO]U refexplicithM]hN]hR]UrefdocrX apis/MN_APIsrUpy:classrNU py:modulerNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(UxrefrjXpy-funcrehO]hP]hR]uhFjh@]rh^X MNCore.ping()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX() ``->`` nullhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X() rr}r(hEX() hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X nullrr}r(hEX nullhFjubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0, 2.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0, 2.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``rhFjhGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKh@]r j)r }r (hEjhK}r (hM]hN]hO]hP]hR]uhFjh@]rh^XvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]rr}r(hEUhFj ubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`MNCore.getLogRecords`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNCore.getLogRecordsU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r }r!(hEjhK}r"(hM]hN]r#(jjXpy-funcr$ehO]hP]hR]uhFjh@]r%h^XMNCore.getLogRecords()r&r'}r((hEUhFj ubahIjubaubaubahIjKubj>)r)}r*(hEUhK}r+(hM]hN]hO]hP]hR]uhFjh@]r,hb)r-}r.(hEX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[event]`, ``[idFilter]``, ``[start=0]``, ``[count=1000]``) ``->`` :class:`Types.Log`hFj)hGjhIhfhK}r/(hM]hN]hO]hP]hR]uhTKh@]r0(h^X(r1}r2(hEX(hFj-ubj)r3}r4(hEX:class:`session`r5hFj-hGjhIjhK}r6(UreftypeXclassjjX Types.SessionU refdomainXpyr7hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]r8j)r9}r:(hEj5hK}r;(hM]hN]r<(jj7Xpy-classr=ehO]hP]hR]uhFj3h@]r>h^Xsessionr?r@}rA(hEUhFj9ubahIjubaubh^X, rBrC}rD(hEX, hFj-ubj)rE}rF(hEX#:class:`[fromDate]`rGhFj-hGjhIjhK}rH(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rJj)rK}rL(hEjGhK}rM(hM]hN]rN(jjIXpy-classrOehO]hP]hR]uhFjEh@]rPh^X [fromDate]rQrR}rS(hEUhFjKubahIjubaubh^X, rTrU}rV(hEX, hFj-ubj)rW}rX(hEX!:class:`[toDate]`rYhFj-hGjhIjhK}rZ(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr[hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]r\j)r]}r^(hEjYhK}r_(hM]hN]r`(jj[Xpy-classraehO]hP]hR]uhFjWh@]rbh^X[toDate]rcrd}re(hEUhFj]ubahIjubaubh^X, rfrg}rh(hEX, hFj-ubj)ri}rj(hEX%:class:`[event]`rkhFj-hGjhIjhK}rl(UreftypeXclassjjXTypes.Event, stringU refdomainXpyrmhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rnj)ro}rp(hEjkhK}rq(hM]hN]rr(jjmXpy-classrsehO]hP]hR]uhFjih@]rth^X[event]rurv}rw(hEUhFjoubahIjubaubh^X, rxry}rz(hEX, hFj-ubj)r{}r|(hEX``[idFilter]``hK}r}(hM]hN]hO]hP]hR]uhFj-h@]r~h^X [idFilter]rr}r(hEUhFj{ubahIjubh^X, rr}r(hEX, hFj-ubj)r}r(hEX ``[start=0]``hK}r(hM]hN]hO]hP]hR]uhFj-h@]rh^X [start=0]rr}r(hEUhFjubahIjubh^X, rr}r(hEX, hFj-ubj)r}r(hEX``[count=1000]``hK}r(hM]hN]hO]hP]hR]uhFj-h@]rh^X [count=1000]rr}r(hEUhFjubahIjubh^X) rr}r(hEX) hFj-ubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFj-h@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFj-ubj)r}r(hEX:class:`Types.Log`rhFj-hGjhIjhK}r(UreftypeXclassjjX Types.LogU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X Types.Logrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``GET / and GET /node``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET / and GET /noderr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`MNCore.getCapabilities`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNCore.getCapabilitiesU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNCore.getCapabilities()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX() ``->`` :class:`Types.Node`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X() rr}r(hEX() hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r (hEX:class:`Types.Node`r hFjhGjhIjhK}r (UreftypeXclassjjX Types.NodeU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]r j)r}r(hEj hK}r(hM]hN]r(jj Xpy-classrehO]hP]hR]uhFjh@]rh^X Types.Noderr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r (hEXTier 1r!hFjhGjhIhfhK}r"(hM]hN]hO]hP]hR]uhTKh@]r#h^XTier 1r$r%}r&(hEj!hFjubaubahIjKubj>)r'}r((hEUhK}r)(hM]hN]hO]hP]hR]uhFjh@]r*hb)r+}r,(hEX1.0r-hFj'hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTKh@]r/h^X1.0r0r1}r2(hEj-hFj+ubaubahIjKubj>)r3}r4(hEUhK}r5(hM]hN]hO]hP]hR]uhFjh@]r6hb)r7}r8(hEX``GET /object/{id}``r9hFj3hGjhIhfhK}r:(hM]hN]hO]hP]hR]uhTK h@]r;j)r<}r=(hEj9hK}r>(hM]hN]hO]hP]hR]uhFj7h@]r?h^XGET /object/{id}r@rA}rB(hEUhFj<ubahIjubaubahIjKubj>)rC}rD(hEUhK}rE(hM]hN]hO]hP]hR]uhFjh@]rFhb)rG}rH(hEX:func:`MNRead.get`rIhFjChGjhIhfhK}rJ(hM]hN]hO]hP]hR]uhTK!h@]rKj)rL}rM(hEjIhFjGhGjhIjhK}rN(UreftypeXfuncjjX MNRead.getU refdomainXpyrOhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK!h@]rPj)rQ}rR(hEjIhK}rS(hM]hN]rT(jjOXpy-funcrUehO]hP]hR]uhFjLh@]rVh^X MNRead.get()rWrX}rY(hEUhFjQubahIjubaubaubahIjKubj>)rZ}r[(hEUhK}r\(hM]hN]hO]hP]hR]uhFjh@]r]hb)r^}r_(hEXb(:class:`session`, :class:`id`) ``->`` :class:`Types.OctetStream`hFjZhGjhIhfhK}r`(hM]hN]hO]hP]hR]uhTK"h@]ra(h^X(rb}rc(hEX(hFj^ubj)rd}re(hEX:class:`session`rfhFj^hGjhIjhK}rg(UreftypeXclassjjX Types.SessionU refdomainXpyrhhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK"h@]rij)rj}rk(hEjfhK}rl(hM]hN]rm(jjhXpy-classrnehO]hP]hR]uhFjdh@]roh^Xsessionrprq}rr(hEUhFjjubahIjubaubh^X, rsrt}ru(hEX, hFj^ubj)rv}rw(hEX:class:`id`rxhFj^hGjhIjhK}ry(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrzhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK"h@]r{j)r|}r}(hEjxhK}r~(hM]hN]r(jjzXpy-classrehO]hP]hR]uhFjvh@]rh^Xidrr}r(hEUhFj|ubahIjubaubh^X) rr}r(hEX) hFj^ubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFj^h@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFj^ubj)r}r(hEX:class:`Types.OctetStream`rhFj^hGjhIjhK}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK"h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK#h@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK$h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``GET /meta/{id}``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK%h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /meta/{id}rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX :func:`MNRead.getSystemMetadata`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK&h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNRead.getSystemMetadataU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK&h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNRead.getSystemMetadata()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXe(:class:`session`, :class:`id`) ``->`` :class:`Types.SystemMetadata`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK'h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK'h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`id`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK'h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classr ehO]hP]hR]uhFjh@]r h^Xidr r }r (hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.SystemMetadata`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK'h@]rj)r }r!(hEjhK}r"(hM]hN]r#(jjXpy-classr$ehO]hP]hR]uhFjh@]r%h^XTypes.SystemMetadatar&r'}r((hEUhFj ubahIjubaubeubahIjKubehIj|ubj9)r)}r*(hEUhK}r+(hM]hN]hO]hP]hR]uhFjh@]r,(j>)r-}r.(hEUhK}r/(hM]hN]hO]hP]hR]uhFj)h@]r0hb)r1}r2(hEXTier 1r3hFj-hGjhIhfhK}r4(hM]hN]hO]hP]hR]uhTK(h@]r5h^XTier 1r6r7}r8(hEj3hFj1ubaubahIjKubj>)r9}r:(hEUhK}r;(hM]hN]hO]hP]hR]uhFj)h@]r<hb)r=}r>(hEX1.0r?hFj9hGjhIhfhK}r@(hM]hN]hO]hP]hR]uhTK)h@]rAh^X1.0rBrC}rD(hEj?hFj=ubaubahIjKubj>)rE}rF(hEUhK}rG(hM]hN]hO]hP]hR]uhFj)h@]rHhb)rI}rJ(hEX``HEAD /object/{id}``rKhFjEhGjhIhfhK}rL(hM]hN]hO]hP]hR]uhTK*h@]rMj)rN}rO(hEjKhK}rP(hM]hN]hO]hP]hR]uhFjIh@]rQh^XHEAD /object/{id}rRrS}rT(hEUhFjNubahIjubaubahIjKubj>)rU}rV(hEUhK}rW(hM]hN]hO]hP]hR]uhFj)h@]rXhb)rY}rZ(hEX:func:`MNRead.describe`r[hFjUhGjhIhfhK}r\(hM]hN]hO]hP]hR]uhTK+h@]r]j)r^}r_(hEj[hFjYhGjhIjhK}r`(UreftypeXfuncjjXMNRead.describeU refdomainXpyrahP]hO]U refexplicithM]hN]hR]jjjNjNuhTK+h@]rbj)rc}rd(hEj[hK}re(hM]hN]rf(jjaXpy-funcrgehO]hP]hR]uhFj^h@]rhh^XMNRead.describe()rirj}rk(hEUhFjcubahIjubaubaubahIjKubj>)rl}rm(hEUhK}rn(hM]hN]hO]hP]hR]uhFj)h@]rohb)rp}rq(hEXg(:class:`session`, :class:`id`) ``->`` :class:`Types.DescribeResponse`hFjlhGjhIhfhK}rr(hM]hN]hO]hP]hR]uhTK,h@]rs(h^X(rt}ru(hEX(hFjpubj)rv}rw(hEX:class:`session`rxhFjphGjhIjhK}ry(UreftypeXclassjjX Types.SessionU refdomainXpyrzhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK,h@]r{j)r|}r}(hEjxhK}r~(hM]hN]r(jjzXpy-classrehO]hP]hR]uhFjvh@]rh^Xsessionrr}r(hEUhFj|ubahIjubaubh^X, rr}r(hEX, hFjpubj)r}r(hEX:class:`id`rhFjphGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK,h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xidrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjpubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjph@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjpubj)r}r(hEX:class:`Types.DescribeResponse`rhFjphGjhIjhK}r(UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK,h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.DescribeResponserr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK-h@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK.h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX?``GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK/h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X;GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`MNRead.getChecksum`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK0h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNRead.getChecksumU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK0h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNRead.getChecksum()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXy(:class:`session`, :class:`pid`, ``[checksumAlgorithm]``) ``->`` :class:`Types.Checksum`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK1h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK1h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classr ehO]hP]hR]uhFjh@]r h^Xsessionr r }r (hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`pid`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK1h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xpidrr}r(hEUhFjubahIjubaubh^X, r r!}r"(hEX, hFjubj)r#}r$(hEX``[checksumAlgorithm]``hK}r%(hM]hN]hO]hP]hR]uhFjh@]r&h^X[checksumAlgorithm]r'r(}r)(hEUhFj#ubahIjubh^X) r*r+}r,(hEX) hFjubj)r-}r.(hEX``->``hK}r/(hM]hN]hO]hP]hR]uhFjh@]r0h^X->r1r2}r3(hEUhFj-ubahIjubh^X r4}r5(hEX hFjubj)r6}r7(hEX:class:`Types.Checksum`r8hFjhGjhIjhK}r9(UreftypeXclassjjXTypes.ChecksumU refdomainXpyr:hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK1h@]r;j)r<}r=(hEj8hK}r>(hM]hN]r?(jj:Xpy-classr@ehO]hP]hR]uhFj6h@]rAh^XTypes.ChecksumrBrC}rD(hEUhFj<ubahIjubaubeubahIjKubehIj|ubj9)rE}rF(hEUhK}rG(hM]hN]hO]hP]hR]uhFjh@]rH(j>)rI}rJ(hEUhK}rK(hM]hN]hO]hP]hR]uhFjEh@]rLhb)rM}rN(hEXTier 1rOhFjIhGjhIhfhK}rP(hM]hN]hO]hP]hR]uhTK2h@]rQh^XTier 1rRrS}rT(hEjOhFjMubaubahIjKubj>)rU}rV(hEUhK}rW(hM]hN]hO]hP]hR]uhFjEh@]rXhb)rY}rZ(hEX1.0r[hFjUhGjhIhfhK}r\(hM]hN]hO]hP]hR]uhTK3h@]r]h^X1.0r^r_}r`(hEj[hFjYubaubahIjKubj>)ra}rb(hEUhK}rc(hM]hN]hO]hP]hR]uhFjEh@]rdhb)re}rf(hEX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]``rghFjahGjhIhfhK}rh(hM]hN]hO]hP]hR]uhTK4h@]rij)rj}rk(hEjghK}rl(hM]hN]hO]hP]hR]uhFjeh@]rmh^XGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]rnro}rp(hEUhFjjubahIjubaubahIjKubj>)rq}rr(hEUhK}rs(hM]hN]hO]hP]hR]uhFjEh@]rthb)ru}rv(hEX:func:`MNRead.listObjects`rwhFjqhGjhIhfhK}rx(hM]hN]hO]hP]hR]uhTK5h@]ryj)rz}r{(hEjwhFjuhGjhIjhK}r|(UreftypeXfuncjjXMNRead.listObjectsU refdomainXpyr}hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK5h@]r~j)r}r(hEjwhK}r(hM]hN]r(jj}Xpy-funcrehO]hP]hR]uhFjzh@]rh^XMNRead.listObjects()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjEh@]rhb)r}r(hEX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[formatId]`, :class:`[identifier]`, ``[replicaStatus]``, ``[start=0]``, ``[count=1000]``) ``->`` :class:`Types.ObjectList`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK6h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX#:class:`[fromDate]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [fromDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX!:class:`[toDate]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X[toDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX1:class:`[formatId]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [formatId]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX':class:`[identifier]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [identifier]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX``[replicaStatus]``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X[replicaStatus]rr}r(hEUhFjubahIjubh^X, rr}r(hEX, hFjubj)r}r(hEX ``[start=0]``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X [start=0]rr}r(hEUhFjubahIjubh^X, rr}r(hEX, hFjubj)r}r(hEX``[count=1000]``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X [count=1000]rr}r(hEUhFjubahIjubh^X) rr}r (hEX) hFjubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFjh@]r h^X->rr}r(hEUhFj ubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.ObjectList`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK6h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.ObjectListrr }r!(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r"}r#(hEUhK}r$(hM]hN]hO]hP]hR]uhFjh@]r%(j>)r&}r'(hEUhK}r((hM]hN]hO]hP]hR]uhFj"h@]r)hb)r*}r+(hEXTier 1r,hFj&hGjhIhfhK}r-(hM]hN]hO]hP]hR]uhTK7h@]r.h^XTier 1r/r0}r1(hEj,hFj*ubaubahIjKubj>)r2}r3(hEUhK}r4(hM]hN]hO]hP]hR]uhFj"h@]hIjKubj>)r5}r6(hEUhK}r7(hM]hN]hO]hP]hR]uhFj"h@]r8hb)r9}r:(hEX``POST /error``r;hFj5hGjhIhfhK}r<(hM]hN]hO]hP]hR]uhTK9h@]r=j)r>}r?(hEj;hK}r@(hM]hN]hO]hP]hR]uhFj9h@]rAh^X POST /errorrBrC}rD(hEUhFj>ubahIjubaubahIjKubj>)rE}rF(hEUhK}rG(hM]hN]hO]hP]hR]uhFj"h@]rHhb)rI}rJ(hEX$:func:`MNRead.synchronizationFailed`rKhFjEhGjhIhfhK}rL(hM]hN]hO]hP]hR]uhTK:h@]rMj)rN}rO(hEjKhFjIhGjhIjhK}rP(UreftypeXfuncjjXMNRead.synchronizationFailedU refdomainXpyrQhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK:h@]rRj)rS}rT(hEjKhK}rU(hM]hN]rV(jjQXpy-funcrWehO]hP]hR]uhFjNh@]rXh^XMNRead.synchronizationFailed()rYrZ}r[(hEUhFjSubahIjubaubaubahIjKubj>)r\}r](hEUhK}r^(hM]hN]hO]hP]hR]uhFj"h@]r_hb)r`}ra(hEXb(:class:`session`, :class:`message`) ``->`` :class:`Types.Boolean`hFj\hGjhIhfhK}rb(hM]hN]hO]hP]hR]uhTK;h@]rc(h^X(rd}re(hEX(hFj`ubj)rf}rg(hEX:class:`session`rhhFj`hGjhIjhK}ri(UreftypeXclassjjX Types.SessionU refdomainXpyrjhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK;h@]rkj)rl}rm(hEjhhK}rn(hM]hN]ro(jjjXpy-classrpehO]hP]hR]uhFjfh@]rqh^Xsessionrrrs}rt(hEUhFjlubahIjubaubh^X, rurv}rw(hEX, hFj`ubj)rx}ry(hEX!:class:`message`rzhFj`hGjhIjhK}r{(UreftypeXclassjjXTypes.ExceptionU refdomainXpyr|hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK;h@]r}j)r~}r(hEjzhK}r(hM]hN]r(jj|Xpy-classrehO]hP]hR]uhFjxh@]rh^Xmessagerr}r(hEUhFj~ubahIjubaubh^X) rr}r(hEX) hFj`ubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFj`h@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFj`ubj)r}r(hEX:class:`Types.Boolean`rhFj`hGjhIjhK}r(UreftypeXclassjjX Types.BooleanU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK;h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X Types.Booleanrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK=h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``POST /dirtySystemMetadata``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK>h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XPOST /dirtySystemMetadatarr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX$:func:`MNRead.systemMetadataChanged`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK?h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNRead.systemMetadataChangedU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK?h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNRead.systemMetadataChanged()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX(:class:`session`, :class:`id`, ``serialVersion``, :class:`dateSysMetaLastModified`) ``->`` booleanhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK@h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK@h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`id`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTK@h@]rj)r}r(hEjhK}r (hM]hN]r (jjXpy-classr ehO]hP]hR]uhFjh@]r h^Xidr r}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX``serialVersion``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X serialVersionrr}r(hEUhFjubahIjubh^X, rr}r(hEX, hFjubj)r}r(hEX0:class:`dateSysMetaLastModified`rhFjhGjhIjhK}r (UreftypeXclassjjXTypes.DateTimeU refdomainXpyr!hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK@h@]r"j)r#}r$(hEjhK}r%(hM]hN]r&(jj!Xpy-classr'ehO]hP]hR]uhFjh@]r(h^XdateSysMetaLastModifiedr)r*}r+(hEUhFj#ubahIjubaubh^X) r,r-}r.(hEX) hFjubj)r/}r0(hEX``->``hK}r1(hM]hN]hO]hP]hR]uhFjh@]r2h^X->r3r4}r5(hEUhFj/ubahIjubh^X booleanr6r7}r8(hEX booleanhFjubeubahIjKubehIj|ubj9)r9}r:(hEUhK}r;(hM]hN]hO]hP]hR]uhFjh@]r<(j>)r=}r>(hEUhK}r?(hM]hN]hO]hP]hR]uhFj9h@]r@hb)rA}rB(hEXTier 1rChFj=hGjhIhfhK}rD(hM]hN]hO]hP]hR]uhTKAh@]rEh^XTier 1rFrG}rH(hEjChFjAubaubahIjKubj>)rI}rJ(hEUhK}rK(hM]hN]hO]hP]hR]uhFj9h@]rLhb)rM}rN(hEX1.0rOhFjIhGjhIhfhK}rP(hM]hN]hO]hP]hR]uhTKBh@]rQh^X1.0rRrS}rT(hEjOhFjMubaubahIjKubj>)rU}rV(hEUhK}rW(hM]hN]hO]hP]hR]uhFj9h@]rXhb)rY}rZ(hEX``GET /replica/{pid}``r[hFjUhGjhIhfhK}r\(hM]hN]hO]hP]hR]uhTKCh@]r]j)r^}r_(hEj[hK}r`(hM]hN]hO]hP]hR]uhFjYh@]rah^XGET /replica/{pid}rbrc}rd(hEUhFj^ubahIjubaubahIjKubj>)re}rf(hEUhK}rg(hM]hN]hO]hP]hR]uhFj9h@]rhhb)ri}rj(hEX:func:`MNRead.getReplica`rkhFjehGjhIhfhK}rl(hM]hN]hO]hP]hR]uhTKDh@]rmj)rn}ro(hEjkhFjihGjhIjhK}rp(UreftypeXfuncjjXMNRead.getReplicaU refdomainXpyrqhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKDh@]rrj)rs}rt(hEjkhK}ru(hM]hN]rv(jjqXpy-funcrwehO]hP]hR]uhFjnh@]rxh^XMNRead.getReplica()ryrz}r{(hEUhFjsubahIjubaubaubahIjKubj>)r|}r}(hEUhK}r~(hM]hN]hO]hP]hR]uhFj9h@]rhb)r}r(hEXc(:class:`session`, :class:`pid`) ``->`` :class:`Types.OctetStream`hFj|hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKEh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKEh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`pid`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKEh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xpidrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.OctetStream`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKEh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 2rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKFh@]rh^XTier 2rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKGh@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX*``GET /isAuthorized/{id}?action={action}``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKHh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X&GET /isAuthorized/{id}?action={action}rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX$:func:`MNAuthorization.isAuthorized`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKIh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNAuthorization.isAuthorizedU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKIh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNAuthorization.isAuthorized()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r }r (hEXr(:class:`session`, :class:`id`, :class:`action`) ``->`` booleanhFjhGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKJh@]r (h^X(r }r(hEX(hFj ubj)r}r(hEX:class:`session`rhFj hGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKJh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r (hEX, hFj ubj)r!}r"(hEX:class:`id`r#hFj hGjhIjhK}r$(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr%hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKJh@]r&j)r'}r((hEj#hK}r)(hM]hN]r*(jj%Xpy-classr+ehO]hP]hR]uhFj!h@]r,h^Xidr-r.}r/(hEUhFj'ubahIjubaubh^X, r0r1}r2(hEX, hFj ubj)r3}r4(hEX!:class:`action`r5hFj hGjhIjhK}r6(UreftypeXclassjjXTypes.PermissionU refdomainXpyr7hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKJh@]r8j)r9}r:(hEj5hK}r;(hM]hN]r<(jj7Xpy-classr=ehO]hP]hR]uhFj3h@]r>h^Xactionr?r@}rA(hEUhFj9ubahIjubaubh^X) rBrC}rD(hEX) hFj ubj)rE}rF(hEX``->``hK}rG(hM]hN]hO]hP]hR]uhFj h@]rHh^X->rIrJ}rK(hEUhFjEubahIjubh^X booleanrLrM}rN(hEX booleanhFj ubeubahIjKubehIj|ubj9)rO}rP(hEUhK}rQ(hM]hN]hO]hP]hR]uhFjh@]rR(j>)rS}rT(hEUhK}rU(hM]hN]hO]hP]hR]uhFjOh@]rVhb)rW}rX(hEXTier 3rYhFjShGjhIhfhK}rZ(hM]hN]hO]hP]hR]uhTKKh@]r[h^XTier 3r\r]}r^(hEjYhFjWubaubahIjKubj>)r_}r`(hEUhK}ra(hM]hN]hO]hP]hR]uhFjOh@]rbhb)rc}rd(hEX1.0rehFj_hGjhIhfhK}rf(hM]hN]hO]hP]hR]uhTKLh@]rgh^X1.0rhri}rj(hEjehFjcubaubahIjKubj>)rk}rl(hEUhK}rm(hM]hN]hO]hP]hR]uhFjOh@]rnhb)ro}rp(hEX``POST /object``rqhFjkhGjhIhfhK}rr(hM]hN]hO]hP]hR]uhTKMh@]rsj)rt}ru(hEjqhK}rv(hM]hN]hO]hP]hR]uhFjoh@]rwh^X POST /objectrxry}rz(hEUhFjtubahIjubaubahIjKubj>)r{}r|(hEUhK}r}(hM]hN]hO]hP]hR]uhFjOh@]r~hb)r}r(hEX:func:`MNStorage.create`rhFj{hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKNh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNStorage.createU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKNh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNStorage.create()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjOh@]rhb)r}r(hEX(:class:`session`, :class:`pid`, ``object``, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKOh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKOh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`pid`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKOh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xpidrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX ``object``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xobjectrr}r(hEUhFjubahIjubh^X, rr}r(hEX, hFjubj)r}r(hEX&:class:`sysmeta`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKOh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsysmetarr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.Identifier`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKOh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.Identifierrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 3rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKPh@]r h^XTier 3r r }r (hEjhFjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r }r (hEX1.0r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKQh@]r h^X1.0r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r }r (hEX``PUT /object/{pid}``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKRh@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XPUT /object/{pid}r r }r (hEUhFj ubahIjubaubahIjKubj>)r }r! (hEUhK}r" (hM]hN]hO]hP]hR]uhFjh@]r# hb)r$ }r% (hEX:func:`MNStorage.update`r& hFj hGjhIhfhK}r' (hM]hN]hO]hP]hR]uhTKSh@]r( j)r) }r* (hEj& hFj$ hGjhIjhK}r+ (UreftypeXfuncjjXMNStorage.updateU refdomainXpyr, hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKSh@]r- j)r. }r/ (hEj& hK}r0 (hM]hN]r1 (jj, Xpy-funcr2 ehO]hP]hR]uhFj) h@]r3 h^XMNStorage.update()r4 r5 }r6 (hEUhFj. ubahIjubaubaubahIjKubj>)r7 }r8 (hEUhK}r9 (hM]hN]hO]hP]hR]uhFjh@]r: hb)r; }r< (hEX(:class:`session`, :class:`pid`, ``object``, :class:`newPid`, :class:`sysmeta`) ``->`` :class:`Types.Identifier`hFj7 hGjhIhfhK}r= (hM]hN]hO]hP]hR]uhTKTh@]r> (h^X(r? }r@ (hEX(hFj; ubj)rA }rB (hEX:class:`session`rC hFj; hGjhIjhK}rD (UreftypeXclassjjX Types.SessionU refdomainXpyrE hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKTh@]rF j)rG }rH (hEjC hK}rI (hM]hN]rJ (jjE Xpy-classrK ehO]hP]hR]uhFjA h@]rL h^XsessionrM rN }rO (hEUhFjG ubahIjubaubh^X, rP rQ }rR (hEX, hFj; ubj)rS }rT (hEX:class:`pid`rU hFj; hGjhIjhK}rV (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrW hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKTh@]rX j)rY }rZ (hEjU hK}r[ (hM]hN]r\ (jjW Xpy-classr] ehO]hP]hR]uhFjS h@]r^ h^Xpidr_ r` }ra (hEUhFjY ubahIjubaubh^X, rb rc }rd (hEX, hFj; ubj)re }rf (hEX ``object``hK}rg (hM]hN]hO]hP]hR]uhFj; h@]rh h^Xobjectri rj }rk (hEUhFje ubahIjubh^X, rl rm }rn (hEX, hFj; ubj)ro }rp (hEX!:class:`newPid`rq hFj; hGjhIjhK}rr (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrs hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKTh@]rt j)ru }rv (hEjq hK}rw (hM]hN]rx (jjs Xpy-classry ehO]hP]hR]uhFjo h@]rz h^XnewPidr{ r| }r} (hEUhFju ubahIjubaubh^X, r~ r }r (hEX, hFj; ubj)r }r (hEX&:class:`sysmeta`r hFj; hGjhIjhK}r (UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKTh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsysmetar r }r (hEUhFj ubahIjubaubh^X) r r }r (hEX) hFj; ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj; h@]r h^X->r r }r (hEUhFj ubahIjubh^X r }r (hEX hFj; ubj)r }r (hEX:class:`Types.Identifier`r hFj; hGjhIjhK}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKTh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^XTypes.Identifierr r }r (hEUhFj ubahIjubaubeubahIjKubehIj|ubj9)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r (j>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXTier 3r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKUh@]r h^XTier 3r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX1.0r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKVh@]r h^X1.0r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX``POST /generate``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKWh@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XPOST /generater r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX$:func:`MNStorage.generateIdentifier`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKXh@]r j)r }r (hEj hFj hGjhIjhK}r (UreftypeXfuncjjXMNStorage.generateIdentifierU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKXh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj h@]r h^XMNStorage.generateIdentifier()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX^(:class:`session`, ``scheme``, ``[fragment]``) ``->`` :class:`Types.Identifier`hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKYh@]r (h^X(r }r (hEX(hFj ubj)r }r (hEX:class:`session`r hFj hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKYh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj ubj)r }r (hEX ``scheme``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^Xschemer r }r (hEUhFj ubahIjubh^X, r r }r (hEX, hFj ubj)r }r (hEX``[fragment]``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X [fragment]r r }r (hEUhFj ubahIjubh^X) r r }r (hEX) hFj ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj h@]r! h^X->r" r# }r$ (hEUhFj ubahIjubh^X r% }r& (hEX hFj ubj)r' }r( (hEX:class:`Types.Identifier`r) hFj hGjhIjhK}r* (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr+ hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKYh@]r, j)r- }r. (hEj) hK}r/ (hM]hN]r0 (jj+ Xpy-classr1 ehO]hP]hR]uhFj' h@]r2 h^XTypes.Identifierr3 r4 }r5 (hEUhFj- ubahIjubaubeubahIjKubehIj|ubj9)r6 }r7 (hEUhK}r8 (hM]hN]hO]hP]hR]uhFjh@]r9 (j>)r: }r; (hEUhK}r< (hM]hN]hO]hP]hR]uhFj6 h@]r= hb)r> }r? (hEXTier 3r@ hFj: hGjhIhfhK}rA (hM]hN]hO]hP]hR]uhTKZh@]rB h^XTier 3rC rD }rE (hEj@ hFj> ubaubahIjKubj>)rF }rG (hEUhK}rH (hM]hN]hO]hP]hR]uhFj6 h@]rI hb)rJ }rK (hEX1.0rL hFjF hGjhIhfhK}rM (hM]hN]hO]hP]hR]uhTK[h@]rN h^X1.0rO rP }rQ (hEjL hFjJ ubaubahIjKubj>)rR }rS (hEUhK}rT (hM]hN]hO]hP]hR]uhFj6 h@]rU hb)rV }rW (hEX``DELETE /object/{id}``rX hFjR hGjhIhfhK}rY (hM]hN]hO]hP]hR]uhTK\h@]rZ j)r[ }r\ (hEjX hK}r] (hM]hN]hO]hP]hR]uhFjV h@]r^ h^XDELETE /object/{id}r_ r` }ra (hEUhFj[ ubahIjubaubahIjKubj>)rb }rc (hEUhK}rd (hM]hN]hO]hP]hR]uhFj6 h@]re hb)rf }rg (hEX:func:`MNStorage.delete`rh hFjb hGjhIhfhK}ri (hM]hN]hO]hP]hR]uhTK]h@]rj j)rk }rl (hEjh hFjf hGjhIjhK}rm (UreftypeXfuncjjXMNStorage.deleteU refdomainXpyrn hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK]h@]ro j)rp }rq (hEjh hK}rr (hM]hN]rs (jjn Xpy-funcrt ehO]hP]hR]uhFjk h@]ru h^XMNStorage.delete()rv rw }rx (hEUhFjp ubahIjubaubaubahIjKubj>)ry }rz (hEUhK}r{ (hM]hN]hO]hP]hR]uhFj6 h@]r| hb)r} }r~ (hEXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hFjy hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK^h@]r (h^X(r }r (hEX(hFj} ubj)r }r (hEX:class:`session`r hFj} hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK^h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj} ubj)r }r (hEX:class:`id`r hFj} hGjhIjhK}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK^h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xidr r }r (hEUhFj ubahIjubaubh^X) r r }r (hEX) hFj} ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj} h@]r h^X->r r }r (hEUhFj ubahIjubh^X r }r (hEX hFj} ubj)r }r (hEX:class:`Types.Identifier`r hFj} hGjhIjhK}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK^h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^XTypes.Identifierr r }r (hEUhFj ubahIjubaubeubahIjKubehIj|ubj9)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r (j>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXTier 3r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK_h@]r h^XTier 3r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX1.0r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK`h@]r h^X1.0r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX``PUT /archive/{id}``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKah@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XPUT /archive/{id}r r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX:func:`MNStorage.archive`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKbh@]r j)r }r (hEj hFj hGjhIjhK}r (UreftypeXfuncjjXMNStorage.archiveU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKbh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj h@]r h^XMNStorage.archive()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKch@]r (h^X(r }r (hEX(hFj ubj)r }r (hEX:class:`session`r hFj hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKch@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj ubj)r }r (hEX:class:`id`r hFj hGjhIjhK}r! (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr" hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKch@]r# j)r$ }r% (hEj hK}r& (hM]hN]r' (jj" Xpy-classr( ehO]hP]hR]uhFj h@]r) h^Xidr* r+ }r, (hEUhFj$ ubahIjubaubh^X) r- r. }r/ (hEX) hFj ubj)r0 }r1 (hEX``->``hK}r2 (hM]hN]hO]hP]hR]uhFj h@]r3 h^X->r4 r5 }r6 (hEUhFj0 ubahIjubh^X r7 }r8 (hEX hFj ubj)r9 }r: (hEX:class:`Types.Identifier`r; hFj hGjhIjhK}r< (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr= hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKch@]r> j)r? }r@ (hEj; hK}rA (hM]hN]rB (jj= Xpy-classrC ehO]hP]hR]uhFj9 h@]rD h^XTypes.IdentifierrE rF }rG (hEUhFj? ubahIjubaubeubahIjKubehIj|ubj9)rH }rI (hEUhK}rJ (hM]hN]hO]hP]hR]uhFjh@]rK (j>)rL }rM (hEUhK}rN (hM]hN]hO]hP]hR]uhFjH h@]rO hb)rP }rQ (hEXTier 1rR hFjL hGjhIhfhK}rS (hM]hN]hO]hP]hR]uhTKdh@]rT h^XTier 1rU rV }rW (hEjR hFjP ubaubahIjKubj>)rX }rY (hEUhK}rZ (hM]hN]hO]hP]hR]uhFjH h@]r[ hb)r\ }r] (hEX2.0r^ hFjX hGjhIhfhK}r_ (hM]hN]hO]hP]hR]uhTKeh@]r` h^X2.0ra rb }rc (hEj^ hFj\ ubaubahIjKubj>)rd }re (hEUhK}rf (hM]hN]hO]hP]hR]uhFjH h@]rg hb)rh }ri (hEX ``PUT /meta``rj hFjd hGjhIhfhK}rk (hM]hN]hO]hP]hR]uhTKfh@]rl j)rm }rn (hEjj hK}ro (hM]hN]hO]hP]hR]uhFjh h@]rp h^X PUT /metarq rr }rs (hEUhFjm ubahIjubaubahIjKubj>)rt }ru (hEUhK}rv (hM]hN]hO]hP]hR]uhFjH h@]rw hb)rx }ry (hEX&:func:`MNStorage.updateSystemMetadata`rz hFjt hGjhIhfhK}r{ (hM]hN]hO]hP]hR]uhTKgh@]r| j)r} }r~ (hEjz hFjx hGjhIjhK}r (UreftypeXfuncjjXMNStorage.updateSystemMetadataU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKgh@]r j)r }r (hEjz hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj} h@]r h^X MNStorage.updateSystemMetadata()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjH h@]r hb)r }r (hEXx(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` booleanhFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKhh@]r (h^X(r }r (hEX(hFj ubj)r }r (hEX:class:`session`r hFj hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKhh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj ubj)r }r (hEX:class:`pid`r hFj hGjhIjhK}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKhh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xpidr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj ubj)r }r (hEX&:class:`sysmeta`r hFj hGjhIjhK}r (UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKhh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsysmetar r }r (hEUhFj ubahIjubaubh^X) r r }r (hEX) hFj ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X->r r }r (hEUhFj ubahIjubh^X booleanr r }r (hEX booleanhFj ubeubahIjKubehIj|ubj9)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r (j>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXTier 4r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKih@]r h^XTier 4r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX1.0r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKjh@]r h^X1.0r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX``POST /replicate``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKkh@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XPOST /replicater r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX:func:`MNReplication.replicate`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKlh@]r j)r }r (hEj hFj hGjhIjhK}r (UreftypeXfuncjjXMNReplication.replicateU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKlh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj h@]r h^XMNReplication.replicate()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX(:class:`session`, :class:`sysmeta`, :class:`sourceNode`) ``->`` booleanhFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKmh@]r (h^X(r }r! (hEX(hFj ubj)r" }r# (hEX:class:`session`r$ hFj hGjhIjhK}r% (UreftypeXclassjjX Types.SessionU refdomainXpyr& hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKmh@]r' j)r( }r) (hEj$ hK}r* (hM]hN]r+ (jj& Xpy-classr, ehO]hP]hR]uhFj" h@]r- h^Xsessionr. r/ }r0 (hEUhFj( ubahIjubaubh^X, r1 r2 }r3 (hEX, hFj ubj)r4 }r5 (hEX&:class:`sysmeta`r6 hFj hGjhIjhK}r7 (UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr8 hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKmh@]r9 j)r: }r; (hEj6 hK}r< (hM]hN]r= (jj8 Xpy-classr> ehO]hP]hR]uhFj4 h@]r? h^Xsysmetar@ rA }rB (hEUhFj: ubahIjubaubh^X, rC rD }rE (hEX, hFj ubj)rF }rG (hEX(:class:`sourceNode`rH hFj hGjhIjhK}rI (UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrJ hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKmh@]rK j)rL }rM (hEjH hK}rN (hM]hN]rO (jjJ Xpy-classrP ehO]hP]hR]uhFjF h@]rQ h^X sourceNoderR rS }rT (hEUhFjL ubahIjubaubh^X) rU rV }rW (hEX) hFj ubj)rX }rY (hEX``->``hK}rZ (hM]hN]hO]hP]hR]uhFj h@]r[ h^X->r\ r] }r^ (hEUhFjX ubahIjubh^X booleanr_ r` }ra (hEX booleanhFj ubeubahIjKubehIj|ubj9)rb }rc (hEUhK}rd (hM]hN]hO]hP]hR]uhFjh@]re (j>)rf }rg (hEUhK}rh (hM]hN]hO]hP]hR]uhFjb h@]ri hb)rj }rk (hEXTier 1rl hFjf hGjhIhfhK}rm (hM]hN]hO]hP]hR]uhTKnh@]rn h^XTier 1ro rp }rq (hEjl hFjj ubaubahIjKubj>)rr }rs (hEUhK}rt (hM]hN]hO]hP]hR]uhFjb h@]ru hb)rv }rw (hEX1.1rx hFjr hGjhIhfhK}ry (hM]hN]hO]hP]hR]uhTKoh@]rz h^X1.1r{ r| }r} (hEjx hFjv ubaubahIjKubj>)r~ }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjb h@]r hb)r }r (hEX$``GET /query/{queryEngine}/{query}``r hFj~ hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKph@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X GET /query/{queryEngine}/{query}r r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjb h@]r hb)r }r (hEX:func:`MNQuery.query`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKqh@]r j)r }r (hEj hFj hGjhIjhK}r (UreftypeXfuncjjX MNQuery.queryU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKqh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj h@]r h^XMNQuery.query()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjb h@]r hb)r }r (hEX_(:class:`session`, ``queryEngine``, ``query``) ``->`` :class:`Types.OctetStream`hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKrh@]r (h^X(r }r (hEX(hFj ubj)r }r (hEX:class:`session`r hFj hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKrh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X, r r }r (hEX, hFj ubj)r }r (hEX``queryEngine``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X queryEnginer r }r (hEUhFj ubahIjubh^X, r r }r (hEX, hFj ubj)r }r (hEX ``query``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^Xqueryr r }r (hEUhFj ubahIjubh^X) r r }r (hEX) hFj ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X->r r }r (hEUhFj ubahIjubh^X r }r (hEX hFj ubj)r }r (hEX:class:`Types.OctetStream`r hFj hGjhIjhK}r (UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKrh@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^XTypes.OctetStreamr r }r (hEUhFj ubahIjubaubeubahIjKubehIj|ubj9)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r (j>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXTier 1r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKsh@]r h^XTier 1r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX1.1r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKth@]r h^X1.1r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX``GET /query/{queryType}``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKuh@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XGET /query/{queryType}r r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX):func:`MNQuery.getQueryEngineDescription`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKvh@]r! j)r" }r# (hEj hFj hGjhIjhK}r$ (UreftypeXfuncjjX!MNQuery.getQueryEngineDescriptionU refdomainXpyr% hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKvh@]r& j)r' }r( (hEj hK}r) (hM]hN]r* (jj% Xpy-funcr+ ehO]hP]hR]uhFj" h@]r, h^X#MNQuery.getQueryEngineDescription()r- r. }r/ (hEUhFj' ubahIjubaubaubahIjKubj>)r0 }r1 (hEUhK}r2 (hM]hN]hO]hP]hR]uhFj h@]r3 hb)r4 }r5 (hEX_(:class:`session`, ``queryEngine``) ``->`` :class:`Types.QueryEngineDescription`hFj0 hGjhIhfhK}r6 (hM]hN]hO]hP]hR]uhTKwh@]r7 (h^X(r8 }r9 (hEX(hFj4 ubj)r: }r; (hEX:class:`session`r< hFj4 hGjhIjhK}r= (UreftypeXclassjjX Types.SessionU refdomainXpyr> hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKwh@]r? j)r@ }rA (hEj< hK}rB (hM]hN]rC (jj> Xpy-classrD ehO]hP]hR]uhFj: h@]rE h^XsessionrF rG }rH (hEUhFj@ ubahIjubaubh^X, rI rJ }rK (hEX, hFj4 ubj)rL }rM (hEX``queryEngine``hK}rN (hM]hN]hO]hP]hR]uhFj4 h@]rO h^X queryEnginerP rQ }rR (hEUhFjL ubahIjubh^X) rS rT }rU (hEX) hFj4 ubj)rV }rW (hEX``->``hK}rX (hM]hN]hO]hP]hR]uhFj4 h@]rY h^X->rZ r[ }r\ (hEUhFjV ubahIjubh^X r] }r^ (hEX hFj4 ubj)r_ }r` (hEX%:class:`Types.QueryEngineDescription`ra hFj4 hGjhIjhK}rb (UreftypeXclassjjXTypes.QueryEngineDescriptionU refdomainXpyrc hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKwh@]rd j)re }rf (hEja hK}rg (hM]hN]rh (jjc Xpy-classri ehO]hP]hR]uhFj_ h@]rj h^XTypes.QueryEngineDescriptionrk rl }rm (hEUhFje ubahIjubaubeubahIjKubehIj|ubj9)rn }ro (hEUhK}rp (hM]hN]hO]hP]hR]uhFjh@]rq (j>)rr }rs (hEUhK}rt (hM]hN]hO]hP]hR]uhFjn h@]ru hb)rv }rw (hEXTier 1rx hFjr hGjhIhfhK}ry (hM]hN]hO]hP]hR]uhTKxh@]rz h^XTier 1r{ r| }r} (hEjx hFjv ubaubahIjKubj>)r~ }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjn h@]r hb)r }r (hEX1.1r hFj~ hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKyh@]r h^X1.1r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjn h@]r hb)r }r (hEX``GET /query``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKzh@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X GET /queryr r }r (hEUhFj ubahIjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjn h@]r hb)r }r (hEX :func:`MNQuery.listQueryEngines`r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK{h@]r j)r }r (hEj hFj hGjhIjhK}r (UreftypeXfuncjjXMNQuery.listQueryEnginesU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK{h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-funcr ehO]hP]hR]uhFj h@]r h^XMNQuery.listQueryEngines()r r }r (hEUhFj ubahIjubaubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjn h@]r hb)r }r (hEXG(:class:`session`) ``->`` :class:`Types.QueryEngineList`hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK|h@]r (h^X(r }r (hEX(hFj ubj)r }r (hEX:class:`session`r hFj hGjhIjhK}r (UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK|h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^Xsessionr r }r (hEUhFj ubahIjubaubh^X) r r }r (hEX) hFj ubj)r }r (hEX``->``hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X->r r }r (hEUhFj ubahIjubh^X r }r (hEX hFj ubj)r }r (hEX:class:`Types.QueryEngineList`r hFj hGjhIjhK}r (UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjNuhTK|h@]r j)r }r (hEj hK}r (hM]hN]r (jj Xpy-classr ehO]hP]hR]uhFj h@]r h^XTypes.QueryEngineListr r }r (hEUhFj ubahIjubaubeubahIjKubehIj|ubj9)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r (j>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEXTier 1r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK}h@]r h^XTier 1r r }r (hEj hFj ubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFj h@]r hb)r }r (hEX1.2r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK~h@]r h^X1.2r r }r(hEj hFj ubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj h@]rhb)r}r(hEX``GET /views/{theme}/{pid}``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r j)r }r (hEjhK}r (hM]hN]hO]hP]hR]uhFjh@]r h^XGET /views/{theme}/{pid}rr}r(hEUhFj ubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj h@]rhb)r}r(hEX:func:`MNView.view`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjX MNView.viewU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r (hEjhK}r!(hM]hN]r"(jjXpy-funcr#ehO]hP]hR]uhFjh@]r$h^X MNView.view()r%r&}r'(hEUhFjubahIjubaubaubahIjKubj>)r(}r)(hEUhK}r*(hM]hN]hO]hP]hR]uhFj h@]r+hb)r,}r-(hEXm(:class:`session`, ``theme``, :class:`id`) ``->`` :class:`Types.OctetStream`hFj(hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTKh@]r/(h^X(r0}r1(hEX(hFj,ubj)r2}r3(hEX:class:`session`r4hFj,hGjhIjhK}r5(UreftypeXclassjjX Types.SessionU refdomainXpyr6hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]r7j)r8}r9(hEj4hK}r:(hM]hN]r;(jj6Xpy-classr<ehO]hP]hR]uhFj2h@]r=h^Xsessionr>r?}r@(hEUhFj8ubahIjubaubh^X, rArB}rC(hEX, hFj,ubj)rD}rE(hEX ``theme``hK}rF(hM]hN]hO]hP]hR]uhFj,h@]rGh^XthemerHrI}rJ(hEUhFjDubahIjubh^X, rKrL}rM(hEX, hFj,ubj)rN}rO(hEX:class:`id`rPhFj,hGjhIjhK}rQ(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrRhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rSj)rT}rU(hEjPhK}rV(hM]hN]rW(jjRXpy-classrXehO]hP]hR]uhFjNh@]rYh^XidrZr[}r\(hEUhFjTubahIjubaubh^X) r]r^}r_(hEX) hFj,ubj)r`}ra(hEX``->``hK}rb(hM]hN]hO]hP]hR]uhFj,h@]rch^X->rdre}rf(hEUhFj`ubahIjubh^X rg}rh(hEX hFj,ubj)ri}rj(hEX:class:`Types.OctetStream`rkhFj,hGjhIjhK}rl(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrmhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rnj)ro}rp(hEjkhK}rq(hM]hN]rr(jjmXpy-classrsehO]hP]hR]uhFjih@]rth^XTypes.OctetStreamrurv}rw(hEUhFjoubahIjubaubeubahIjKubehIj|ubj9)rx}ry(hEUhK}rz(hM]hN]hO]hP]hR]uhFjh@]r{(j>)r|}r}(hEUhK}r~(hM]hN]hO]hP]hR]uhFjxh@]rhb)r}r(hEXTier 1rhFj|hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjxh@]rhb)r}r(hEX1.2rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.2rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjxh@]rhb)r}r(hEX``GET /views``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X GET /viewsrr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjxh@]rhb)r}r(hEX:func:`MNView.listViews`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXMNView.listViewsU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XMNView.listViews()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjxh@]rhb)r}r(hEXB(:class:`session`) ``->`` :class:`Types.OptionList`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.OptionList`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.OptionListU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OptionListrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.2rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.2rr }r (hEjhFjubaubahIjKubj>)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX%``GET /packages/{packageType}/{pid}``rhFj hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X!GET /packages/{packageType}/{pid}rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r (hEX:func:`MNPackage.getPackage`r!hFjhGjhIhfhK}r"(hM]hN]hO]hP]hR]uhTKh@]r#j)r$}r%(hEj!hFjhGjhIjhK}r&(UreftypeXfuncjjXMNPackage.getPackageU refdomainXpyr'hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]r(j)r)}r*(hEj!hK}r+(hM]hN]r,(jj'Xpy-funcr-ehO]hP]hR]uhFj$h@]r.h^XMNPackage.getPackage()r/r0}r1(hEUhFj)ubahIjubaubaubahIjKubj>)r2}r3(hEUhK}r4(hM]hN]hO]hP]hR]uhFjh@]r5hb)r6}r7(hEX(:class:`session`, :class:`packageType`, :class:`id`) ``->`` :class:`Types.OctetStream`hFj2hGjhIhfhK}r8(hM]hN]hO]hP]hR]uhTKh@]r9(h^X(r:}r;(hEX(hFj6ubj)r<}r=(hEX:class:`session`r>hFj6hGjhIjhK}r?(UreftypeXclassjjX Types.SessionU refdomainXpyr@hP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rAj)rB}rC(hEj>hK}rD(hM]hN]rE(jj@Xpy-classrFehO]hP]hR]uhFj<h@]rGh^XsessionrHrI}rJ(hEUhFjBubahIjubaubh^X, rKrL}rM(hEX, hFj6ubj)rN}rO(hEX2:class:`packageType`rPhFj6hGjhIjhK}rQ(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrRhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rSj)rT}rU(hEjPhK}rV(hM]hN]rW(jjRXpy-classrXehO]hP]hR]uhFjNh@]rYh^X packageTyperZr[}r\(hEUhFjTubahIjubaubh^X, r]r^}r_(hEX, hFj6ubj)r`}ra(hEX:class:`id`rbhFj6hGjhIjhK}rc(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrdhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rej)rf}rg(hEjbhK}rh(hM]hN]ri(jjdXpy-classrjehO]hP]hR]uhFj`h@]rkh^Xidrlrm}rn(hEUhFjfubahIjubaubh^X) rorp}rq(hEX) hFj6ubj)rr}rs(hEX``->``hK}rt(hM]hN]hO]hP]hR]uhFj6h@]ruh^X->rvrw}rx(hEUhFjrubahIjubh^X ry}rz(hEX hFj6ubj)r{}r|(hEX:class:`Types.OctetStream`r}hFj6hGjhIjhK}r~(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjNuhTKh@]rj)r}r(hEj}hK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFj{h@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubehIUtbodyrubehIUtgrouprubeubhB)r}r(hEUhFhChGhHhIhJhK}r(hM]hN]hO]hP]r(X module-MNCorerh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTierrhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]rh^XTierr r }r (hEjhFjubaubahIjKubj>)r }r (hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXVersionrhFj hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]rh^XVersionrr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXRESTrhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]r h^XRESTr!r"}r#(hEjhFjubaubahIjKubj>)r$}r%(hEUhK}r&(hM]hN]hO]hP]hR]uhFjh@]r'hb)r(}r)(hEXFunctionr*hFj$hGjhIhfhK}r+(hM]hN]hO]hP]hR]uhTK h@]r,h^XFunctionr-r.}r/(hEj*hFj(ubaubahIjKubj>)r0}r1(hEUhK}r2(hM]hN]hO]hP]hR]uhFjh@]r3hb)r4}r5(hEX Parametersr6hFj0hGjhIhfhK}r7(hM]hN]hO]hP]hR]uhTK h@]r8h^X Parametersr9r:}r;(hEj6hFj4ubaubahIjKubehIj|ubahIj}ubj~)r<}r=(hEUhK}r>(hM]hN]hO]hP]hR]uhFjh@]r?(j9)r@}rA(hEUhK}rB(hM]hN]hO]hP]hR]uhFj<h@]rC(j>)rD}rE(hEUhK}rF(hM]hN]hO]hP]hR]uhFj@h@]rGhb)rH}rI(hEXTier 1rJhFjDhGjhIhfhK}rK(hM]hN]hO]hP]hR]uhTKh@]rLh^XTier 1rMrN}rO(hEjJhFjHubaubahIjKubj>)rP}rQ(hEUhK}rR(hM]hN]hO]hP]hR]uhFj@h@]rShb)rT}rU(hEX1.0rVhFjPhGjhIhfhK}rW(hM]hN]hO]hP]hR]uhTKh@]rXh^X1.0rYrZ}r[(hEjVhFjTubaubahIjKubj>)r\}r](hEUhK}r^(hM]hN]hO]hP]hR]uhFj@h@]r_hb)r`}ra(hEX``GET /monitor/ping``rbhFj\hGjhIhfhK}rc(hM]hN]hO]hP]hR]uhTKh@]rdj)re}rf(hEjbhK}rg(hM]hN]hO]hP]hR]uhFj`h@]rhh^XGET /monitor/pingrirj}rk(hEUhFjeubahIjubaubahIjKubj>)rl}rm(hEUhK}rn(hM]hN]hO]hP]hR]uhFj@h@]rohb)rp}rq(hEX :func:`ping`rrhFjlhGjhIhfhK}rs(hM]hN]hO]hP]hR]uhTKh@]rtj)ru}rv(hEjrhFjphGjhIjhK}rw(UreftypeXfuncjjXpingU refdomainXpyrxhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]ryj)rz}r{(hEjrhK}r|(hM]hN]r}(jjxXpy-funcr~ehO]hP]hR]uhFjuh@]rh^Xping()rr}r(hEUhFjzubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj@h@]rhb)r}r(hEX() ``->`` nullhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X() rr}r(hEX() hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X nullrr}r(hEX nullhFjubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj<h@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0, 2.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0, 2.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`getLogRecords`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjX getLogRecordsU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XgetLogRecords()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[event]`, ``[idFilter]``, ``[start=0]``, ``[count=1000]``) ``->`` :class:`Types.Log`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX#:class:`[fromDate]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [fromDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r }r (hEX!:class:`[toDate]`r hFjhGjhIjhK}r (UreftypeXclassjjXTypes.DateTimeU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEj hK}r(hM]hN]r(jj Xpy-classrehO]hP]hR]uhFj h@]rh^X[toDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX%:class:`[event]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.Event, stringU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r j)r!}r"(hEjhK}r#(hM]hN]r$(jjXpy-classr%ehO]hP]hR]uhFjh@]r&h^X[event]r'r(}r)(hEUhFj!ubahIjubaubh^X, r*r+}r,(hEX, hFjubj)r-}r.(hEX``[idFilter]``hK}r/(hM]hN]hO]hP]hR]uhFjh@]r0h^X [idFilter]r1r2}r3(hEUhFj-ubahIjubh^X, r4r5}r6(hEX, hFjubj)r7}r8(hEX ``[start=0]``hK}r9(hM]hN]hO]hP]hR]uhFjh@]r:h^X [start=0]r;r<}r=(hEUhFj7ubahIjubh^X, r>r?}r@(hEX, hFjubj)rA}rB(hEX``[count=1000]``hK}rC(hM]hN]hO]hP]hR]uhFjh@]rDh^X [count=1000]rErF}rG(hEUhFjAubahIjubh^X) rHrI}rJ(hEX) hFjubj)rK}rL(hEX``->``hK}rM(hM]hN]hO]hP]hR]uhFjh@]rNh^X->rOrP}rQ(hEUhFjKubahIjubh^X rR}rS(hEX hFjubj)rT}rU(hEX:class:`Types.Log`rVhFjhGjhIjhK}rW(UreftypeXclassjjX Types.LogU refdomainXpyrXhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rYj)rZ}r[(hEjVhK}r\(hM]hN]r](jjXXpy-classr^ehO]hP]hR]uhFjTh@]r_h^X Types.Logr`ra}rb(hEUhFjZubahIjubaubeubahIjKubehIj|ubj9)rc}rd(hEUhK}re(hM]hN]hO]hP]hR]uhFj<h@]rf(j>)rg}rh(hEUhK}ri(hM]hN]hO]hP]hR]uhFjch@]rjhb)rk}rl(hEXTier 1rmhFjghGjhIhfhK}rn(hM]hN]hO]hP]hR]uhTKh@]roh^XTier 1rprq}rr(hEjmhFjkubaubahIjKubj>)rs}rt(hEUhK}ru(hM]hN]hO]hP]hR]uhFjch@]rvhb)rw}rx(hEX1.0ryhFjshGjhIhfhK}rz(hM]hN]hO]hP]hR]uhTKh@]r{h^X1.0r|r}}r~(hEjyhFjwubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjch@]rhb)r}r(hEX``GET / and GET /node``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET / and GET /noderr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjch@]rhb)r}r(hEX:func:`getCapabilities`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXgetCapabilitiesU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^XgetCapabilities()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjch@]rhb)r}r(hEX() ``->`` :class:`Types.Node`hFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X() rr}r(hEX() hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.Node`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X Types.Noderr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubehIjubehIjubeubj)r}r(hEUhFjhGNhIjhK}r(hP]hO]hM]hN]hR]Uentries]r(jXping() (in module MNCore)h#UNtrauhTNhUhh@]ubcsphinx.addnodes desc r)r}r(hEUhFjhGNhIUdescrhK}r(UnoindexrUdomainrXpyrhP]hO]hM]hN]hR]UobjtyperXfunctionrUdesctyperjuhTNhUhh@]r(csphinx.addnodes desc_signature r)r}r(hEXping() -> nullhFjhGjhIUdesc_signaturerhK}r(hP]rh#aUmodulerjhO]hM]hN]hR]rh#aUfullnamerXpingrUclassrUUfirstruhTK@hUhh@]r(csphinx.addnodes desc_addname r)r}r(hEXMNCore.hFjhGjhIU desc_addnamerhK}r(hM]hN]hO]hP]hR]uhTK@hUhh@]rh^XMNCore.rr}r(hEUhFjubaubcsphinx.addnodes desc_name r)r}r(hEjhFjhGjhIU desc_namerhK}r(hM]hN]hO]hP]hR]uhTK@hUhh@]rh^Xpingrr}r(hEUhFjubaubcsphinx.addnodes desc_parameterlist r)r}r(hEUhFjhGjhIUdesc_parameterlistrhK}r(hM]hN]hO]hP]hR]uhTK@hUhh@]ubcsphinx.addnodes desc_returns r)r}r(hEXnullhFjhGjhIU desc_returnsrhK}r(hM]hN]hO]hP]hR]uhTK@hUhh@]rh^Xnullrr}r(hEUhFjubaubeubcsphinx.addnodes desc_content r)r}r (hEUhFjhGjhIU desc_contentr hK}r (hM]hN]hO]hP]hR]uhTK@hUhh@]r (hb)r }r(hEXLow level "are you alive" operation. A valid ping response is indicated by a HTTP status of 200. A timestmap indicating the current system time (UTC) on the node MUST be returned in the HTTP Date header.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK#hUhh@]rh^XLow level "are you alive" operation. A valid ping response is indicated by a HTTP status of 200. A timestmap indicating the current system time (UTC) on the node MUST be returned in the HTTP Date header.rr}r(hEjhFj ubaubhb)r}r(hEXThe Member Node should perform some minimal internal functionality testing before answering. However, ping checks will be frequent (every few minutes) so the internal functionality test should not be high impact.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK%hUhh@]rh^XThe Member Node should perform some minimal internal functionality testing before answering. However, ping checks will be frequent (every few minutes) so the internal functionality test should not be high impact.rr}r(hEjhFjubaubhb)r}r(hEX]Any status response other than 200 indicates that the node is offline for DataONE operations.rhFjhGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK'hUhh@]r!h^X]Any status response other than 200 indicates that the node is offline for DataONE operations.r"r#}r$(hEjhFjubaubhb)r%}r&(hEXNote that the timestamp returned in the Date header should follow the semantics as described in the HTTP specifications, http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18hFjhGjhIhfhK}r'(hM]hN]hO]hP]hR]uhTK)hUhh@]r((h^XyNote that the timestamp returned in the Date header should follow the semantics as described in the HTTP specifications, r)r*}r+(hEXyNote that the timestamp returned in the Date header should follow the semantics as described in the HTTP specifications, hFj%ubcdocutils.nodes reference r,)r-}r.(hEX?http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18r/hK}r0(Urefurij/hP]hO]hM]hN]hR]uhFj%h@]r1h^X?http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18r2r3}r4(hEUhFj-ubahIU referencer5ubeubhb)r6}r7(hEXThe response body will be ignored by the caller except in the case of an error, in which case the response body should contain the appropriate DataONE exception.r8hFjhGjhIhfhK}r9(hM]hN]hO]hP]hR]uhTK+hUhh@]r:h^XThe response body will be ignored by the caller except in the case of an error, in which case the response body should contain the appropriate DataONE exception.r;r<}r=(hEj8hFj6ubaubht)r>}r?(hEUhFjhGNhIhwhK}r@(hM]hN]hO]hP]hR]uhTNhUhh@]rA(hz)rB}rC(hEUhFj>hGjhIh}hK}rD(hM]hN]hO]hP]hR]uhTK-hUhh@]rE(h)rF}rG(hEXVersionhFjBhGjhIhhK}rH(hM]hN]hO]hP]hR]uhTKh@]rIh^XVersionrJrK}rL(hEUhFjFubaubh)rM}rN(hEX1.0rOhK}rP(hM]hN]hO]hP]hR]uhFjBh@]rQhb)rR}rS(hEjOhFjMhGjhIhfhK}rT(hM]hN]hO]hP]hR]uhTK-h@]rUh^X1.0rVrW}rX(hEjOhFjRubaubahIhubeubhz)rY}rZ(hEUhFj>hGjhIh}hK}r[(hM]hN]hO]hP]hR]uhTK.hUhh@]r\(h)r]}r^(hEX Use CaseshFjYhGjhIhhK}r_(hM]hN]hO]hP]hR]uhTKh@]r`h^X Use Casesrarb}rc(hEUhFj]ubaubh)rd}re(hEX$:doc:`UC10 `rfhK}rg(hM]hN]hO]hP]hR]uhFjYh@]rhhb)ri}rj(hEjfhFjdhGjhIhfhK}rk(hM]hN]hO]hP]hR]uhTK/h@]rlj)rm}rn(hEjfhFjihGjhIjhK}ro(UreftypeXdocrpjjX/design/UseCases/10_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK/h@]rqcdocutils.nodes inline rr)rs}rt(hEjfhK}ru(hM]hN]rv(jjpehO]hP]hR]uhFjmh@]rwh^XUC10rxry}rz(hEUhFjsubahIUinliner{ubaubaubahIhubeubhz)r|}r}(hEUhFj>hGjhIh}hK}r~(hM]hN]hO]hP]hR]uhTK0hUhh@]r(h)r}r(hEXREST URLhFj|hGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XREST URLrr}r(hEUhFjubaubh)r}r(hEX``GET /monitor/ping``rhK}r(hM]hN]hO]hP]hR]uhFj|h@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK0h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /monitor/pingrr}r(hEUhFjubahIjubaubahIhubeubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(h)r}r(hEXReturnshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XReturnsrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXNull body or Exception. The body of the message may be ignored by the caller. The HTTP header Date MUST be set in the response.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(h^X^Null body or Exception. The body of the message may be ignored by the caller. The HTTP header rr}r(hEX^Null body or Exception. The body of the message may be ignored by the caller. The HTTP header hFjubj)r}r(hEX*Date*hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XDaterr}r(hEUhFjubahIjubh^X MUST be set in the response.rr}r(hEX MUST be set in the response.hFjubehIhfubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(h)r}r(hEX Return typehFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X Return typerr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXnullhK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEUhK}r(UreftypeUobjrU refspecificrU reftargetXnullU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rh^Xnullrr}r(hEUhFjubahIjubahIhfubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(h)r}r(hEXRaiseshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XRaisesrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rcdocutils.nodes bullet_list r)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(cdocutils.nodes list_item r)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXExceptions.NotImplemented -- (errorCode=501, detailCode=2041)Ping is a required operation and so an operational member node should never return this exception unless under development.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypeUexcrjU reftargetXExceptions.NotImplementedrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rcsphinx.addnodes literal_strong r)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.NotImplementedrr}r(hEUhFjubahIUliteral_strongrubahIjubh^X -- rr}r(hEUhFjubhb)r}r(hEX$``(errorCode=501, detailCode=2041)``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK4h@]rj)r}r(hEjhK}r (hM]hN]hO]hP]hR]uhFjh@]r h^X (errorCode=501, detailCode=2041)r r }r (hEUhFjubahIjubaubhb)r}r(hEX{Ping is a required operation and so an operational member node should never return this exception unless under development.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK6h@]rh^X{Ping is a required operation and so an operational member node should never return this exception unless under development.rr}r(hEjhFjubaubehIhfubahIU list_itemrubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXExceptions.ServiceFailure -- (errorCode=500, detailCode=2042)A ServiceFailure exception indicates that the node is not currently operational as a member node. A coordinating node or monitoring service may use this as an indication that the member node should be taken out of the pool of active nodes, though ping should be called on a regular basis to determine when the node might b ready to resume normal operations.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r (hEUhK}r!(UreftypejjU reftargetXExceptions.ServiceFailurer"U refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]r#j)r$}r%(hEj"hK}r&(hM]hN]hO]hP]hR]uhFjh@]r'h^XExceptions.ServiceFailurer(r)}r*(hEUhFj$ubahIjubahIjubh^X -- r+r,}r-(hEUhFjubhb)r.}r/(hEX$``(errorCode=500, detailCode=2042)``r0hFjhGjhIhfhK}r1(hM]hN]hO]hP]hR]uhTK8h@]r2j)r3}r4(hEj0hK}r5(hM]hN]hO]hP]hR]uhFj.h@]r6h^X (errorCode=500, detailCode=2042)r7r8}r9(hEUhFj3ubahIjubaubhb)r:}r;(hEXeA ServiceFailure exception indicates that the node is not currently operational as a member node. A coordinating node or monitoring service may use this as an indication that the member node should be taken out of the pool of active nodes, though ping should be called on a regular basis to determine when the node might b ready to resume normal operations.r<hFjhGjhIhfhK}r=(hM]hN]hO]hP]hR]uhTK:h@]r>h^XeA ServiceFailure exception indicates that the node is not currently operational as a member node. A coordinating node or monitoring service may use this as an indication that the member node should be taken out of the pool of active nodes, though ping should be called on a regular basis to determine when the node might b ready to resume normal operations.r?r@}rA(hEj<hFj:ubaubehIhfubahIjubj)rB}rC(hEUhK}rD(hM]hN]hO]hP]hR]uhFjh@]rEhb)rF}rG(hEXExceptions.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.hK}rH(hM]hN]hO]hP]hR]uhFjBh@]rI(j)rJ}rK(hEUhK}rL(UreftypejjU reftargetX Exceptions.InsufficientResourcesrMU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjFh@]rNj)rO}rP(hEjMhK}rQ(hM]hN]hO]hP]hR]uhFjJh@]rRh^X Exceptions.InsufficientResourcesrSrT}rU(hEUhFjOubahIjubahIjubh^X -- rVrW}rX(hEUhFjFubhb)rY}rZ(hEX$``(errorCode=413, detailCode=2045)``r[hFjFhGjhIhfhK}r\(hM]hN]hO]hP]hR]uhTKh@]rih^XA 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.rjrk}rl(hEjghFjeubaubehIhfubahIjubehIU bullet_listrmubahIhubehIh}ubeubeubeubcdocutils.nodes block_quote rn)ro}rp(hEUhFjhGNhIU block_quoterqhK}rr(hM]hN]hO]hP]hR]uhTNhUhh@]rs(hb)rt}ru(hEX **Response**rvhFjohGjXsource/apis/examples/ping.txtrwrx}rybhIhfhK}rz(hM]hN]hO]hP]hR]uhTKh@]r{cdocutils.nodes strong r|)r}}r~(hEjvhK}r(hM]hN]hO]hP]hR]uhFjth@]rh^XResponserr}r(hEUhFj}ubahIUstrongrubaubhb)r}r(hEXaThe 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.rhFjohGjxhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XaThe 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.rr}r(hEjhFjubaubhb)r}r(hEX **Example**rhFjohGjxhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]rj|)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExamplerr}r(hEUhFjubahIjubaubhb)r}r(hEXMExample 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.hFjohGjxhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]r(h^XExample 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 rr}r(hEXExample 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 hFjubj)r}r(hEX``Date``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XDaterr}r(hEUhFjubahIjubh^Xk entry. However, in order to fully support clients that may cache the response, it is recommended that the rr}r(hEXk entry. However, in order to fully support clients that may cache the response, it is recommended that the hFjubj)r}r(hEX ``Expires``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExpiresrr}r(hEUhFjubahIjubh^X, and rr}r(hEX, and hFjubj)r}r(hEX``Cache-Control``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X Cache-Controlrr}r(hEUhFjubahIjubh^X headers are returned.rr}r(hEX headers are returned.hFjubeubcdocutils.nodes literal_block r)r}r(hEXexport 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 LoghFjhGjhIjhK}r(hP]rhajjhO]hM]hN]hR]rhajX getLogRecordsrjUjuhTK~hUhh@]r(j)r}r(hEXMNCore.hFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTK~hUhh@]rh^XMNCore.rr}r(hEUhFjubaubj)r}r(hEjhFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTK~hUhh@]rh^X getLogRecordsrr}r(hEUhFjubaubj)r}r(hEXKsession, [fromDate], [toDate], [event], [idFilter], [start=0], [count=1000]hFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTK~hUhh@]r(csphinx.addnodes desc_parameter r)r}r(hEXsessionhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIUdesc_parameterrubcsphinx.addnodes desc_optional r)r}r(hEX [fromDate]hK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEXfromDatehK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XfromDaterr}r(hEUhFjubahIjubahIU desc_optionalrubj)r}r(hEX[toDate]hK}r (hM]hN]hO]hP]hR]uhFjh@]r j)r }r (hEXtoDatehK}r (hM]hN]hO]hP]hR]uhFjh@]rh^XtoDaterr}r(hEUhFj ubahIjubahIjubj)r}r(hEX[event]hK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEXeventhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xeventrr}r(hEUhFjubahIjubahIjubj)r}r(hEX [idFilter]hK}r(hM]hN]hO]hP]hR]uhFjh@]r j)r!}r"(hEXidFilterhK}r#(hM]hN]hO]hP]hR]uhFjh@]r$h^XidFilterr%r&}r'(hEUhFj!ubahIjubahIjubj)r(}r)(hEX [start=0]hK}r*(hM]hN]hO]hP]hR]uhFjh@]r+j)r,}r-(hEXstart=0hK}r.(hM]hN]hO]hP]hR]uhFj(h@]r/h^Xstart=0r0r1}r2(hEUhFj,ubahIjubahIjubj)r3}r4(hEX [count=1000]hK}r5(hM]hN]hO]hP]hR]uhFjh@]r6j)r7}r8(hEX count=1000hK}r9(hM]hN]hO]hP]hR]uhFj3h@]r:h^X count=1000r;r<}r=(hEUhFj7ubahIjubahIjubeubj)r>}r?(hEXLoghFjhGjhIjhK}r@(hM]hN]hO]hP]hR]uhTK~hUhh@]rAh^XLogrBrC}rD(hEUhFj>ubaubeubj)rE}rF(hEUhFjhGjhIj hK}rG(hM]hN]hO]hP]hR]uhTK~hUhh@]rH(hb)rI}rJ(hEXtRetrieve log information from the Member Node for the specified slice parameters. Log entries will only return PIDs.rKhFjEhGjhIhfhK}rL(hM]hN]hO]hP]hR]uhTKHhUhh@]rMh^XtRetrieve log information from the Member Node for the specified slice parameters. Log entries will only return PIDs.rNrO}rP(hEjKhFjIubaubhb)rQ}rR(hEXThis method is used primarily by the log aggregator to generate aggregate statistics for nodes, objects, and the methods of access.rShFjEhGjhIhfhK}rT(hM]hN]hO]hP]hR]uhTKJhUhh@]rUh^XThis method is used primarily by the log aggregator to generate aggregate statistics for nodes, objects, and the methods of access.rVrW}rX(hEjShFjQubaubhb)rY}rZ(hEXVThe response MUST contain only records for which the requestor has permission to read.r[hFjEhGjhIhfhK}r\(hM]hN]hO]hP]hR]uhTKLhUhh@]r]h^XVThe response MUST contain only records for which the requestor has permission to read.r^r_}r`(hEj[hFjYubaubhb)ra}rb(hEXxNote that date time precision is limited to one millisecond. If no timezone information is provided UTC will be assumed.rchFjEhGjhIhfhK}rd(hM]hN]hO]hP]hR]uhTKNhUhh@]reh^XxNote that date time precision is limited to one millisecond. If no timezone information is provided UTC will be assumed.rfrg}rh(hEjchFjaubaubhb)ri}rj(hEXAccess control for this method MUST be configured to allow calling by Coordinating Nodes and MAY be configured to allow more general access.rkhFjEhGjhIhfhK}rl(hM]hN]hO]hP]hR]uhTKPhUhh@]rmh^XAccess control for this method MUST be configured to allow calling by Coordinating Nodes and MAY be configured to allow more general access.rnro}rp(hEjkhFjiubaubhb)rq}rr(hEXXv2.0: The event parameter has changed from :class:`v1_0.Types.Event` to a plain *string*hFjEhGjhIhfhK}rs(hM]hN]hO]hP]hR]uhTKRhUhh@]rt(h^X+v2.0: The event parameter has changed from rurv}rw(hEX+v2.0: The event parameter has changed from hFjqubj)rx}ry(hEX:class:`v1_0.Types.Event`rzhFjqhGjhIjhK}r{(UreftypeXclassjjXv1_0.Types.EventU refdomainXpyr|hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKRh@]r}j)r~}r(hEjzhK}r(hM]hN]r(jj|Xpy-classrehO]hP]hR]uhFjxh@]rh^Xv1_0.Types.Eventrr}r(hEUhFj~ubahIjubaubh^X to a plain rr}r(hEX to a plain hFjqubj)r}r(hEX*string*hK}r(hM]hN]hO]hP]hR]uhFjqh@]rh^Xstringrr}r(hEUhFjubahIjubeubhb)r}r(hEX;v2.0: The structure of :class:`v2_0.Types.Log` has changed.hFjEhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKThUhh@]r(h^Xv2.0: The structure of rr}r(hEXv2.0: The structure of hFjubj)r}r(hEX:class:`v2_0.Types.Log`rhFjhGjhIjhK}r(UreftypeXclassjjXv2_0.Types.LogU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKTh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xv2_0.Types.Logrr}r(hEUhFjubahIjubaubh^X has changed.rr}r(hEX has changed.hFjubeubht)r}r(hEUhFjEhGNhIhwhK}r(hM]hN]hO]hP]hR]uhTNhUhh@]r(hz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKVhUhh@]r(h)r}r(hEXVersionhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XVersionrr}r(hEUhFjubaubh)r}r(hEX1.0, 2.0rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKVh@]rh^X1.0, 2.0rr}r(hEjhFjubaubahIhubeubhz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKWhUhh@]r(h)r}r(hEXREST URLhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XREST URLrr}r(hEUhFjubaubh)r}r(hEXz``GET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]``rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKWh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XvGET /log?[fromDate={fromDate}][&toDate={toDate}][&event={event}][&idFilter={idFilter}][&start={start}][&count={count}]rr}r(hEUhFjubahIjubaubahIhubeubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEX ParametershFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X Parametersrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTsession (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.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEXsessionhK}r(hP]hO]jhM]hN]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubh^X (rr}r(hEUhFjubj)r}r(hEX:class:`Types.Session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKYh@]r j)r }r (hEjhK}r (hM]hN]r(jj Xpy-classrehO]hP]hR]uhFjh@]rh^X Types.Sessionrr}r(hEUhFj ubahIjubaubh^X)r}r(hEUhFjubh^X -- rr}r(hEUhFjubh^XSession 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(hEXSession 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 hFjubj)r}r(hEX:term:`public user`rhFjhGjhIjhK}r(UreftypeXtermjjX public userU refdomainXstdr hP]hO]U refexplicithM]hN]hR]jjuhTKXh@]r!jr)r"}r#(hEjhK}r$(hM]hN]r%(jj Xstd-termr&ehO]hP]hR]uhFjh@]r'h^X public userr(r)}r*(hEUhFj"ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r+r,}r-(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFjubehIhfubahIjubj)r.}r/(hEUhK}r0(hM]hN]hO]hP]hR]uhFjh@]r1hb)r2}r3(hEXfromDate (Types.DateTime) -- Records with time stamp greater than or equal to (>=) this value will be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r4(hM]hN]hO]hP]hR]uhFj.h@]r5(j)r6}r7(hEXfromDatehK}r8(hP]hO]jhM]hN]hR]uhFj2h@]r9h^XfromDater:r;}r<(hEUhFj6ubahIjubh^X (r=r>}r?(hEUhFj2ubj)r@}rA(hEX:class:`Types.DateTime`rBhFj2hGjhIjhK}rC(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrDhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK\h@]rEj)rF}rG(hEjBhK}rH(hM]hN]rI(jjDXpy-classrJehO]hP]hR]uhFj@h@]rKh^XTypes.DateTimerLrM}rN(hEUhFjFubahIjubaubh^X)rO}rP(hEUhFj2ubh^X -- rQrR}rS(hEUhFj2ubh^XRecords with time stamp greater than or equal to (>=) this value will be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.rTrU}rV(hEXRecords with time stamp greater than or equal to (>=) this value will be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj2ubehIhfubahIjubj)rW}rX(hEUhK}rY(hM]hN]hO]hP]hR]uhFjh@]rZhb)r[}r\(hEXtoDate (Types.DateTime) -- Records with a time stamp 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.hK}r](hM]hN]hO]hP]hR]uhFjWh@]r^(j)r_}r`(hEXtoDatehK}ra(hP]hO]jhM]hN]hR]uhFj[h@]rbh^XtoDatercrd}re(hEUhFj_ubahIjubh^X (rfrg}rh(hEUhFj[ubj)ri}rj(hEX:class:`Types.DateTime`rkhFj[hGjhIjhK}rl(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrmhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK_h@]rnj)ro}rp(hEjkhK}rq(hM]hN]rr(jjmXpy-classrsehO]hP]hR]uhFjih@]rth^XTypes.DateTimerurv}rw(hEUhFjoubahIjubaubh^X)rx}ry(hEUhFj[ubh^X -- rzr{}r|(hEUhFj[ubh^XhRecords with a time stamp less than (<) this value will be returned. If not specified, then defaults to r}r~}r(hEXhRecords with a time stamp less than (<) this value will be returned. If not specified, then defaults to hFj[ubj)r}r(hEX*now*hK}r(hM]hN]hO]hP]hR]uhFj[h@]rh^Xnowrr}r(hEUhFjubahIjubh^XK. Transmitted as a URL query parameter, and so must be escaped accordingly.rr}r(hEXK. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj[ubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXevent (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.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEXeventhK}r(hP]hO]jhM]hN]hR]uhFjh@]rh^Xeventrr}r(hEUhFjubahIjubh^X (rr}r(hEUhFjubj)r}r(hEX:class:`Types.Event, string`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.Event, stringU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKbh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.Event, stringrr}r(hEUhFjubahIjubaubh^X)r}r(hEUhFjubh^X -- rr}r(hEUhFjubh^XEReturn only log records for the specified type of event. Default is rr}r(hEXEReturn only log records for the specified type of event. Default is hFjubj)r}r(hEX*all*hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xallrr}r(hEUhFjubahIjubh^XK. Transmitted as a URL query parameter, and so must be escaped accordingly.rr}r(hEXK. Transmitted as a URL query parameter, and so must be escaped accordingly.hFjubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX9idFilter (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 Member Node implementation with no warning. Accepts PIDs and SIDs Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEXidFilterhK}r(hP]hO]jhM]hN]hR]uhFjh@]rh^XidFilterrr}r(hEUhFjubahIjubh^X (rr}r(hEUhFjubj)r}r(hEUhK}r(UreftypejjU reftargetXstringrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rcsphinx.addnodes literal_emphasis r)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xstringrr}r(hEUhFjubahIUliteral_emphasisrubahIjubh^X)r}r(hEUhFjubh^X -- rr}r(hEUhFjubh^X$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 Member Node implementation with no warning. Accepts PIDs and SIDs Transmitted as a URL query parameter, and so must be escaped accordingly.rr}r(hEX$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 Member Node implementation with no warning. Accepts PIDs and SIDs Transmitted as a URL query parameter, and so must be escaped accordingly.hFjubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXstart=0 (integer) -- Optional zero based offset from the first record in the set of matching log records. Used to assist with paging the response. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEXstart=0hK}r(hP]hO]jhM]hN]hR]uhFjh@]rh^Xstart=0rr}r(hEUhFjubahIjubh^X (rr}r(hEUhFjubj)r}r(hEUhK}r(UreftypejjU reftargetXintegerrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xintegerrr}r(hEUhFjubahIjubahIjubh^X)r}r(hEUhFjubh^X -- rr}r(hEUhFjubh^XOptional zero based offset from the first record in the set of matching log records. Used to assist with paging the response. Transmitted as a URL query parameter, and so must be escaped accordingly.rr }r (hEXOptional zero based offset from the first record in the set of matching log records. Used to assist with paging the response. Transmitted as a URL query parameter, and so must be escaped accordingly.hFjubehIhfubahIjubj)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX3count=1000 (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.hK}r(hM]hN]hO]hP]hR]uhFj h@]r(j)r}r(hEX count=1000hK}r(hP]hO]jhM]hN]hR]uhFjh@]rh^X count=1000rr}r(hEUhFjubahIjubh^X (rr}r(hEUhFjubj)r}r(hEUhK}r(UreftypejjU reftargetXintegerr U refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]r!j)r"}r#(hEj hK}r$(hM]hN]hO]hP]hR]uhFjh@]r%h^Xintegerr&r'}r((hEUhFj"ubahIjubahIjubh^X)r)}r*(hEUhFjubh^X -- r+r,}r-(hEUhFjubh^XThe 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/}r0(hEXThe maximum number of log records that should be returned in the response. The Member Node may return fewer and the caller should check the hFjubj)r1}r2(hEX*total*hK}r3(hM]hN]hO]hP]hR]uhFjh@]r4h^Xtotalr5r6}r7(hEUhFj1ubahIjubh^X in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.r8r9}r:(hEX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hFjubehIhfubahIjubehIjmubahIhubehIh}ubhz)r;}r<(hEUhK}r=(hM]hN]hO]hP]hR]uhFjh@]r>(h)r?}r@(hEXReturnshFj;hGjhIhhK}rA(hM]hN]hO]hP]hR]uhTKh@]rBh^XReturnsrCrD}rE(hEUhFj?ubaubh)rF}rG(hEUhK}rH(hM]hN]hO]hP]hR]uhFj;h@]rIhb)rJ}rK(hEUhK}rL(hM]hN]hO]hP]hR]uhFjFh@]hIhfubahIhubehIh}ubhz)rM}rN(hEUhK}rO(hM]hN]hO]hP]hR]uhFjh@]rP(h)rQ}rR(hEX Return typehFjMhGjhIhhK}rS(hM]hN]hO]hP]hR]uhTKh@]rTh^X Return typerUrV}rW(hEUhFjQubaubh)rX}rY(hEUhK}rZ(hM]hN]hO]hP]hR]uhFjMh@]r[hb)r\}r](hEX Types.LoghK}r^(hM]hN]hO]hP]hR]uhFjXh@]r_j)r`}ra(hEX:class:`Types.Log`rbhFj\hGjhIjhK}rc(UreftypeXclassjjX Types.LogU refdomainXpyrdhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKnh@]rej)rf}rg(hEjbhK}rh(hM]hN]ri(jjdXpy-classrjehO]hP]hR]uhFj`h@]rkh^X Types.Logrlrm}rn(hEUhFjfubahIjubaubahIhfubahIhubehIh}ubhz)ro}rp(hEUhK}rq(hM]hN]hO]hP]hR]uhFjh@]rr(h)rs}rt(hEXRaiseshFjohGjhIhhK}ru(hM]hN]hO]hP]hR]uhTKh@]rvh^XRaisesrwrx}ry(hEUhFjsubaubh)rz}r{(hEUhK}r|(hM]hN]hO]hP]hR]uhFjoh@]r}j)r~}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjzh@]r(j)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj~h@]rhb)r}r(hEXExceptions.NotAuthorized -- (errorCode=401, detailCode=1460)Raised if the user making the request is not authorized to access the log records. This is determined by the policy of the Member Node.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.NotAuthorizedrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.NotAuthorizedrr}r(hEUhFjubahIjubahIjubh^X -- rr}r(hEUhFjubhb)r}r(hEX$``(errorCode=401, detailCode=1460)``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKph@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X (errorCode=401, detailCode=1460)rr}r(hEUhFjubahIjubaubhb)r}r(hEXRaised if the user making the request is not authorized to access the log records. This is determined by the policy of the Member Node.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKrh@]rh^XRaised if the user making the request is not authorized to access the log records. This is determined by the policy of the Member Node.rr}r(hEjhFjubaubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj~h@]rhb)r}r(hEXExceptions.InvalidRequest -- (errorCode=400, detailCode=1480)The request parameters were malformed or an invalid date range was specified.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.InvalidRequestrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.InvalidRequestrr}r(hEUhFjubahIjubahIjubh^X -- rr}r(hEUhFjubhb)r}r(hEX$``(errorCode=400, detailCode=1480)``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKth@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X (errorCode=400, detailCode=1480)rr}r(hEUhFjubahIjubaubhb)r}r(hEXMThe request parameters were malformed or an invalid date range was specified.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKvh@]rh^XMThe request parameters were malformed or an invalid date range was specified.rr}r(hEjhFjubaubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj~h@]rhb)r}r(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1490)hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.ServiceFailurerU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.ServiceFailurerr}r(hEUhFjubahIjubahIjubh^X -- rr}r(hEUhFjubj)r}r(hEX$``(errorCode=500, detailCode=1490)``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X (errorCode=500, detailCode=1490)rr}r(hEUhFjubahIjubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj~h@]rhb)r}r(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1470)hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.InvalidTokenrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.InvalidTokenrr}r (hEUhFjubahIjubahIjubh^X -- r r }r (hEUhFjubj)r }r(hEX$``(errorCode=401, detailCode=1470)``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X (errorCode=401, detailCode=1470)rr}r(hEUhFj ubahIjubehIhfubahIjubj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj~h@]rhb)r}r(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1461)hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.NotImplementedrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]r j)r!}r"(hEjhK}r#(hM]hN]hO]hP]hR]uhFjh@]r$h^XExceptions.NotImplementedr%r&}r'(hEUhFj!ubahIjubahIjubh^X -- r(r)}r*(hEUhFjubj)r+}r,(hEX$``(errorCode=501, detailCode=1461)``hK}r-(hM]hN]hO]hP]hR]uhFjh@]r.h^X (errorCode=501, detailCode=1461)r/r0}r1(hEUhFj+ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubjn)r2}r3(hEUhFjhGX=internal padding after source/apis/examples/getLogRecords.txtr4hIjqhK}r5(hM]hN]hO]hP]hR]uhTNhUhh@]r6(hb)r7}r8(hEX **Example**r9hFj2hGjX&source/apis/examples/getLogRecords.txtr:r;}r<bhIhfhK}r=(hM]hN]hO]hP]hR]uhTKh@]r>j|)r?}r@(hEj9hK}rA(hM]hN]hO]hP]hR]uhFj7h@]rBh^XExamplerCrD}rE(hEUhFj?ubahIjubaubhb)rF}rG(hEXExample of retrieving 3 log records from a Member Node. The *xml* command is provided by xmlstarlet_ and is used to format the output.hFj2hGj;hIhfhK}rH(hM]hN]hO]hP]hR]uhTKh@]rI(h^X<Example of retrieving 3 log records from a Member Node. The rJrK}rL(hEX<Example of retrieving 3 log records from a Member Node. The hFjFubj)rM}rN(hEX*xml*hK}rO(hM]hN]hO]hP]hR]uhFjFh@]rPh^XxmlrQrR}rS(hEUhFjMubahIjubh^X command is provided by rTrU}rV(hEX command is provided by hFjFubj,)rW}rX(hEX xmlstarlet_UresolvedrYKhFjFhIj5hK}rZ(UnameX xmlstarletr[Urefurir\Xhttp://xmlstar.sourceforge.net/r]hP]hO]hM]hN]hR]uh@]r^h^X xmlstarletr_r`}ra(hEUhFjWubaubh^X" and is used to format the output.rbrc}rd(hEX" and is used to format the output.hFjFubeubcdocutils.nodes target re)rf}rg(hEX/.. _xmlstarlet: http://xmlstar.sourceforge.net/U referencedrhKhFj2hIUtargetrihK}rj(j\j]hP]rkh9ahO]hM]hN]hR]rlhauhTMh@]ubj)rm}rn(hEXexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k -s "$NODE/v1/log?start=0&count=3" | xml fo 1 MNodeTierTests.201260152556757. 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:25:58.104+00:00 urn:node:DEMO2 2 TierTesting:testObject:RightsHolder_Person.4 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:26:38.828+00:00 urn:node:DEMO2 3 TierTesting:testObject:RightsHolder_Group.4 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:27:40.255+00:00 urn:node:DEMO2 hFj2hIjhK}ro(hhhP]hO]hM]hN]hR]uhTMh@]rph^Xexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k -s "$NODE/v1/log?start=0&count=3" | xml fo 1 MNodeTierTests.201260152556757. 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:25:58.104+00:00 urn:node:DEMO2 2 TierTesting:testObject:RightsHolder_Person.4 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:26:38.828+00:00 urn:node:DEMO2 3 TierTesting:testObject:RightsHolder_Group.4 129.24.0.17 null CN=testSubmitter,DC=dataone,DC=org create 2012-02-29T23:27:40.255+00:00 urn:node:DEMO2 rqrr}rs(hEUhFjmubaubeubj)rt}ru(hEUhFjhGNhIjhK}rv(hP]hO]hM]hN]hR]Uentries]rw(jX$getCapabilities() (in module MNCore)h)UNtrxauhTNhUhh@]ubj)ry}rz(hEUhFjhGNhIjhK}r{(jjXpyr|hP]hO]hM]hN]hR]jXfunctionr}jj}uhTNhUhh@]r~(j)r}r(hEXgetCapabilities() -> NodehFjyhGjhIjhK}r(hP]rh)ajjhO]hM]hN]hR]rh)ajXgetCapabilitiesrjUjuhTKhUhh@]r(j)r}r(hEXMNCore.hFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]rh^XMNCore.rr}r(hEUhFjubaubj)r}r(hEjhFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]rh^XgetCapabilitiesrr}r(hEUhFjubaubj)r}r(hEUhFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]ubj)r}r(hEXNodehFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]rh^XNoderr}r(hEUhFjubaubeubj)r}r(hEUhFjyhGjhIj hK}r(hM]hN]hO]hP]hR]uhTKhUhh@]r(hb)r}r(hEXBReturns a document describing the capabilities of the Member Node.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]rh^XBReturns a document describing the capabilities of the Member Node.rr}r(hEjhFjubaubhb)r}r(hEXThe response at the Member Node base URL is for convenience only. Clients of Member Nodes SHOULD use the /node URL to retrieve the node capabilities document.rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKhUhh@]rh^XThe response at the Member Node base URL is for convenience only. Clients of Member Nodes SHOULD use the /node URL to retrieve the node capabilities document.rr}r(hEjhFjubaubht)r}r(hEUhFjhGNhIhwhK}r(hM]hN]hO]hP]hR]uhTNhUhh@]r(hz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKhUhh@]r(h)r}r(hEXVersionhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XVersionrr}r(hEUhFjubaubh)r}r(hEX1.0rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0rr}r(hEjhFjubaubahIhubeubhz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKhUhh@]r(h)r}r(hEXREST URLhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XREST URLrr}r(hEUhFjubaubh)r}r(hEX``GET / and GET /node``rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET / and GET /noderr}r(hEUhFjubahIjubaubahIhubeubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEXReturnshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XReturnsrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX-The technical capabilities of the Member NodehK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X-The technical capabilities of the Member Noderr}r(hEX-The technical capabilities of the Member NodehFjubahIhfubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEX Return typehFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X Return typerr}r(hEUhFjubaubh)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r }r(hEX Types.NodehK}r(hM]hN]hO]hP]hR]uhFj h@]rj)r}r(hEX:class:`Types.Node`rhFj hGjhIjhK}r(UreftypeXclassjjX Types.NodeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X Types.Noderr}r(hEUhFjubahIjubaubahIhfubahIhubehIh}ubhz)r }r!(hEUhK}r"(hM]hN]hO]hP]hR]uhFjh@]r#(h)r$}r%(hEXRaiseshFj hGjhIhhK}r&(hM]hN]hO]hP]hR]uhTKh@]r'h^XRaisesr(r)}r*(hEUhFj$ubaubh)r+}r,(hEUhK}r-(hM]hN]hO]hP]hR]uhFj h@]r.j)r/}r0(hEUhK}r1(hM]hN]hO]hP]hR]uhFj+h@]r2(j)r3}r4(hEUhK}r5(hM]hN]hO]hP]hR]uhFj/h@]r6hb)r7}r8(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2160)hK}r9(hM]hN]hO]hP]hR]uhFj3h@]r:(j)r;}r<(hEUhK}r=(UreftypejjU reftargetXExceptions.NotImplementedr>U refdomainj|hP]hO]U refexplicithM]hN]hR]uhFj7h@]r?j)r@}rA(hEj>hK}rB(hM]hN]hO]hP]hR]uhFj;h@]rCh^XExceptions.NotImplementedrDrE}rF(hEUhFj@ubahIjubahIjubh^X -- rGrH}rI(hEUhFj7ubj)rJ}rK(hEX$``(errorCode=501, detailCode=2160)``hK}rL(hM]hN]hO]hP]hR]uhFj7h@]rMh^X (errorCode=501, detailCode=2160)rNrO}rP(hEUhFjJubahIjubehIhfubahIjubj)rQ}rR(hEUhK}rS(hM]hN]hO]hP]hR]uhFj/h@]rThb)rU}rV(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2162)hK}rW(hM]hN]hO]hP]hR]uhFjQh@]rX(j)rY}rZ(hEUhK}r[(UreftypejjU reftargetXExceptions.ServiceFailurer\U refdomainj|hP]hO]U refexplicithM]hN]hR]uhFjUh@]r]j)r^}r_(hEj\hK}r`(hM]hN]hO]hP]hR]uhFjYh@]rah^XExceptions.ServiceFailurerbrc}rd(hEUhFj^ubahIjubahIjubh^X -- rerf}rg(hEUhFjUubj)rh}ri(hEX$``(errorCode=500, detailCode=2162)``hK}rj(hM]hN]hO]hP]hR]uhFjUh@]rkh^X (errorCode=500, detailCode=2162)rlrm}rn(hEUhFjhubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubjn)ro}rp(hEUhFjhGXBinternal padding after source/apis/examples/mn_getCapabilities.txtrqhIjqhK}rr(hM]hN]hO]hP]hR]uhTNhUhh@]rs(hb)rt}ru(hEX **Example**rvhFjohGjX+source/apis/examples/mn_getCapabilities.txtrwrx}rybhIhfhK}rz(hM]hN]hO]hP]hR]uhTKh@]r{j|)r|}r}(hEjvhK}r~(hM]hN]hO]hP]hR]uhFjth@]rh^XExamplerr}r(hEUhFj|ubahIjubaubj)r}r(hEXexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k -s "$NODE/v1/node" | xml fo urn:node:DEMO2 DEMO2 Metacat Node A DataONE member node implemented in Metacat. https://demo2.test.dataone.org:443/knb/d1/mn 2012-03-06T14:57:39.851+00:00 2012-03-06T14:57:39.851+00:00 CN=urn:node:DEMO2, DC=dataone, DC=org CN=METACAT1, DC=dataone, DC=org hFjohIjhK}r(hhhP]hO]hM]hN]hR]uhTMh@]rh^Xexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k -s "$NODE/v1/node" | xml fo urn:node:DEMO2 DEMO2 Metacat Node A DataONE member node implemented in Metacat. https://demo2.test.dataone.org:443/knb/d1/mn 2012-03-06T14:57:39.851+00:00 2012-03-06T14:57:39.851+00:00 CN=urn:node:DEMO2, DC=dataone, DC=org CN=METACAT1, DC=dataone, DC=org rr}r(hEUhFjubaubeubeubhB)r}r(hEUhFhChGhHhIhJhK}r(hM]hN]hO]hP]r(X module-MNReadrh5ehR]rhauhTKdhUhh@]r(hW)r}r(hEXRead APIrhFjhGhHhIh[hK}r(hM]hN]hO]hP]hR]uhTKdhUhh@]rh^XRead APIrr}r(hEjhFjubaubj)r}r(hEUhFjhGhHhIjhK}r(hP]hO]hM]hN]hR]Uentries]r(jXMNRead (module)X module-MNReadUNtrauhTNhUhh@]ubhb)r}r(hEXfThe *MNRead* API implements methods that enable object management operations on a :term:`Member Node`.hFjhGhHhIhfhK}r(hM]hN]hO]hP]hR]uhTKihUhh@]r(h^XThe rr}r(hEXThe hFjubj)r}r(hEX*MNRead*hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XMNReadrr}r(hEUhFjubahIjubh^XF API implements methods that enable object management operations on a rr}r(hEXF API implements methods that enable object management operations on a hFjubj)r}r(hEX:term:`Member Node`rhFjhGhHhIjhK}r(UreftypeXtermjjX member nodeU refdomainXstdrhP]hO]U refexplicithM]hN]hR]jjuhTKih@]rjr)r}r(hEjhK}r(hM]hN]r(jjXstd-termrehO]hP]hR]uhFjh@]rh^X Member Noderr}r(hEUhFjubahIj{ubaubh^X.r}r(hEX.hFjubeubh)r}r(hEXBWarning: this file is automatically generated. Edits will be losthFjhGjX*source/apis/generated/generated_MNRead.txtrr}rbhIhhK}r(hhhP]hO]hM]hN]hR]uhTKhUhh@]rh^XBWarning: this file is automatically generated. Edits will be lostrr}r(hEUhFjubaubj)r}r(hEUhFjhGNhIjhK}r(hM]hN]hO]hP]rUid3rahR]uhTNhUhh@]r(hW)r}r(hEX"Functions defined in :mod:`MNRead`hK}r(hM]hN]hO]hP]hR]uhFjh@]r(h^XFunctions defined in rr}r(hEXFunctions defined in hFjubj)r}r(hEX :mod:`MNRead`rhFjhGjhIjhK}r(UreftypeXmodjjXMNReadU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjXMNReadruhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-modrehO]hP]hR]uhFjh@]rh^XMNReadrr}r(hEUhFjubahIjubaubehIh[ubj)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolsKuhFjh@]r(j#)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIj'ubj#)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIj'ubj#)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolwidthK uhFjh@]hIj'ubj#)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolwidthK uhFjh@]hIj'ubj#)r}r(hEUhK}r(hP]hO]hM]hN]hR]UcolwidthKuhFjh@]hIj'ubj4)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTierrhFjhGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK h@]r h^XTierr r }r (hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXVersionrhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]rh^XVersionrr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXRESTr hFjhGjhIhfhK}r!(hM]hN]hO]hP]hR]uhTK h@]r"h^XRESTr#r$}r%(hEj hFjubaubahIjKubj>)r&}r'(hEUhK}r((hM]hN]hO]hP]hR]uhFjh@]r)hb)r*}r+(hEXFunctionr,hFj&hGjhIhfhK}r-(hM]hN]hO]hP]hR]uhTK h@]r.h^XFunctionr/r0}r1(hEj,hFj*ubaubahIjKubj>)r2}r3(hEUhK}r4(hM]hN]hO]hP]hR]uhFjh@]r5hb)r6}r7(hEX Parametersr8hFj2hGjhIhfhK}r9(hM]hN]hO]hP]hR]uhTK h@]r:h^X Parametersr;r<}r=(hEj8hFj6ubaubahIjKubehIj|ubahIj}ubj~)r>}r?(hEUhK}r@(hM]hN]hO]hP]hR]uhFjh@]rA(j9)rB}rC(hEUhK}rD(hM]hN]hO]hP]hR]uhFj>h@]rE(j>)rF}rG(hEUhK}rH(hM]hN]hO]hP]hR]uhFjBh@]rIhb)rJ}rK(hEXTier 1rLhFjFhGjhIhfhK}rM(hM]hN]hO]hP]hR]uhTKh@]rNh^XTier 1rOrP}rQ(hEjLhFjJubaubahIjKubj>)rR}rS(hEUhK}rT(hM]hN]hO]hP]hR]uhFjBh@]rUhb)rV}rW(hEX1.0rXhFjRhGjhIhfhK}rY(hM]hN]hO]hP]hR]uhTKh@]rZh^X1.0r[r\}r](hEjXhFjVubaubahIjKubj>)r^}r_(hEUhK}r`(hM]hN]hO]hP]hR]uhFjBh@]rahb)rb}rc(hEX``GET /object/{id}``rdhFj^hGjhIhfhK}re(hM]hN]hO]hP]hR]uhTKh@]rfj)rg}rh(hEjdhK}ri(hM]hN]hO]hP]hR]uhFjbh@]rjh^XGET /object/{id}rkrl}rm(hEUhFjgubahIjubaubahIjKubj>)rn}ro(hEUhK}rp(hM]hN]hO]hP]hR]uhFjBh@]rqhb)rr}rs(hEX :func:`get`rthFjnhGjhIhfhK}ru(hM]hN]hO]hP]hR]uhTKh@]rvj)rw}rx(hEjthFjrhGjhIjhK}ry(UreftypeXfuncjjXgetU refdomainXpyrzhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r{j)r|}r}(hEjthK}r~(hM]hN]r(jjzXpy-funcrehO]hP]hR]uhFjwh@]rh^Xget()rr}r(hEUhFj|ubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjBh@]rhb)r}r(hEXb(:class:`session`, :class:`id`) ``->`` :class:`Types.OctetStream`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`id`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xidrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.OctetStream`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``GET /meta/{id}``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /meta/{id}rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`getSystemMetadata`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXgetSystemMetadataU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r (jjXpy-funcr ehO]hP]hR]uhFjh@]r h^XgetSystemMetadata()r r }r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXe(:class:`session`, :class:`id`) ``->`` :class:`Types.SystemMetadata`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r }r!(hEjhK}r"(hM]hN]r#(jjXpy-classr$ehO]hP]hR]uhFjh@]r%h^Xsessionr&r'}r((hEUhFj ubahIjubaubh^X, r)r*}r+(hEX, hFjubj)r,}r-(hEX:class:`id`r.hFjhGjhIjhK}r/(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr0hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r1j)r2}r3(hEj.hK}r4(hM]hN]r5(jj0Xpy-classr6ehO]hP]hR]uhFj,h@]r7h^Xidr8r9}r:(hEUhFj2ubahIjubaubh^X) r;r<}r=(hEX) hFjubj)r>}r?(hEX``->``hK}r@(hM]hN]hO]hP]hR]uhFjh@]rAh^X->rBrC}rD(hEUhFj>ubahIjubh^X rE}rF(hEX hFjubj)rG}rH(hEX:class:`Types.SystemMetadata`rIhFjhGjhIjhK}rJ(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrKhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rLj)rM}rN(hEjIhK}rO(hM]hN]rP(jjKXpy-classrQehO]hP]hR]uhFjGh@]rRh^XTypes.SystemMetadatarSrT}rU(hEUhFjMubahIjubaubeubahIjKubehIj|ubj9)rV}rW(hEUhK}rX(hM]hN]hO]hP]hR]uhFj>h@]rY(j>)rZ}r[(hEUhK}r\(hM]hN]hO]hP]hR]uhFjVh@]r]hb)r^}r_(hEXTier 1r`hFjZhGjhIhfhK}ra(hM]hN]hO]hP]hR]uhTKh@]rbh^XTier 1rcrd}re(hEj`hFj^ubaubahIjKubj>)rf}rg(hEUhK}rh(hM]hN]hO]hP]hR]uhFjVh@]rihb)rj}rk(hEX1.0rlhFjfhGjhIhfhK}rm(hM]hN]hO]hP]hR]uhTKh@]rnh^X1.0rorp}rq(hEjlhFjjubaubahIjKubj>)rr}rs(hEUhK}rt(hM]hN]hO]hP]hR]uhFjVh@]ruhb)rv}rw(hEX``HEAD /object/{id}``rxhFjrhGjhIhfhK}ry(hM]hN]hO]hP]hR]uhTKh@]rzj)r{}r|(hEjxhK}r}(hM]hN]hO]hP]hR]uhFjvh@]r~h^XHEAD /object/{id}rr}r(hEUhFj{ubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjVh@]rhb)r}r(hEX:func:`describe`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjXdescribeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^X describe()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjVh@]rhb)r}r(hEXg(:class:`session`, :class:`id`) ``->`` :class:`Types.DescribeResponse`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`id`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xidrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.DescribeResponse`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.DescribeResponserr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX?``GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X;GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]r r }r (hEUhFjubahIjubaubahIjKubj>)r }r (hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`getChecksum`rhFj hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjX getChecksumU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^X getChecksum()r r!}r"(hEUhFjubahIjubaubaubahIjKubj>)r#}r$(hEUhK}r%(hM]hN]hO]hP]hR]uhFjh@]r&hb)r'}r((hEXy(:class:`session`, :class:`pid`, ``[checksumAlgorithm]``) ``->`` :class:`Types.Checksum`r)hFj#hGjhIhfhK}r*(hM]hN]hO]hP]hR]uhTK!h@]r+(h^X(r,}r-(hEX(hFj'ubj)r.}r/(hEX:class:`session`r0hFj'hGjhIjhK}r1(UreftypeXclassjjX Types.SessionU refdomainXpyr2hP]hO]U refexplicithM]hN]hR]jjjNjjuhTK!h@]r3j)r4}r5(hEj0hK}r6(hM]hN]r7(jj2Xpy-classr8ehO]hP]hR]uhFj.h@]r9h^Xsessionr:r;}r<(hEUhFj4ubahIjubaubh^X, r=r>}r?(hEX, hFj'ubj)r@}rA(hEX:class:`pid`rBhFj'hGjhIjhK}rC(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrDhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK!h@]rEj)rF}rG(hEjBhK}rH(hM]hN]rI(jjDXpy-classrJehO]hP]hR]uhFj@h@]rKh^XpidrLrM}rN(hEUhFjFubahIjubaubh^X, rOrP}rQ(hEX, hFj'ubj)rR}rS(hEX``[checksumAlgorithm]``hK}rT(hM]hN]hO]hP]hR]uhFj'h@]rUh^X[checksumAlgorithm]rVrW}rX(hEUhFjRubahIjubh^X) rYrZ}r[(hEX) hFj'ubj)r\}r](hEX``->``hK}r^(hM]hN]hO]hP]hR]uhFj'h@]r_h^X->r`ra}rb(hEUhFj\ubahIjubh^X rc}rd(hEX hFj'ubj)re}rf(hEX:class:`Types.Checksum`rghFj'hGjhIjhK}rh(UreftypeXclassjjXTypes.ChecksumU refdomainXpyrihP]hO]U refexplicithM]hN]hR]jjjNjjuhTK!h@]rjj)rk}rl(hEjghK}rm(hM]hN]rn(jjiXpy-classroehO]hP]hR]uhFjeh@]rph^XTypes.Checksumrqrr}rs(hEUhFjkubahIjubaubeubahIjKubehIj|ubj9)rt}ru(hEUhK}rv(hM]hN]hO]hP]hR]uhFj>h@]rw(j>)rx}ry(hEUhK}rz(hM]hN]hO]hP]hR]uhFjth@]r{hb)r|}r}(hEXTier 1r~hFjxhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK"h@]rh^XTier 1rr}r(hEj~hFj|ubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjth@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK#h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjth@]rhb)r}r(hEX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK$h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjth@]rhb)r}r(hEX:func:`listObjects`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK%h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjX listObjectsU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK%h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^X listObjects()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjth@]rhb)r}r(hEX(:class:`session`, :class:`[fromDate]`, :class:`[toDate]`, :class:`[formatId]`, :class:`[identifier]`, ``[replicaStatus]``, ``[start=0]``, ``[count=1000]``) ``->`` :class:`Types.ObjectList`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK&h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX#:class:`[fromDate]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [fromDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX!:class:`[toDate]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X[toDate]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX1:class:`[formatId]`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X [formatId]rr}r(hEUhFjubahIjubaubh^X, rr}r (hEX, hFjubj)r }r (hEX':class:`[identifier]`r hFjhGjhIjhK}r (UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rj)r}r(hEj hK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFj h@]rh^X [identifier]rr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX``[replicaStatus]``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X[replicaStatus]r r!}r"(hEUhFjubahIjubh^X, r#r$}r%(hEX, hFjubj)r&}r'(hEX ``[start=0]``hK}r((hM]hN]hO]hP]hR]uhFjh@]r)h^X [start=0]r*r+}r,(hEUhFj&ubahIjubh^X, r-r.}r/(hEX, hFjubj)r0}r1(hEX``[count=1000]``hK}r2(hM]hN]hO]hP]hR]uhFjh@]r3h^X [count=1000]r4r5}r6(hEUhFj0ubahIjubh^X) r7r8}r9(hEX) hFjubj)r:}r;(hEX``->``hK}r<(hM]hN]hO]hP]hR]uhFjh@]r=h^X->r>r?}r@(hEUhFj:ubahIjubh^X rA}rB(hEX hFjubj)rC}rD(hEX:class:`Types.ObjectList`rEhFjhGjhIjhK}rF(UreftypeXclassjjXTypes.ObjectListU refdomainXpyrGhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK&h@]rHj)rI}rJ(hEjEhK}rK(hM]hN]rL(jjGXpy-classrMehO]hP]hR]uhFjCh@]rNh^XTypes.ObjectListrOrP}rQ(hEUhFjIubahIjubaubeubahIjKubehIj|ubj9)rR}rS(hEUhK}rT(hM]hN]hO]hP]hR]uhFj>h@]rU(j>)rV}rW(hEUhK}rX(hM]hN]hO]hP]hR]uhFjRh@]rYhb)rZ}r[(hEXTier 1r\hFjVhGjhIhfhK}r](hM]hN]hO]hP]hR]uhTK'h@]r^h^XTier 1r_r`}ra(hEj\hFjZubaubahIjKubj>)rb}rc(hEUhK}rd(hM]hN]hO]hP]hR]uhFjRh@]hIjKubj>)re}rf(hEUhK}rg(hM]hN]hO]hP]hR]uhFjRh@]rhhb)ri}rj(hEX``POST /error``rkhFjehGjhIhfhK}rl(hM]hN]hO]hP]hR]uhTK)h@]rmj)rn}ro(hEjkhK}rp(hM]hN]hO]hP]hR]uhFjih@]rqh^X POST /errorrrrs}rt(hEUhFjnubahIjubaubahIjKubj>)ru}rv(hEUhK}rw(hM]hN]hO]hP]hR]uhFjRh@]rxhb)ry}rz(hEX:func:`synchronizationFailed`r{hFjuhGjhIhfhK}r|(hM]hN]hO]hP]hR]uhTK*h@]r}j)r~}r(hEj{hFjyhGjhIjhK}r(UreftypeXfuncjjXsynchronizationFailedU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK*h@]rj)r}r(hEj{hK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFj~h@]rh^XsynchronizationFailed()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjRh@]rhb)r}r(hEXb(:class:`session`, :class:`message`) ``->`` :class:`Types.Boolean`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK+h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK+h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX!:class:`message`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.ExceptionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK+h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xmessagerr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.Boolean`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.BooleanU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK+h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^X Types.Booleanrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubj9)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFj>h@]r(j>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTier 1rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK,h@]rh^XTier 1rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX1.0rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK-h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX``POST /dirtySystemMetadata``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK.h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XPOST /dirtySystemMetadatarr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX:func:`systemMetadataChanged`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK/h@]rj)r}r (hEjhFjhGjhIjhK}r (UreftypeXfuncjjXsystemMetadataChangedU refdomainXpyr hP]hO]U refexplicithM]hN]hR]jjjNjjuhTK/h@]r j)r }r(hEjhK}r(hM]hN]r(jj Xpy-funcrehO]hP]hR]uhFjh@]rh^XsystemMetadataChanged()rr}r(hEUhFj ubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX(:class:`session`, :class:`id`, ``serialVersion``, :class:`dateSysMetaLastModified`) ``->`` booleanrhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK0h@]r(h^X(r}r (hEX(hFjubj)r!}r"(hEX:class:`session`r#hFjhGjhIjhK}r$(UreftypeXclassjjX Types.SessionU refdomainXpyr%hP]hO]U refexplicithM]hN]hR]jjjNjjuhTK0h@]r&j)r'}r((hEj#hK}r)(hM]hN]r*(jj%Xpy-classr+ehO]hP]hR]uhFj!h@]r,h^Xsessionr-r.}r/(hEUhFj'ubahIjubaubh^X, r0r1}r2(hEX, hFjubj)r3}r4(hEX:class:`id`r5hFjhGjhIjhK}r6(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr7hP]hO]U refexplicithM]hN]hR]jjjNjjuhTK0h@]r8j)r9}r:(hEj5hK}r;(hM]hN]r<(jj7Xpy-classr=ehO]hP]hR]uhFj3h@]r>h^Xidr?r@}rA(hEUhFj9ubahIjubaubh^X, rBrC}rD(hEX, hFjubj)rE}rF(hEX``serialVersion``hK}rG(hM]hN]hO]hP]hR]uhFjh@]rHh^X serialVersionrIrJ}rK(hEUhFjEubahIjubh^X, rLrM}rN(hEX, hFjubj)rO}rP(hEX0:class:`dateSysMetaLastModified`rQhFjhGjhIjhK}rR(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrShP]hO]U refexplicithM]hN]hR]jjjNjjuhTK0h@]rTj)rU}rV(hEjQhK}rW(hM]hN]rX(jjSXpy-classrYehO]hP]hR]uhFjOh@]rZh^XdateSysMetaLastModifiedr[r\}r](hEUhFjUubahIjubaubh^X) r^r_}r`(hEX) hFjubj)ra}rb(hEX``->``hK}rc(hM]hN]hO]hP]hR]uhFjh@]rdh^X->rerf}rg(hEUhFjaubahIjubh^X booleanrhri}rj(hEX booleanhFjubeubahIjKubehIj|ubj9)rk}rl(hEUhK}rm(hM]hN]hO]hP]hR]uhFj>h@]rn(j>)ro}rp(hEUhK}rq(hM]hN]hO]hP]hR]uhFjkh@]rrhb)rs}rt(hEXTier 1ruhFjohGjhIhfhK}rv(hM]hN]hO]hP]hR]uhTK1h@]rwh^XTier 1rxry}rz(hEjuhFjsubaubahIjKubj>)r{}r|(hEUhK}r}(hM]hN]hO]hP]hR]uhFjkh@]r~hb)r}r(hEX1.0rhFj{hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK2h@]rh^X1.0rr}r(hEjhFjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjkh@]rhb)r}r(hEX``GET /replica/{pid}``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK3h@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /replica/{pid}rr}r(hEUhFjubahIjubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjkh@]rhb)r}r(hEX:func:`getReplica`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK4h@]rj)r}r(hEjhFjhGjhIjhK}r(UreftypeXfuncjjX getReplicaU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK4h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^X getReplica()rr}r(hEUhFjubahIjubaubaubahIjKubj>)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjkh@]rhb)r}r(hEXc(:class:`session`, :class:`pid`) ``->`` :class:`Types.OctetStream`rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTK5h@]r(h^X(r}r(hEX(hFjubj)r}r(hEX:class:`session`rhFjhGjhIjhK}r(UreftypeXclassjjX Types.SessionU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK5h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubaubh^X, rr}r(hEX, hFjubj)r}r(hEX:class:`pid`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK5h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^Xpidrr}r(hEUhFjubahIjubaubh^X) rr}r(hEX) hFjubj)r}r(hEX``->``hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X->rr}r(hEUhFjubahIjubh^X r}r(hEX hFjubj)r}r(hEX:class:`Types.OctetStream`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK5h@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubeubahIjKubehIj|ubehIjubehIjubeubj)r}r(hEUhFjhGNhIjhK}r(hP]hO]hM]hN]hR]Uentries]r(jXget() (in module MNRead)hUNtrauhTNhUhh@]ubj)r}r(hEUhFjhGNhIjhK}r(jjXpyrhP]hO]hM]hN]hR]jXfunctionrjjuhTNhUhh@]r(j)r}r(hEXget(session,id) -> OctetStreamhFjhGjhIjhK}r(hP]rhajjhO]hM]hN]hR]rhajXgetrjUjuhTKchUhh@]r(j)r}r(hEXMNRead.hFjhGjhIjhK}r (hM]hN]hO]hP]hR]uhTKchUhh@]r h^XMNRead.r r }r (hEUhFjubaubj)r}r(hEjhFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKchUhh@]rh^Xgetrr}r(hEUhFjubaubj)r}r(hEX session, idhFjhGjhIjhK}r(hM]hN]hO]hP]hR]uhTKchUhh@]r(j)r}r(hEXsessionhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^Xsessionrr}r(hEUhFjubahIjubj)r }r!(hEXidhK}r"(hM]hN]hO]hP]hR]uhFjh@]r#h^Xidr$r%}r&(hEUhFj ubahIjubeubj)r'}r((hEX OctetStreamhFjhGjhIjhK}r)(hM]hN]hO]hP]hR]uhTKchUhh@]r*h^X OctetStreamr+r,}r-(hEUhFj'ubaubeubj)r.}r/(hEUhFjhGjhIj hK}r0(hM]hN]hO]hP]hR]uhTKchUhh@]r1(hb)r2}r3(hEXkRetrieve an object identified by *id* from the node. Supports both PIDs and SIDs. SID will return HEAD PID.hFj.hGjhIhfhK}r4(hM]hN]hO]hP]hR]uhTK}r?(hEUhFj9ubahIjubh^XF from the node. Supports both PIDs and SIDs. SID will return HEAD PID.r@rA}rB(hEXF from the node. Supports both PIDs and SIDs. SID will return HEAD PID.hFj2ubeubhb)rC}rD(hEXThe response MUST contain the bytes of the indicated object, and the checksum of the bytes retrieved SHOULD match the :attr:`SystemMetadata.checksum` recorded in the :class:`Types.SystemMetadata` when calling with PID.hFj.hGjhIhfhK}rE(hM]hN]hO]hP]hR]uhTK>hUhh@]rF(h^XvThe response MUST contain the bytes of the indicated object, and the checksum of the bytes retrieved SHOULD match the rGrH}rI(hEXvThe response MUST contain the bytes of the indicated object, and the checksum of the bytes retrieved SHOULD match the hFjCubj)rJ}rK(hEX:attr:`SystemMetadata.checksum`rLhFjChGjhIjhK}rM(UreftypeXattrjjXSystemMetadata.checksumU refdomainXpyrNhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK>h@]rOj)rP}rQ(hEjLhK}rR(hM]hN]rS(jjNXpy-attrrTehO]hP]hR]uhFjJh@]rUh^XSystemMetadata.checksumrVrW}rX(hEUhFjPubahIjubaubh^X recorded in the rYrZ}r[(hEX recorded in the hFjCubj)r\}r](hEX:class:`Types.SystemMetadata`r^hFjChGjhIjhK}r_(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr`hP]hO]U refexplicithM]hN]hR]jjjNjjuhTK>h@]raj)rb}rc(hEj^hK}rd(hM]hN]re(jj`Xpy-classrfehO]hP]hR]uhFj\h@]rgh^XTypes.SystemMetadatarhri}rj(hEUhFjbubahIjubaubh^X when calling with PID.rkrl}rm(hEX when calling with PID.hFjCubeubhb)rn}ro(hEXIf 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.hFj.hGjhIhfhK}rp(hM]hN]hO]hP]hR]uhTK@hUhh@]rq(h^XEIf the object does not exist on the node servicing the request, then rrrs}rt(hEXEIf the object does not exist on the node servicing the request, then hFjnubj)ru}rv(hEX:exc:`Exceptions.NotFound`rwhFjnhGjhIjhK}rx(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyryhP]hO]U refexplicithM]hN]hR]jjjNjjuhTK@h@]rzj)r{}r|(hEjwhK}r}(hM]hN]r~(jjyXpy-excrehO]hP]hR]uhFjuh@]rh^XExceptions.NotFoundrr}r(hEUhFj{ubahIjubaubh^XP must be raised even if the object exists on another node in the DataONE system.rr}r(hEXP must be raised even if the object exists on another node in the DataONE system.hFjnubeubhb)r}r(hEX<Also implmented by Coordinating Nodes as :func:`CNRead.get`.hFj.hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKBhUhh@]r(h^X)Also implmented by Coordinating Nodes as rr}r(hEX)Also implmented by Coordinating Nodes as hFjubj)r}r(hEX:func:`CNRead.get`rhFjhGjhIjhK}r(UreftypeXfuncjjX CNRead.getU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKBh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-funcrehO]hP]hR]uhFjh@]rh^X CNRead.get()rr}r(hEUhFjubahIjubaubh^X.r}r(hEX.hFjubeubht)r}r(hEUhFj.hGNhIhwhK}r(hM]hN]hO]hP]hR]uhTNhUhh@]r(hz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKDhUhh@]r(h)r}r(hEXVersionhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XVersionrr}r(hEUhFjubaubh)r}r(hEX1.0rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKDh@]rh^X1.0rr}r(hEjhFjubaubahIhubeubhz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKEhUhh@]r(h)r}r(hEX Use CaseshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X Use Casesrr}r(hEUhFjubaubh)r}r(hEXp:doc:`UC01 `, :doc:`UC06 `, :doc:`UC16 `rhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEjhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKFh@]r(j)r}r(hEX$:doc:`UC01 `rhFjhGjhIjhK}r(UreftypeXdocrjjX/design/UseCases/01_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKFh@]rjr)r}r(hEjhK}r(hM]hN]r(jjehO]hP]hR]uhFjh@]rh^XUC01rr}r(hEUhFjubahIj{ubaubh^X, rr}r(hEX, hFjubj)r}r(hEX$:doc:`UC06 `rhFjhGjhIjhK}r(UreftypeXdocrjjX/design/UseCases/06_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKFh@]rjr)r}r(hEjhK}r(hM]hN]r(jjehO]hP]hR]uhFjh@]rh^XUC06rr}r(hEUhFjubahIj{ubaubh^X, rr}r(hEX, hFjubj)r}r(hEX$:doc:`UC16 `rhFjhGjhIjhK}r(UreftypeXdocrjjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKFh@]rjr)r}r(hEjhK}r(hM]hN]r(jjehO]hP]hR]uhFjh@]rh^XUC16rr}r(hEUhFjubahIj{ubaubeubahIhubeubhz)r}r(hEUhFjhGjhIh}hK}r(hM]hN]hO]hP]hR]uhTKGhUhh@]r(h)r}r(hEXREST URLhFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XREST URLrr}r(hEUhFjubaubh)r }r (hEX``GET /object/{id}``r hK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r}r(hEj hFj hGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKGh@]rj)r}r(hEj hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XGET /object/{id}rr}r(hEUhFjubahIjubaubahIhubeubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEX ParametershFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]r h^X Parametersr!r"}r#(hEUhFjubaubh)r$}r%(hEUhK}r&(hM]hN]hO]hP]hR]uhFjh@]r'j)r(}r)(hEUhK}r*(hM]hN]hO]hP]hR]uhFj$h@]r+(j)r,}r-(hEUhK}r.(hM]hN]hO]hP]hR]uhFj(h@]r/hb)r0}r1(hEXTsession (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.hK}r2(hM]hN]hO]hP]hR]uhFj,h@]r3(j)r4}r5(hEXsessionhK}r6(hP]hO]jhM]hN]hR]uhFj0h@]r7h^Xsessionr8r9}r:(hEUhFj4ubahIjubh^X (r;r<}r=(hEUhFj0ubj)r>}r?(hEX:class:`Types.Session`r@hFj0hGjhIjhK}rA(UreftypeXclassjjX Types.SessionU refdomainXpyrBhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKIh@]rCj)rD}rE(hEj@hK}rF(hM]hN]rG(jjBXpy-classrHehO]hP]hR]uhFj>h@]rIh^X Types.SessionrJrK}rL(hEUhFjDubahIjubaubh^X)rM}rN(hEUhFj0ubh^X -- rOrP}rQ(hEUhFj0ubh^XSession 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 rRrS}rT(hEXSession 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 hFj0ubj)rU}rV(hEX:term:`public user`rWhFj0hGjhIjhK}rX(UreftypeXtermjjX public userU refdomainXstdrYhP]hO]U refexplicithM]hN]hR]jjuhTKHh@]rZjr)r[}r\(hEjWhK}r](hM]hN]r^(jjYXstd-termr_ehO]hP]hR]uhFjUh@]r`h^X public userrarb}rc(hEUhFj[ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rdre}rf(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj0ubehIhfubahIjubj)rg}rh(hEUhK}ri(hM]hN]hO]hP]hR]uhFj(h@]rjhb)rk}rl(hEXid (Types.Identifier) -- The identifier for the object to be retrieved. May be a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hK}rm(hM]hN]hO]hP]hR]uhFjgh@]rn(j)ro}rp(hEXidhK}rq(hP]hO]jhM]hN]hR]uhFjkh@]rrh^Xidrsrt}ru(hEUhFjoubahIjubh^X (rvrw}rx(hEUhFjkubj)ry}rz(hEX:class:`Types.Identifier`r{hFjkhGjhIjhK}r|(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr}hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKLh@]r~j)r}r(hEj{hK}r(hM]hN]r(jj}Xpy-classrehO]hP]hR]uhFjyh@]rh^XTypes.Identifierrr}r(hEUhFjubahIjubaubh^X)r}r(hEUhFjkubh^X -- rr}r(hEUhFjkubh^XThe identifier for the object to be retrieved. May be a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.rr}r(hEXThe identifier for the object to be retrieved. May be a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hFjkubehIhfubahIjubehIjmubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEXReturnshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XReturnsrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXBytes of the specified object.hK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XBytes of the specified object.rr}r(hEXBytes of the specified object.hFjubahIhfubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEX Return typehFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^X Return typerr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEXTypes.OctetStreamhK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEX:class:`Types.OctetStream`rhFjhGjhIjhK}r(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrhP]hO]U refexplicithM]hN]hR]jjjNjjuhTKOh@]rj)r}r(hEjhK}r(hM]hN]r(jjXpy-classrehO]hP]hR]uhFjh@]rh^XTypes.OctetStreamrr}r(hEUhFjubahIjubaubahIhfubahIhubehIh}ubhz)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(h)r}r(hEXRaiseshFjhGjhIhhK}r(hM]hN]hO]hP]hR]uhTKh@]rh^XRaisesrr}r(hEUhFjubaubh)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rj)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(hM]hN]hO]hP]hR]uhFjh@]rhb)r}r(hEX~Exceptions.NotAuthorized -- (errorCode=401, detailCode=1000)The provided identity does not have READ permission on the object.hK}r(hM]hN]hO]hP]hR]uhFjh@]r(j)r}r(hEUhK}r(UreftypejjU reftargetXExceptions.NotAuthorizedrU refdomainjhP]hO]U refexplicithM]hN]hR]uhFjh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^XExceptions.NotAuthorizedrr}r(hEUhFjubahIjubahIjubh^X -- rr}r(hEUhFjubhb)r}r(hEX$``(errorCode=401, detailCode=1000)``rhFjhGjhIhfhK}r(hM]hN]hO]hP]hR]uhTKQh@]rj)r}r(hEjhK}r(hM]hN]hO]hP]hR]uhFjh@]rh^X (errorCode=401, detailCode=1000)rr}r(hEUhFjubahIjubaubhb)r}r(hEXBThe provided identity does not have READ permission on the object.r hFjhGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKSh@]r h^XBThe provided identity does not have READ permission on the object.r r }r (hEj hFjubaubehIhfubahIjubj)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r }r (hEXExceptions.NotFound -- (errorCode=404, detailCode=1020)The object specified by id does not exist at this node. The description should include a reference to the resolve method.hK}r (hM]hN]hO]hP]hR]uhFj h@]r (j)r }r (hEUhK}r (UreftypejjU reftargetXExceptions.NotFoundr U refdomainjhP]hO]U refexplicithM]hN]hR]uhFj h@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XExceptions.NotFoundr r }r (hEUhFj ubahIjubahIjubh^X -- r r }r (hEUhFj ubhb)r }r (hEX$``(errorCode=404, detailCode=1020)``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKUh@]r! j)r" }r# (hEj hK}r$ (hM]hN]hO]hP]hR]uhFj h@]r% h^X (errorCode=404, detailCode=1020)r& r' }r( (hEUhFj" ubahIjubaubhb)r) }r* (hEX{The object specified by *id* does not exist at this node. The description should include a reference to the resolve method.hFj hGjhIhfhK}r+ (hM]hN]hO]hP]hR]uhTKWh@]r, (h^XThe object specified by r- r. }r/ (hEXThe object specified by hFj) ubj)r0 }r1 (hEX*id*hK}r2 (hM]hN]hO]hP]hR]uhFj) h@]r3 h^Xidr4 r5 }r6 (hEUhFj0 ubahIjubh^X_ does not exist at this node. The description should include a reference to the resolve method.r7 r8 }r9 (hEX_ does not exist at this node. The description should include a reference to the resolve method.hFj) ubeubehIhfubahIjubj)r: }r; (hEUhK}r< (hM]hN]hO]hP]hR]uhFjh@]r= hb)r> }r? (hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1030)hK}r@ (hM]hN]hO]hP]hR]uhFj: h@]rA (j)rB }rC (hEUhK}rD (UreftypejjU reftargetXExceptions.ServiceFailurerE U refdomainjhP]hO]U refexplicithM]hN]hR]uhFj> h@]rF j)rG }rH (hEjE hK}rI (hM]hN]hO]hP]hR]uhFjB h@]rJ h^XExceptions.ServiceFailurerK rL }rM (hEUhFjG ubahIjubahIjubh^X -- rN rO }rP (hEUhFj> ubj)rQ }rR (hEX$``(errorCode=500, detailCode=1030)``hK}rS (hM]hN]hO]hP]hR]uhFj> h@]rT h^X (errorCode=500, detailCode=1030)rU rV }rW (hEUhFjQ ubahIjubehIhfubahIjubj)rX }rY (hEUhK}rZ (hM]hN]hO]hP]hR]uhFjh@]r[ hb)r\ }r] (hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1010)hK}r^ (hM]hN]hO]hP]hR]uhFjX h@]r_ (j)r` }ra (hEUhK}rb (UreftypejjU reftargetXExceptions.InvalidTokenrc U refdomainjhP]hO]U refexplicithM]hN]hR]uhFj\ h@]rd j)re }rf (hEjc hK}rg (hM]hN]hO]hP]hR]uhFj` h@]rh h^XExceptions.InvalidTokenri rj }rk (hEUhFje ubahIjubahIjubh^X -- rl rm }rn (hEUhFj\ ubj)ro }rp (hEX$``(errorCode=401, detailCode=1010)``hK}rq (hM]hN]hO]hP]hR]uhFj\ h@]rr h^X (errorCode=401, detailCode=1010)rs rt }ru (hEUhFjo ubahIjubehIhfubahIjubj)rv }rw (hEUhK}rx (hM]hN]hO]hP]hR]uhFjh@]ry hb)rz }r{ (hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1001)hK}r| (hM]hN]hO]hP]hR]uhFjv h@]r} (j)r~ }r (hEUhK}r (UreftypejjU reftargetXExceptions.NotImplementedr U refdomainjhP]hO]U refexplicithM]hN]hR]uhFjz h@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj~ h@]r h^XExceptions.NotImplementedr r }r (hEUhFj ubahIjubahIjubh^X -- r r }r (hEUhFjz ubj)r }r (hEX$``(errorCode=501, detailCode=1001)``hK}r (hM]hN]hO]hP]hR]uhFjz h@]r h^X (errorCode=501, detailCode=1001)r r }r (hEUhFj ubahIjubehIhfubahIjubj)r }r (hEUhK}r (hM]hN]hO]hP]hR]uhFjh@]r hb)r }r (hEXExceptions.InsufficientResources -- (errorCode=413, detailCode=1002)The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.hK}r (hM]hN]hO]hP]hR]uhFj h@]r (j)r }r (hEUhK}r (UreftypejjU reftargetX Exceptions.InsufficientResourcesr U refdomainjhP]hO]U refexplicithM]hN]hR]uhFj h@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X Exceptions.InsufficientResourcesr r }r (hEUhFj ubahIjubahIjubh^X -- r r }r (hEUhFj ubhb)r }r (hEX$``(errorCode=413, detailCode=1002)``r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTK_h@]r j)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^X (errorCode=413, detailCode=1002)r r }r (hEUhFj ubahIjubaubhb)r }r (hEX~The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.r hFj hGjhIhfhK}r (hM]hN]hO]hP]hR]uhTKah@]r h^X~The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.r r }r (hEj hFj ubaubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubjn)r }r (hEUhFjhGX3internal padding after source/apis/examples/get.txtr hIjqhK}r (hM]hN]hO]hP]hR]uhTNhUhh@]r (hb)r }r (hEX **Examples**r hFj hGjXsource/apis/examples/get.txtr r }r bhIhfhK}r (hM]hN]hO]hP]hR]uhTKh@]r j|)r }r (hEj hK}r (hM]hN]hO]hP]hR]uhFj h@]r h^XExamplesr r }r (hEUhFj ubahIjubaubhb)r }r (hEX4(GET) Retrieve the object with identifier "XYZ332"::hFj hGj hIhfhK}r (hM]hN]hO]hP]hR]uhTKh@]r h^X3(GET) Retrieve the object with identifier "XYZ332":r r }r (hEX3(GET) Retrieve the object with identifier "XYZ332":hFj ubaubj)r }r (hEXeexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k "$NODE/v1/object/XYZ332" ... data ...hFj hIjhK}r (hhhP]hO]hM]hN]hR]uhTM|h@]r h^Xeexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -k "$NODE/v1/object/XYZ332" ... data ...r r }r (hEUhFj ubaubhb)r }r (hEXP(GET) Attempt to retrieve a non-existent object (and show headers in response)::hFj hGj hIhfhK}r (hM]hN]hO]hP]hR]uhTK h@]r h^XO(GET) Attempt to retrieve a non-existent object (and show headers in response):r r }r (hEXO(GET) Attempt to retrieve a non-existent object (and show headers in response):hFj ubaubj)r }r (hEXexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -D - "$NODE/v1/object/DOESNTEXIST" HTTP/1.1 404 Not Found Date: Tue, 06 Mar 2012 15:25:35 GMT Server: Apache/2.2.14 (Ubuntu) Content-Length: 196 Vary: Accept-Encoding Content-Type: text/xml No system metadata could be found for given PID: DOESNTEXIST hFj hIjhK}r (hhhP]hO]hM]hN]hR]uhTMh@]r h^Xexport NODE="https://demo2.test.dataone.org/knb/d1/mn" curl -D - "$NODE/v1/object/DOESNTEXIST" HTTP/1.1 404 Not Found Date: Tue, 06 Mar 2012 15:25:35 GMT Server: Apache/2.2.14 (Ubuntu) Content-Length: 196 Vary: Accept-Encoding Content-Type: text/xml No system metadata could be found for given PID: DOESNTEXIST r r }r (hEUhFj ubaubeubj)r }r (hEUhFjhGNhIjhK}r (hP]hO]hM]hN]hR]Uentries]r (jX&getSystemMetadata() (in module MNRead)h UNtr auhTNhUhh@]ubj)r }r (hEUhFjhGNhIjhK}r (jjXpyr hP]hO]hM]hN]hR]jXfunctionr jj uhTNhUhh@]r (j)r }r (hEX/getSystemMetadata(session,id) -> SystemMetadatahFj hGjhIjhK}r (hP]r h ajjhO]hM]hN]hR]r h ajXgetSystemMetadatar jUjuhTKhUhh@]r!(j)r!}r!(hEXMNRead.hFj hGjhIjhK}r!(hM]hN]hO]hP]hR]uhTKhUhh@]r!h^XMNRead.r!r!}r!(hEUhFj!ubaubj)r!}r !(hEj hFj hGjhIjhK}r !(hM]hN]hO]hP]hR]uhTKhUhh@]r !h^XgetSystemMetadatar !r !}r!(hEUhFj!ubaubj)r!}r!(hEX session, idhFj hGjhIjhK}r!(hM]hN]hO]hP]hR]uhTKhUhh@]r!(j)r!}r!(hEXsessionhK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!h^Xsessionr!r!}r!(hEUhFj!ubahIjubj)r!}r!(hEXidhK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!h^Xidr!r!}r !(hEUhFj!ubahIjubeubj)r!!}r"!(hEXSystemMetadatahFj hGjhIjhK}r#!(hM]hN]hO]hP]hR]uhTKhUhh@]r$!h^XSystemMetadatar%!r&!}r'!(hEUhFj!!ubaubeubj)r(!}r)!(hEUhFj hGjhIj hK}r*!(hM]hN]hO]hP]hR]uhTKhUhh@]r+!(hb)r,!}r-!(hEX[Describes the object identified by *id* by returning the associated system metadata object.hFj(!hGjhIhfhK}r.!(hM]hN]hO]hP]hR]uhTKkhUhh@]r/!(h^X#Describes the object identified by r0!r1!}r2!(hEX#Describes the object identified by hFj,!ubj)r3!}r4!(hEX*id*hK}r5!(hM]hN]hO]hP]hR]uhFj,!h@]r6!h^Xidr7!r8!}r9!(hEUhFj3!ubahIjubh^X4 by returning the associated system metadata object.r:!r;!}r!(hEXIf 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.hFj(!hGjhIhfhK}r?!(hM]hN]hO]hP]hR]uhTKmhUhh@]r@!(h^XEIf the object does not exist on the node servicing the request, then rA!rB!}rC!(hEXEIf the object does not exist on the node servicing the request, then hFj=!ubj)rD!}rE!(hEX:exc:`Exceptions.NotFound`rF!hFj=!hGjhIjhK}rG!(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyrH!hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKmh@]rI!j)rJ!}rK!(hEjF!hK}rL!(hM]hN]rM!(jjH!Xpy-excrN!ehO]hP]hR]uhFjD!h@]rO!h^XExceptions.NotFoundrP!rQ!}rR!(hEUhFjJ!ubahIjubaubh^XP MUST be raised even if the object exists on another node in the DataONE system.rS!rT!}rU!(hEXP MUST be raised even if the object exists on another node in the DataONE system.hFj=!ubeubht)rV!}rW!(hEUhFj(!hGNhIhwhK}rX!(hM]hN]hO]hP]hR]uhTNhUhh@]rY!(hz)rZ!}r[!(hEUhFjV!hGjhIh}hK}r\!(hM]hN]hO]hP]hR]uhTKohUhh@]r]!(h)r^!}r_!(hEXVersionhFjZ!hGjhIhhK}r`!(hM]hN]hO]hP]hR]uhTKh@]ra!h^XVersionrb!rc!}rd!(hEUhFj^!ubaubh)re!}rf!(hEX1.0rg!hK}rh!(hM]hN]hO]hP]hR]uhFjZ!h@]ri!hb)rj!}rk!(hEjg!hFje!hGjhIhfhK}rl!(hM]hN]hO]hP]hR]uhTKoh@]rm!h^X1.0rn!ro!}rp!(hEjg!hFjj!ubaubahIhubeubhz)rq!}rr!(hEUhFjV!hGjhIh}hK}rs!(hM]hN]hO]hP]hR]uhTKphUhh@]rt!(h)ru!}rv!(hEX Use CaseshFjq!hGjhIhhK}rw!(hM]hN]hO]hP]hR]uhTKh@]rx!h^X Use Casesry!rz!}r{!(hEUhFju!ubaubh)r|!}r}!(hEXp:doc:`UC06 `, :doc:`UC37 `, :doc:`UC16 `r~!hK}r!(hM]hN]hO]hP]hR]uhFjq!h@]r!hb)r!}r!(hEj~!hFj|!hGjhIhfhK}r!(hM]hN]hO]hP]hR]uhTKqh@]r!(j)r!}r!(hEX$:doc:`UC06 `r!hFj!hGjhIjhK}r!(UreftypeXdocr!jjX/design/UseCases/06_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKqh@]r!jr)r!}r!(hEj!hK}r!(hM]hN]r!(jj!ehO]hP]hR]uhFj!h@]r!h^XUC06r!r!}r!(hEUhFj!ubahIj{ubaubh^X, r!r!}r!(hEX, hFj!ubj)r!}r!(hEX$:doc:`UC37 `r!hFj!hGjhIjhK}r!(UreftypeXdocr!jjX/design/UseCases/37_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKqh@]r!jr)r!}r!(hEj!hK}r!(hM]hN]r!(jj!ehO]hP]hR]uhFj!h@]r!h^XUC37r!r!}r!(hEUhFj!ubahIj{ubaubh^X, r!r!}r!(hEX, hFj!ubj)r!}r!(hEX$:doc:`UC16 `r!hFj!hGjhIjhK}r!(UreftypeXdocr!jjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKqh@]r!jr)r!}r!(hEj!hK}r!(hM]hN]r!(jj!ehO]hP]hR]uhFj!h@]r!h^XUC16r!r!}r!(hEUhFj!ubahIj{ubaubeubahIhubeubhz)r!}r!(hEUhFjV!hGjhIh}hK}r!(hM]hN]hO]hP]hR]uhTKrhUhh@]r!(h)r!}r!(hEXREST URLhFj!hGjhIhhK}r!(hM]hN]hO]hP]hR]uhTKh@]r!h^XREST URLr!r!}r!(hEUhFj!ubaubh)r!}r!(hEX``GET /meta/{id}``r!hK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!hb)r!}r!(hEj!hFj!hGjhIhfhK}r!(hM]hN]hO]hP]hR]uhTKrh@]r!j)r!}r!(hEj!hK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!h^XGET /meta/{id}r!r!}r!(hEUhFj!ubahIjubaubahIhubeubhz)r!}r!(hEUhK}r!(hM]hN]hO]hP]hR]uhFjV!h@]r!(h)r!}r!(hEX ParametershFj!hGjhIhhK}r!(hM]hN]hO]hP]hR]uhTKh@]r!h^X Parametersr!r!}r!(hEUhFj!ubaubh)r!}r!(hEUhK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!j)r!}r!(hEUhK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!(j)r!}r!(hEUhK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!hb)r!}r!(hEXTsession (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.hK}r!(hM]hN]hO]hP]hR]uhFj!h@]r!(j)r!}r!(hEXsessionhK}r!(hP]hO]jhM]hN]hR]uhFj!h@]r!h^Xsessionr!r!}r!(hEUhFj!ubahIjubh^X (r!r!}r!(hEUhFj!ubj)r!}r!(hEX:class:`Types.Session`r!hFj!hGjhIjhK}r!(UreftypeXclassjjX Types.SessionU refdomainXpyr!hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKth@]r!j)r!}r!(hEj!hK}r!(hM]hN]r!(jj!Xpy-classr!ehO]hP]hR]uhFj!h@]r"h^X Types.Sessionr"r"}r"(hEUhFj!ubahIjubaubh^X)r"}r"(hEUhFj!ubh^X -- r"r"}r"(hEUhFj!ubh^XSession 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 "(hEXSession 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 hFj!ubj)r "}r "(hEX:term:`public user`r"hFj!hGjhIjhK}r"(UreftypeXtermjjX public userU refdomainXstdr"hP]hO]U refexplicithM]hN]hR]jjuhTKsh@]r"jr)r"}r"(hEj"hK}r"(hM]hN]r"(jj"Xstd-termr"ehO]hP]hR]uhFj "h@]r"h^X public userr"r"}r"(hEUhFj"ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r"r"}r"(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj!ubehIhfubahIjubj)r"}r"(hEUhK}r "(hM]hN]hO]hP]hR]uhFj!h@]r!"hb)r""}r#"(hEXid (Types.Identifier) -- Identifier for the science data or science metedata object of interest. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hK}r$"(hM]hN]hO]hP]hR]uhFj"h@]r%"(j)r&"}r'"(hEXidhK}r("(hP]hO]jhM]hN]hR]uhFj""h@]r)"h^Xidr*"r+"}r,"(hEUhFj&"ubahIjubh^X (r-"r."}r/"(hEUhFj""ubj)r0"}r1"(hEX:class:`Types.Identifier`r2"hFj""hGjhIjhK}r3"(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr4"hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKwh@]r5"j)r6"}r7"(hEj2"hK}r8"(hM]hN]r9"(jj4"Xpy-classr:"ehO]hP]hR]uhFj0"h@]r;"h^XTypes.Identifierr<"r="}r>"(hEUhFj6"ubahIjubaubh^X)r?"}r@"(hEUhFj""ubh^X -- rA"rB"}rC"(hEUhFj""ubh^XIdentifier for the science data or science metedata object of interest. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.rD"rE"}rF"(hEXIdentifier for the science data or science metedata object of interest. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hFj""ubehIhfubahIjubehIjmubahIhubehIh}ubhz)rG"}rH"(hEUhK}rI"(hM]hN]hO]hP]hR]uhFjV!h@]rJ"(h)rK"}rL"(hEXReturnshFjG"hGjhIhhK}rM"(hM]hN]hO]hP]hR]uhTKh@]rN"h^XReturnsrO"rP"}rQ"(hEUhFjK"ubaubh)rR"}rS"(hEUhK}rT"(hM]hN]hO]hP]hR]uhFjG"h@]rU"hb)rV"}rW"(hEX-System metadata object describing the object.hK}rX"(hM]hN]hO]hP]hR]uhFjR"h@]rY"h^X-System metadata object describing the object.rZ"r["}r\"(hEX-System metadata object describing the object.hFjV"ubahIhfubahIhubehIh}ubhz)r]"}r^"(hEUhK}r_"(hM]hN]hO]hP]hR]uhFjV!h@]r`"(h)ra"}rb"(hEX Return typehFj]"hGjhIhhK}rc"(hM]hN]hO]hP]hR]uhTKh@]rd"h^X Return typere"rf"}rg"(hEUhFja"ubaubh)rh"}ri"(hEUhK}rj"(hM]hN]hO]hP]hR]uhFj]"h@]rk"hb)rl"}rm"(hEXTypes.SystemMetadatahK}rn"(hM]hN]hO]hP]hR]uhFjh"h@]ro"j)rp"}rq"(hEX:class:`Types.SystemMetadata`rr"hFjl"hGjhIjhK}rs"(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrt"hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKzh@]ru"j)rv"}rw"(hEjr"hK}rx"(hM]hN]ry"(jjt"Xpy-classrz"ehO]hP]hR]uhFjp"h@]r{"h^XTypes.SystemMetadatar|"r}"}r~"(hEUhFjv"ubahIjubaubahIhfubahIhubehIh}ubhz)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFjV!h@]r"(h)r"}r"(hEXRaiseshFj"hGjhIhhK}r"(hM]hN]hO]hP]hR]uhTKh@]r"h^XRaisesr"r"}r"(hEUhFj"ubaubh)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"j)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"(j)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"hb)r"}r"(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1040)hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"(j)r"}r"(hEUhK}r"(UreftypejjU reftargetXExceptions.NotAuthorizedr"U refdomainj hP]hO]U refexplicithM]hN]hR]uhFj"h@]r"j)r"}r"(hEj"hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^XExceptions.NotAuthorizedr"r"}r"(hEUhFj"ubahIjubahIjubh^X -- r"r"}r"(hEUhFj"ubj)r"}r"(hEX$``(errorCode=401, detailCode=1040)``hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^X (errorCode=401, detailCode=1040)r"r"}r"(hEUhFj"ubahIjubehIhfubahIjubj)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"hb)r"}r"(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1041)hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"(j)r"}r"(hEUhK}r"(UreftypejjU reftargetXExceptions.NotImplementedr"U refdomainj hP]hO]U refexplicithM]hN]hR]uhFj"h@]r"j)r"}r"(hEj"hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^XExceptions.NotImplementedr"r"}r"(hEUhFj"ubahIjubahIjubh^X -- r"r"}r"(hEUhFj"ubj)r"}r"(hEX$``(errorCode=501, detailCode=1041)``hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^X (errorCode=501, detailCode=1041)r"r"}r"(hEUhFj"ubahIjubehIhfubahIjubj)r"}r"(hEUhK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"hb)r"}r"(hEXExceptions.NotFound -- (errorCode=404, detailCode=1060)There is no data or science metadata identified by the given id on the node where the request was serviced. The error message should provide a hint to use the CNRead.resolve() mechanism.hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"(j)r"}r"(hEUhK}r"(UreftypejjU reftargetXExceptions.NotFoundr"U refdomainj hP]hO]U refexplicithM]hN]hR]uhFj"h@]r"j)r"}r"(hEj"hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^XExceptions.NotFoundr"r"}r"(hEUhFj"ubahIjubahIjubh^X -- r"r"}r"(hEUhFj"ubhb)r"}r"(hEX$``(errorCode=404, detailCode=1060)``r"hFj"hGjhIhfhK}r"(hM]hN]hO]hP]hR]uhTKh@]r"j)r"}r"(hEj"hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^X (errorCode=404, detailCode=1060)r"r"}r"(hEUhFj"ubahIjubaubhb)r"}r"(hEXThere is no data or science metadata identified by the given *id* on the node where the request was serviced. The error message should provide a hint to use the :func:`CNRead.resolve` mechanism.hFj"hGjhIhfhK}r"(hM]hN]hO]hP]hR]uhTKh@]r"(h^X=There is no data or science metadata identified by the given r"r"}r"(hEX=There is no data or science metadata identified by the given hFj"ubj)r"}r"(hEX*id*hK}r"(hM]hN]hO]hP]hR]uhFj"h@]r"h^Xidr"r"}r"(hEUhFj"ubahIjubh^X` on the node where the request was serviced. The error message should provide a hint to use the r"r#}r#(hEX` on the node where the request was serviced. The error message should provide a hint to use the hFj"ubj)r#}r#(hEX:func:`CNRead.resolve`r#hFj"hGjhIjhK}r#(UreftypeXfuncjjXCNRead.resolveU refdomainXpyr#hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r#j)r#}r #(hEj#hK}r #(hM]hN]r #(jj#Xpy-funcr #ehO]hP]hR]uhFj#h@]r #h^XCNRead.resolve()r#r#}r#(hEUhFj#ubahIjubaubh^X mechanism.r#r#}r#(hEX mechanism.hFj"ubeubehIhfubahIjubj)r#}r#(hEUhK}r#(hM]hN]hO]hP]hR]uhFj"h@]r#hb)r#}r#(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1090)hK}r#(hM]hN]hO]hP]hR]uhFj#h@]r#(j)r#}r#(hEUhK}r#(UreftypejjU reftargetXExceptions.ServiceFailurer#U refdomainj hP]hO]U refexplicithM]hN]hR]uhFj#h@]r #j)r!#}r"#(hEj#hK}r##(hM]hN]hO]hP]hR]uhFj#h@]r$#h^XExceptions.ServiceFailurer%#r&#}r'#(hEUhFj!#ubahIjubahIjubh^X -- r(#r)#}r*#(hEUhFj#ubj)r+#}r,#(hEX$``(errorCode=500, detailCode=1090)``hK}r-#(hM]hN]hO]hP]hR]uhFj#h@]r.#h^X (errorCode=500, detailCode=1090)r/#r0#}r1#(hEUhFj+#ubahIjubehIhfubahIjubj)r2#}r3#(hEUhK}r4#(hM]hN]hO]hP]hR]uhFj"h@]r5#hb)r6#}r7#(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1050)hK}r8#(hM]hN]hO]hP]hR]uhFj2#h@]r9#(j)r:#}r;#(hEUhK}r<#(UreftypejjU reftargetXExceptions.InvalidTokenr=#U refdomainj hP]hO]U refexplicithM]hN]hR]uhFj6#h@]r>#j)r?#}r@#(hEj=#hK}rA#(hM]hN]hO]hP]hR]uhFj:#h@]rB#h^XExceptions.InvalidTokenrC#rD#}rE#(hEUhFj?#ubahIjubahIjubh^X -- rF#rG#}rH#(hEUhFj6#ubj)rI#}rJ#(hEX$``(errorCode=401, detailCode=1050)``hK}rK#(hM]hN]hO]hP]hR]uhFj6#h@]rL#h^X (errorCode=401, detailCode=1050)rM#rN#}rO#(hEUhFjI#ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubjn)rP#}rQ#(hEUhFjhGXAinternal padding after source/apis/examples/getSystemMetadata.txtrR#hIjqhK}rS#(hM]hN]hO]hP]hR]uhTNhUhh@]rT#(hb)rU#}rV#(hEX **Examples**rW#hFjP#hGjX*source/apis/examples/getSystemMetadata.txtrX#rY#}rZ#bhIhfhK}r[#(hM]hN]hO]hP]hR]uhTKh@]r\#j|)r]#}r^#(hEjW#hK}r_#(hM]hN]hO]hP]hR]uhFjU#h@]r`#h^XExamplesra#rb#}rc#(hEUhFj]#ubahIjubaubhb)rd#}re#(hEX(GET) Retrieve system metadata from a Member Node for object "XYZ332" which happens to be science metadata (an EML document) that has been obsoleted by a new version with identifier "XYZ33"::hFjP#hGjY#hIhfhK}rf#(hM]hN]hO]hP]hR]uhTKh@]rg#h^X(GET) Retrieve system metadata from a Member Node for object "XYZ332" which happens to be science metadata (an EML document) that has been obsoleted by a new version with identifier "XYZ33":rh#ri#}rj#(hEX(GET) Retrieve system metadata from a Member Node for object "XYZ332" which happens to be science metadata (an EML document) that has been obsoleted by a new version with identifier "XYZ33":hFjd#ubaubj)rk#}rl#(hEXcurl http://m1.dataone.org/mn/v1/meta/XYZ332 1 XYZ332 eml://ecoinformatics.org/eml-2.1.0 20875 e7451c1775461b13987d7539319ee41f uid=mbauer,o=NCEAS,dc=ecoinformatics,dc=org uid=mbauer,o=NCEAS,dc=ecoinformatics,dc=org uid=jdoe,o=NCEAS,dc=ecoinformatics,dc=org read write changePermission public read uid=nceasadmin,o=NCEAS,dc=ecoinformatics,dc=org read write changePermission XYZ331 XYZ333 true 2008-04-01T23:00:00.000+00:00 2012-06-26T03:51:25.058+00:00 urn:node:TEST urn:node:TEST hFjP#hIjhK}rm#(hhhP]hO]hM]hN]hR]uhTMh@]rn#h^Xcurl http://m1.dataone.org/mn/v1/meta/XYZ332 1 XYZ332 eml://ecoinformatics.org/eml-2.1.0 20875 e7451c1775461b13987d7539319ee41f uid=mbauer,o=NCEAS,dc=ecoinformatics,dc=org uid=mbauer,o=NCEAS,dc=ecoinformatics,dc=org uid=jdoe,o=NCEAS,dc=ecoinformatics,dc=org read write changePermission public read uid=nceasadmin,o=NCEAS,dc=ecoinformatics,dc=org read write changePermission XYZ331 XYZ333 true 2008-04-01T23:00:00.000+00:00 2012-06-26T03:51:25.058+00:00 urn:node:TEST urn:node:TEST ro#rp#}rq#(hEUhFjk#ubaubhb)rr#}rs#(hEXN(GET) Attempt to retrieve system metadata for an object that does not exist.::hFjP#hGjY#hIhfhK}rt#(hM]hN]hO]hP]hR]uhTK/h@]ru#h^XM(GET) Attempt to retrieve system metadata for an object that does not exist.:rv#rw#}rx#(hEXM(GET) Attempt to retrieve system metadata for an object that does not exist.:hFjr#ubaubj)ry#}rz#(hEXcurl http://cn.dataone.org/cn/v1/meta/SomeObjectID No system metadata could be found for given PID: SomeObjectID hFjP#hIjhK}r{#(hhhP]hO]hM]hN]hR]uhTMh@]r|#h^Xcurl http://cn.dataone.org/cn/v1/meta/SomeObjectID No system metadata could be found for given PID: SomeObjectID r}#r~#}r#(hEUhFjy#ubaubeubj)r#}r#(hEUhFjhGNhIjhK}r#(hP]hO]hM]hN]hR]Uentries]r#(jXdescribe() (in module MNRead)h'UNtr#auhTNhUhh@]ubj)r#}r#(hEUhFjhGNhIjhK}r#(jjXpyr#hP]hO]hM]hN]hR]jXfunctionr#jj#uhTNhUhh@]r#(j)r#}r#(hEX(describe(session,id) -> DescribeResponsehFj#hGjhIjhK}r#(hP]r#h'ajjhO]hM]hN]hR]r#h'ajXdescriber#jUjuhTKhUhh@]r#(j)r#}r#(hEXMNRead.hFj#hGjhIjhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#h^XMNRead.r#r#}r#(hEUhFj#ubaubj)r#}r#(hEj#hFj#hGjhIjhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#h^Xdescriber#r#}r#(hEUhFj#ubaubj)r#}r#(hEX session, idhFj#hGjhIjhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#(j)r#}r#(hEXsessionhK}r#(hM]hN]hO]hP]hR]uhFj#h@]r#h^Xsessionr#r#}r#(hEUhFj#ubahIjubj)r#}r#(hEXidhK}r#(hM]hN]hO]hP]hR]uhFj#h@]r#h^Xidr#r#}r#(hEUhFj#ubahIjubeubj)r#}r#(hEXDescribeResponsehFj#hGjhIjhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#h^XDescribeResponser#r#}r#(hEUhFj#ubaubeubj)r#}r#(hEUhFj#hGjhIj hK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#(hb)r#}r#(hEXdThis method provides a lighter weight mechanism than :func:`MNRead.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`).hFj#hGjhIhfhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#(h^X5This method provides a lighter weight mechanism than r#r#}r#(hEX5This method provides a lighter weight mechanism than hFj#ubj)r#}r#(hEX :func:`MNRead.getSystemMetadata`r#hFj#hGjhIjhK}r#(UreftypeXfuncjjXMNRead.getSystemMetadataU refdomainXpyr#hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r#j)r#}r#(hEj#hK}r#(hM]hN]r#(jj#Xpy-funcr#ehO]hP]hR]uhFj#h@]r#h^XMNRead.getSystemMetadata()r#r#}r#(hEUhFj#ubahIjubaubh^X 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#r#}r#(hEX 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 hFj#ubj)r#}r#(hEX:attr:`SystemMetadata.formatId`r#hFj#hGjhIjhK}r#(UreftypeXattrjjXSystemMetadata.formatIdU refdomainXpyr#hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r#j)r#}r#(hEj#hK}r#(hM]hN]r#(jj#Xpy-attrr#ehO]hP]hR]uhFj#h@]r#h^XSystemMetadata.formatIdr#r#}r#(hEUhFj#ubahIjubaubh^X).r#r#}r#(hEX).hFj#ubeubhb)r#}r#(hEXThe principal indicated by *token* must have read privileges on the object, otherwise :exc:`Exceptions.NotAuthorized` is raised.hFj#hGjhIhfhK}r#(hM]hN]hO]hP]hR]uhTKhUhh@]r#(h^XThe principal indicated by r#r#}r#(hEXThe principal indicated by hFj#ubj)r#}r#(hEX*token*hK}r#(hM]hN]hO]hP]hR]uhFj#h@]r#h^Xtokenr#r#}r#(hEUhFj#ubahIjubh^X4 must have read privileges on the object, otherwise r#r#}r#(hEX4 must have read privileges on the object, otherwise hFj#ubj)r#}r#(hEX:exc:`Exceptions.NotAuthorized`r#hFj#hGjhIjhK}r#(UreftypeXexcjjXExceptions.NotAuthorizedU refdomainXpyr#hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r#j)r#}r$(hEj#hK}r$(hM]hN]r$(jj#Xpy-excr$ehO]hP]hR]uhFj#h@]r$h^XExceptions.NotAuthorizedr$r$}r$(hEUhFj#ubahIjubaubh^X is raised.r$r $}r $(hEX is raised.hFj#ubeubhb)r $}r $(hEXIf 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.hFj#hGjhIhfhK}r $(hM]hN]hO]hP]hR]uhTKhUhh@]r$(h^XEIf the object does not exist on the node servicing the request, then r$r$}r$(hEXEIf the object does not exist on the node servicing the request, then hFj $ubj)r$}r$(hEX:exc:`Exceptions.NotFound`r$hFj $hGjhIjhK}r$(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyr$hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r$j)r$}r$(hEj$hK}r$(hM]hN]r$(jj$Xpy-excr$ehO]hP]hR]uhFj$h@]r$h^XExceptions.NotFoundr$r$}r $(hEUhFj$ubahIjubaubh^XP must be raised even if the object exists on another node in the DataONE system.r!$r"$}r#$(hEXP must be raised even if the object exists on another node in the DataONE system.hFj $ubeubhb)r$$}r%$(hEXNote that this method is likely to be called frequently and so efficiency should be taken into consideration during implementation.r&$hFj#hGjhIhfhK}r'$(hM]hN]hO]hP]hR]uhTKhUhh@]r($h^XNote that this method is likely to be called frequently and so efficiency should be taken into consideration during implementation.r)$r*$}r+$(hEj&$hFj$$ubaubht)r,$}r-$(hEUhFj#hGNhIhwhK}r.$(hM]hN]hO]hP]hR]uhTNhUhh@]r/$(hz)r0$}r1$(hEUhFj,$hGjhIh}hK}r2$(hM]hN]hO]hP]hR]uhTKhUhh@]r3$(h)r4$}r5$(hEXVersionhFj0$hGjhIhhK}r6$(hM]hN]hO]hP]hR]uhTKh@]r7$h^XVersionr8$r9$}r:$(hEUhFj4$ubaubh)r;$}r<$(hEX1.0r=$hK}r>$(hM]hN]hO]hP]hR]uhFj0$h@]r?$hb)r@$}rA$(hEj=$hFj;$hGjhIhfhK}rB$(hM]hN]hO]hP]hR]uhTKh@]rC$h^X1.0rD$rE$}rF$(hEj=$hFj@$ubaubahIhubeubhz)rG$}rH$(hEUhFj,$hGjhIh}hK}rI$(hM]hN]hO]hP]hR]uhTKhUhh@]rJ$(h)rK$}rL$(hEX Use CaseshFjG$hGjhIhhK}rM$(hM]hN]hO]hP]hR]uhTKh@]rN$h^X Use CasesrO$rP$}rQ$(hEUhFjK$ubaubh)rR$}rS$(hEX$:doc:`UC16 `rT$hK}rU$(hM]hN]hO]hP]hR]uhFjG$h@]rV$hb)rW$}rX$(hEjT$hFjR$hGjhIhfhK}rY$(hM]hN]hO]hP]hR]uhTKh@]rZ$j)r[$}r\$(hEjT$hFjW$hGjhIjhK}r]$(UreftypeXdocr^$jjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKh@]r_$jr)r`$}ra$(hEjT$hK}rb$(hM]hN]rc$(jj^$ehO]hP]hR]uhFj[$h@]rd$h^XUC16re$rf$}rg$(hEUhFj`$ubahIj{ubaubaubahIhubeubhz)rh$}ri$(hEUhFj,$hGjhIh}hK}rj$(hM]hN]hO]hP]hR]uhTKhUhh@]rk$(h)rl$}rm$(hEXREST URLhFjh$hGjhIhhK}rn$(hM]hN]hO]hP]hR]uhTKh@]ro$h^XREST URLrp$rq$}rr$(hEUhFjl$ubaubh)rs$}rt$(hEX``HEAD /object/{id}``ru$hK}rv$(hM]hN]hO]hP]hR]uhFjh$h@]rw$hb)rx$}ry$(hEju$hFjs$hGjhIhfhK}rz$(hM]hN]hO]hP]hR]uhTKh@]r{$j)r|$}r}$(hEju$hK}r~$(hM]hN]hO]hP]hR]uhFjx$h@]r$h^XHEAD /object/{id}r$r$}r$(hEUhFj|$ubahIjubaubahIhubeubhz)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj,$h@]r$(h)r$}r$(hEX ParametershFj$hGjhIhhK}r$(hM]hN]hO]hP]hR]uhTKh@]r$h^X Parametersr$r$}r$(hEUhFj$ubaubh)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$j)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$(j)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$hb)r$}r$(hEXTsession (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.hK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$(j)r$}r$(hEXsessionhK}r$(hP]hO]jhM]hN]hR]uhFj$h@]r$h^Xsessionr$r$}r$(hEUhFj$ubahIjubh^X (r$r$}r$(hEUhFj$ubj)r$}r$(hEX:class:`Types.Session`r$hFj$hGjhIjhK}r$(UreftypeXclassjjX Types.SessionU refdomainXpyr$hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r$j)r$}r$(hEj$hK}r$(hM]hN]r$(jj$Xpy-classr$ehO]hP]hR]uhFj$h@]r$h^X Types.Sessionr$r$}r$(hEUhFj$ubahIjubaubh^X)r$}r$(hEUhFj$ubh^X -- r$r$}r$(hEUhFj$ubh^XSession 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$(hEXSession 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 hFj$ubj)r$}r$(hEX:term:`public user`r$hFj$hGjhIjhK}r$(UreftypeXtermjjX public userU refdomainXstdr$hP]hO]U refexplicithM]hN]hR]jjuhTKh@]r$jr)r$}r$(hEj$hK}r$(hM]hN]r$(jj$Xstd-termr$ehO]hP]hR]uhFj$h@]r$h^X public userr$r$}r$(hEUhFj$ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r$r$}r$(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj$ubehIhfubahIjubj)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$hb)r$}r$(hEXid (Types.Identifier) -- Identifier for the object in question. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hK}r$(hM]hN]hO]hP]hR]uhFj$h@]r$(j)r$}r$(hEXidhK}r$(hP]hO]jhM]hN]hR]uhFj$h@]r$h^Xidr$r$}r$(hEUhFj$ubahIjubh^X (r$r$}r$(hEUhFj$ubj)r$}r$(hEX:class:`Types.Identifier`r$hFj$hGjhIjhK}r$(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr$hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r$j)r$}r$(hEj$hK}r$(hM]hN]r$(jj$Xpy-classr$ehO]hP]hR]uhFj$h@]r$h^XTypes.Identifierr$r$}r$(hEUhFj$ubahIjubaubh^X)r$}r$(hEUhFj$ubh^X -- r$r$}r$(hEUhFj$ubh^XIdentifier for the object in question. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.r$r$}r$(hEXIdentifier for the object in question. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hFj$ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r$}r$(hEUhK}r$(hM]hN]hO]hP]hR]uhFj,$h@]r$(h)r$}r$(hEXReturnshFj$hGjhIhhK}r%(hM]hN]hO]hP]hR]uhTKh@]r%h^XReturnsr%r%}r%(hEUhFj$ubaubh)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFj$h@]r%hb)r %}r %(hEX<A set of values providing a basic description of the object.hK}r %(hM]hN]hO]hP]hR]uhFj%h@]r %h^X<A set of values providing a basic description of the object.r %r%}r%(hEX<A set of values providing a basic description of the object.hFj %ubahIhfubahIhubehIh}ubhz)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFj,$h@]r%(h)r%}r%(hEX Return typehFj%hGjhIhhK}r%(hM]hN]hO]hP]hR]uhTKh@]r%h^X Return typer%r%}r%(hEUhFj%ubaubh)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%hb)r%}r %(hEXTypes.DescribeResponsehK}r!%(hM]hN]hO]hP]hR]uhFj%h@]r"%j)r#%}r$%(hEX:class:`Types.DescribeResponse`r%%hFj%hGjhIjhK}r&%(UreftypeXclassjjXTypes.DescribeResponseU refdomainXpyr'%hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r(%j)r)%}r*%(hEj%%hK}r+%(hM]hN]r,%(jj'%Xpy-classr-%ehO]hP]hR]uhFj#%h@]r.%h^XTypes.DescribeResponser/%r0%}r1%(hEUhFj)%ubahIjubaubahIhfubahIhubehIh}ubhz)r2%}r3%(hEUhK}r4%(hM]hN]hO]hP]hR]uhFj,$h@]r5%(h)r6%}r7%(hEXRaiseshFj2%hGjhIhhK}r8%(hM]hN]hO]hP]hR]uhTKh@]r9%h^XRaisesr:%r;%}r<%(hEUhFj6%ubaubh)r=%}r>%(hEUhK}r?%(hM]hN]hO]hP]hR]uhFj2%h@]r@%j)rA%}rB%(hEUhK}rC%(hM]hN]hO]hP]hR]uhFj=%h@]rD%(j)rE%}rF%(hEUhK}rG%(hM]hN]hO]hP]hR]uhFjA%h@]rH%hb)rI%}rJ%(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1360)hK}rK%(hM]hN]hO]hP]hR]uhFjE%h@]rL%(j)rM%}rN%(hEUhK}rO%(UreftypejjU reftargetXExceptions.NotAuthorizedrP%U refdomainj#hP]hO]U refexplicithM]hN]hR]uhFjI%h@]rQ%j)rR%}rS%(hEjP%hK}rT%(hM]hN]hO]hP]hR]uhFjM%h@]rU%h^XExceptions.NotAuthorizedrV%rW%}rX%(hEUhFjR%ubahIjubahIjubh^X -- rY%rZ%}r[%(hEUhFjI%ubj)r\%}r]%(hEX$``(errorCode=401, detailCode=1360)``hK}r^%(hM]hN]hO]hP]hR]uhFjI%h@]r_%h^X (errorCode=401, detailCode=1360)r`%ra%}rb%(hEUhFj\%ubahIjubehIhfubahIjubj)rc%}rd%(hEUhK}re%(hM]hN]hO]hP]hR]uhFjA%h@]rf%hb)rg%}rh%(hEX7Exceptions.NotFound -- (errorCode=404, detailCode=1380)hK}ri%(hM]hN]hO]hP]hR]uhFjc%h@]rj%(j)rk%}rl%(hEUhK}rm%(UreftypejjU reftargetXExceptions.NotFoundrn%U refdomainj#hP]hO]U refexplicithM]hN]hR]uhFjg%h@]ro%j)rp%}rq%(hEjn%hK}rr%(hM]hN]hO]hP]hR]uhFjk%h@]rs%h^XExceptions.NotFoundrt%ru%}rv%(hEUhFjp%ubahIjubahIjubh^X -- rw%rx%}ry%(hEUhFjg%ubj)rz%}r{%(hEX$``(errorCode=404, detailCode=1380)``hK}r|%(hM]hN]hO]hP]hR]uhFjg%h@]r}%h^X (errorCode=404, detailCode=1380)r~%r%}r%(hEUhFjz%ubahIjubehIhfubahIjubj)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFjA%h@]r%hb)r%}r%(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1390)hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%(j)r%}r%(hEUhK}r%(UreftypejjU reftargetXExceptions.ServiceFailurer%U refdomainj#hP]hO]U refexplicithM]hN]hR]uhFj%h@]r%j)r%}r%(hEj%hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^XExceptions.ServiceFailurer%r%}r%(hEUhFj%ubahIjubahIjubh^X -- r%r%}r%(hEUhFj%ubj)r%}r%(hEX$``(errorCode=500, detailCode=1390)``hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^X (errorCode=500, detailCode=1390)r%r%}r%(hEUhFj%ubahIjubehIhfubahIjubj)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFjA%h@]r%hb)r%}r%(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1370)hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%(j)r%}r%(hEUhK}r%(UreftypejjU reftargetXExceptions.InvalidTokenr%U refdomainj#hP]hO]U refexplicithM]hN]hR]uhFj%h@]r%j)r%}r%(hEj%hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^XExceptions.InvalidTokenr%r%}r%(hEUhFj%ubahIjubahIjubh^X -- r%r%}r%(hEUhFj%ubj)r%}r%(hEX$``(errorCode=401, detailCode=1370)``hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^X (errorCode=401, detailCode=1370)r%r%}r%(hEUhFj%ubahIjubehIhfubahIjubj)r%}r%(hEUhK}r%(hM]hN]hO]hP]hR]uhFjA%h@]r%hb)r%}r%(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1361)hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%(j)r%}r%(hEUhK}r%(UreftypejjU reftargetXExceptions.NotImplementedr%U refdomainj#hP]hO]U refexplicithM]hN]hR]uhFj%h@]r%j)r%}r%(hEj%hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^XExceptions.NotImplementedr%r%}r%(hEUhFj%ubahIjubahIjubh^X -- r%r%}r%(hEUhFj%ubj)r%}r%(hEX$``(errorCode=501, detailCode=1361)``hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^X (errorCode=501, detailCode=1361)r%r%}r%(hEUhFj%ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubhb)r%}r%(hEX **Examples**r%hFjhGjX!source/apis/examples/describe.txtr%r%}r%bhIhfhK}r%(hM]hN]hO]hP]hR]uhTKhUhh@]r%j|)r%}r%(hEj%hK}r%(hM]hN]hO]hP]hR]uhFj%h@]r%h^XExamplesr%r%}r%(hEUhFj%ubahIjubaubhb)r%}r%(hEXG(HEAD) Retrieve information about the object with identifier "ABC123"::r%hFjhGj%hIhfhK}r%(hM]hN]hO]hP]hR]uhTKhUhh@]r%h^XF(HEAD) Retrieve information about the object with identifier "ABC123":r%r%}r%(hEXF(HEAD) Retrieve information about the object with identifier "ABC123":hFj%ubaubj)r%}r%(hEXCcurl -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: 1234hFjhGj%hIjhK}r%(hhhP]hO]hM]hN]hR]uhTMhUhh@]r%h^XCcurl -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: 1234r%r%}r%(hEUhFj%ubaubhb)r%}r%(hEXJ(HEAD) An error response to a describe() request for object "IDONTEXIST"::r%hFjhGj%hIhfhK}r%(hM]hN]hO]hP]hR]uhTKhUhh@]r%h^XI(HEAD) An error response to a describe() request for object "IDONTEXIST":r%r%}r&(hEXI(HEAD) An error response to a describe() request for object "IDONTEXIST":hFj%ubaubj)r&}r&(hEX^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: IDONTEXISThFjhGX8internal padding after source/apis/examples/describe.txtr&hIjhK}r&(hhhP]hO]hM]hN]hR]uhTM)hUhh@]r&h^X^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: IDONTEXISTr&r&}r&(hEUhFj&ubaubj)r &}r &(hEUhFjhGNhIjhK}r &(hP]hO]hM]hN]hR]Uentries]r &(jX getChecksum() (in module MNRead)hUNtr &auhTNhUhh@]ubj)r&}r&(hEUhFjhGNhIjhK}r&(jjXpyr&hP]hO]hM]hN]hR]jXfunctionr&jj&uhTNhUhh@]r&(j)r&}r&(hEX8getChecksum(session,pid,[checksumAlgorithm]) -> ChecksumhFj&hGjhIjhK}r&(hP]r&hajjhO]hM]hN]hR]r&hajX getChecksumr&jUjuhTKhUhh@]r&(j)r&}r&(hEXMNRead.hFj&hGjhIjhK}r&(hM]hN]hO]hP]hR]uhTKhUhh@]r&h^XMNRead.r&r &}r!&(hEUhFj&ubaubj)r"&}r#&(hEj&hFj&hGjhIjhK}r$&(hM]hN]hO]hP]hR]uhTKhUhh@]r%&h^X getChecksumr&&r'&}r(&(hEUhFj"&ubaubj)r)&}r*&(hEX!session, pid, [checksumAlgorithm]hFj&hGjhIjhK}r+&(hM]hN]hO]hP]hR]uhTKhUhh@]r,&(j)r-&}r.&(hEXsessionhK}r/&(hM]hN]hO]hP]hR]uhFj)&h@]r0&h^Xsessionr1&r2&}r3&(hEUhFj-&ubahIjubj)r4&}r5&(hEXpidhK}r6&(hM]hN]hO]hP]hR]uhFj)&h@]r7&h^Xpidr8&r9&}r:&(hEUhFj4&ubahIjubj)r;&}r<&(hEX[checksumAlgorithm]hK}r=&(hM]hN]hO]hP]hR]uhFj)&h@]r>&j)r?&}r@&(hEXchecksumAlgorithmhK}rA&(hM]hN]hO]hP]hR]uhFj;&h@]rB&h^XchecksumAlgorithmrC&rD&}rE&(hEUhFj?&ubahIjubahIjubeubj)rF&}rG&(hEXChecksumhFj&hGjhIjhK}rH&(hM]hN]hO]hP]hR]uhTKhUhh@]rI&h^XChecksumrJ&rK&}rL&(hEUhFjF&ubaubeubj)rM&}rN&(hEUhFj&hGjhIj hK}rO&(hM]hN]hO]hP]hR]uhTKhUhh@]rP&(hb)rQ&}rR&(hEXwReturns a :class:`Types.Checksum` for the specified object using an accepted hashing algorithm. The result is used to determine if two instances referenced by a PID are identical, hence it is necessary that MNs can ensure that the returned checksum is valid for the referenced object either by computing it on the fly or by using a cached value that is certain to be correct.hFjM&hGjhIhfhK}rS&(hM]hN]hO]hP]hR]uhTKhUhh@]rT&(h^X Returns a rU&rV&}rW&(hEX Returns a hFjQ&ubj)rX&}rY&(hEX:class:`Types.Checksum`rZ&hFjQ&hGjhIjhK}r[&(UreftypeXclassjjXTypes.ChecksumU refdomainXpyr\&hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r]&j)r^&}r_&(hEjZ&hK}r`&(hM]hN]ra&(jj\&Xpy-classrb&ehO]hP]hR]uhFjX&h@]rc&h^XTypes.Checksumrd&re&}rf&(hEUhFj^&ubahIjubaubh^XV for the specified object using an accepted hashing algorithm. The result is used to determine if two instances referenced by a PID are identical, hence it is necessary that MNs can ensure that the returned checksum is valid for the referenced object either by computing it on the fly or by using a cached value that is certain to be correct.rg&rh&}ri&(hEXV for the specified object using an accepted hashing algorithm. The result is used to determine if two instances referenced by a PID are identical, hence it is necessary that MNs can ensure that the returned checksum is valid for the referenced object either by computing it on the fly or by using a cached value that is certain to be correct.hFjQ&ubeubht)rj&}rk&(hEUhFjM&hGNhIhwhK}rl&(hM]hN]hO]hP]hR]uhTNhUhh@]rm&(hz)rn&}ro&(hEUhFjj&hGjhIh}hK}rp&(hM]hN]hO]hP]hR]uhTKhUhh@]rq&(h)rr&}rs&(hEXVersionhFjn&hGjhIhhK}rt&(hM]hN]hO]hP]hR]uhTKh@]ru&h^XVersionrv&rw&}rx&(hEUhFjr&ubaubh)ry&}rz&(hEX1.0r{&hK}r|&(hM]hN]hO]hP]hR]uhFjn&h@]r}&hb)r~&}r&(hEj{&hFjy&hGjhIhfhK}r&(hM]hN]hO]hP]hR]uhTKh@]r&h^X1.0r&r&}r&(hEj{&hFj~&ubaubahIhubeubhz)r&}r&(hEUhFjj&hGjhIh}hK}r&(hM]hN]hO]hP]hR]uhTKhUhh@]r&(h)r&}r&(hEXREST URLhFj&hGjhIhhK}r&(hM]hN]hO]hP]hR]uhTKh@]r&h^XREST URLr&r&}r&(hEUhFj&ubaubh)r&}r&(hEX?``GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]``r&hK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&hb)r&}r&(hEj&hFj&hGjhIhfhK}r&(hM]hN]hO]hP]hR]uhTKh@]r&j)r&}r&(hEj&hK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&h^X;GET /checksum/{pid}[?checksumAlgorithm={checksumAlgorithm}]r&r&}r&(hEUhFj&ubahIjubaubahIhubeubhz)r&}r&(hEUhK}r&(hM]hN]hO]hP]hR]uhFjj&h@]r&(h)r&}r&(hEX ParametershFj&hGjhIhhK}r&(hM]hN]hO]hP]hR]uhTKh@]r&h^X Parametersr&r&}r&(hEUhFj&ubaubh)r&}r&(hEUhK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&j)r&}r&(hEUhK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&(j)r&}r&(hEUhK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&hb)r&}r&(hEXTsession (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.hK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&(j)r&}r&(hEXsessionhK}r&(hP]hO]jhM]hN]hR]uhFj&h@]r&h^Xsessionr&r&}r&(hEUhFj&ubahIjubh^X (r&r&}r&(hEUhFj&ubj)r&}r&(hEX:class:`Types.Session`r&hFj&hGjhIjhK}r&(UreftypeXclassjjX Types.SessionU refdomainXpyr&hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r&j)r&}r&(hEj&hK}r&(hM]hN]r&(jj&Xpy-classr&ehO]hP]hR]uhFj&h@]r&h^X Types.Sessionr&r&}r&(hEUhFj&ubahIjubaubh^X)r&}r&(hEUhFj&ubh^X -- r&r&}r&(hEUhFj&ubh^XSession 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&(hEXSession 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 hFj&ubj)r&}r&(hEX:term:`public user`r&hFj&hGjhIjhK}r&(UreftypeXtermjjX public userU refdomainXstdr&hP]hO]U refexplicithM]hN]hR]jjuhTKh@]r&jr)r&}r&(hEj&hK}r&(hM]hN]r&(jj&Xstd-termr&ehO]hP]hR]uhFj&h@]r&h^X public userr&r&}r&(hEUhFj&ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r&r&}r&(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj&ubehIhfubahIjubj)r&}r&(hEUhK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&hb)r&}r&(hEXpid (Types.Identifier) -- The identifier of the object the operation is being performed on. Transmitted as part of the URL path and must be escaped accordingly.hK}r&(hM]hN]hO]hP]hR]uhFj&h@]r&(j)r&}r&(hEXpidhK}r&(hP]hO]jhM]hN]hR]uhFj&h@]r&h^Xpidr&r&}r&(hEUhFj&ubahIjubh^X (r&r&}r&(hEUhFj&ubj)r'}r'(hEX:class:`Types.Identifier`r'hFj&hGjhIjhK}r'(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr'hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r'j)r'}r'(hEj'hK}r'(hM]hN]r '(jj'Xpy-classr 'ehO]hP]hR]uhFj'h@]r 'h^XTypes.Identifierr 'r '}r'(hEUhFj'ubahIjubaubh^X)r'}r'(hEUhFj&ubh^X -- r'r'}r'(hEUhFj&ubh^XThe identifier of the object the operation is being performed on. Transmitted as part of the URL path and must be escaped accordingly.r'r'}r'(hEXThe identifier of the object the operation is being performed on. Transmitted as part of the URL path and must be escaped accordingly.hFj&ubehIhfubahIjubj)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj&h@]r'hb)r'}r'(hEX|checksumAlgorithm (string) -- The name of an algorithm that will be used to compute a checksum of the bytes of the object. This value is drawn from a DataONE controlled list of values as indicted in the Types.SystemMetadata. If not specified, then the system wide default checksum algorithm should be used. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'(j)r'}r '(hEXchecksumAlgorithmhK}r!'(hP]hO]jhM]hN]hR]uhFj'h@]r"'h^XchecksumAlgorithmr#'r$'}r%'(hEUhFj'ubahIjubh^X (r&'r''}r('(hEUhFj'ubj)r)'}r*'(hEUhK}r+'(UreftypejjU reftargetXstringr,'U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj'h@]r-'j)r.'}r/'(hEj,'hK}r0'(hM]hN]hO]hP]hR]uhFj)'h@]r1'h^Xstringr2'r3'}r4'(hEUhFj.'ubahIjubahIjubh^X)r5'}r6'(hEUhFj'ubh^X -- r7'r8'}r9'(hEUhFj'ubh^XThe name of an algorithm that will be used to compute a checksum of the bytes of the object. This value is drawn from a DataONE controlled list of values as indicted in the r:'r;'}r<'(hEXThe name of an algorithm that will be used to compute a checksum of the bytes of the object. This value is drawn from a DataONE controlled list of values as indicted in the hFj'ubj)r='}r>'(hEX:class:`Types.SystemMetadata`r?'hFj'hGjhIjhK}r@'(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrA'hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rB'j)rC'}rD'(hEj?'hK}rE'(hM]hN]rF'(jjA'Xpy-classrG'ehO]hP]hR]uhFj='h@]rH'h^XTypes.SystemMetadatarI'rJ'}rK'(hEUhFjC'ubahIjubaubh^X. If not specified, then the system wide default checksum algorithm should be used. Transmitted as a URL query parameter, and so must be escaped accordingly.rL'rM'}rN'(hEX. If not specified, then the system wide default checksum algorithm should be used. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj'ubehIhfubahIjubehIjmubahIhubehIh}ubhz)rO'}rP'(hEUhK}rQ'(hM]hN]hO]hP]hR]uhFjj&h@]rR'(h)rS'}rT'(hEXReturnshFjO'hGjhIhhK}rU'(hM]hN]hO]hP]hR]uhTKh@]rV'h^XReturnsrW'rX'}rY'(hEUhFjS'ubaubh)rZ'}r['(hEUhK}r\'(hM]hN]hO]hP]hR]uhFjO'h@]r]'hb)r^'}r_'(hEX@The checksum value originally computed for the specified object.hK}r`'(hM]hN]hO]hP]hR]uhFjZ'h@]ra'h^X@The checksum value originally computed for the specified object.rb'rc'}rd'(hEX@The checksum value originally computed for the specified object.hFj^'ubahIhfubahIhubehIh}ubhz)re'}rf'(hEUhK}rg'(hM]hN]hO]hP]hR]uhFjj&h@]rh'(h)ri'}rj'(hEX Return typehFje'hGjhIhhK}rk'(hM]hN]hO]hP]hR]uhTKh@]rl'h^X Return typerm'rn'}ro'(hEUhFji'ubaubh)rp'}rq'(hEUhK}rr'(hM]hN]hO]hP]hR]uhFje'h@]rs'hb)rt'}ru'(hEXTypes.ChecksumhK}rv'(hM]hN]hO]hP]hR]uhFjp'h@]rw'j)rx'}ry'(hEX:class:`Types.Checksum`rz'hFjt'hGjhIjhK}r{'(UreftypeXclassjjXTypes.ChecksumU refdomainXpyr|'hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r}'j)r~'}r'(hEjz'hK}r'(hM]hN]r'(jj|'Xpy-classr'ehO]hP]hR]uhFjx'h@]r'h^XTypes.Checksumr'r'}r'(hEUhFj~'ubahIjubaubahIhfubahIhubehIh}ubhz)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFjj&h@]r'(h)r'}r'(hEXRaiseshFj'hGjhIhhK}r'(hM]hN]hO]hP]hR]uhTKh@]r'h^XRaisesr'r'}r'(hEUhFj'ubaubh)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'j)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'(j)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'hb)r'}r'(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1400)hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'(j)r'}r'(hEUhK}r'(UreftypejjU reftargetXExceptions.NotAuthorizedr'U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj'h@]r'j)r'}r'(hEj'hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^XExceptions.NotAuthorizedr'r'}r'(hEUhFj'ubahIjubahIjubh^X -- r'r'}r'(hEUhFj'ubj)r'}r'(hEX$``(errorCode=401, detailCode=1400)``hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^X (errorCode=401, detailCode=1400)r'r'}r'(hEUhFj'ubahIjubehIhfubahIjubj)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'hb)r'}r'(hEX7Exceptions.NotFound -- (errorCode=404, detailCode=1420)hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'(j)r'}r'(hEUhK}r'(UreftypejjU reftargetXExceptions.NotFoundr'U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj'h@]r'j)r'}r'(hEj'hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^XExceptions.NotFoundr'r'}r'(hEUhFj'ubahIjubahIjubh^X -- r'r'}r'(hEUhFj'ubj)r'}r'(hEX$``(errorCode=404, detailCode=1420)``hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^X (errorCode=404, detailCode=1420)r'r'}r'(hEUhFj'ubahIjubehIhfubahIjubj)r'}r'(hEUhK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'hb)r'}r'(hEXExceptions.InvalidRequest -- (errorCode=400, detailCode=1402)A supplied parameter was invalid, most likely an unsupported checksum algorithm was specified, in which case the error message should include an enumeration of supported checksum algorithms.hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'(j)r'}r'(hEUhK}r'(UreftypejjU reftargetXExceptions.InvalidRequestr'U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj'h@]r'j)r'}r'(hEj'hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^XExceptions.InvalidRequestr'r'}r'(hEUhFj'ubahIjubahIjubh^X -- r'r'}r'(hEUhFj'ubhb)r'}r'(hEX$``(errorCode=400, detailCode=1402)``r'hFj'hGjhIhfhK}r'(hM]hN]hO]hP]hR]uhTKh@]r'j)r'}r'(hEj'hK}r'(hM]hN]hO]hP]hR]uhFj'h@]r'h^X (errorCode=400, detailCode=1402)r'r'}r'(hEUhFj'ubahIjubaubhb)r'}r'(hEXA supplied parameter was invalid, most likely an unsupported checksum algorithm was specified, in which case the error message should include an enumeration of supported checksum algorithms.r'hFj'hGjhIhfhK}r'(hM]hN]hO]hP]hR]uhTKh@]r'h^XA supplied parameter was invalid, most likely an unsupported checksum algorithm was specified, in which case the error message should include an enumeration of supported checksum algorithms.r'r'}r((hEj'hFj'ubaubehIhfubahIjubj)r(}r((hEUhK}r((hM]hN]hO]hP]hR]uhFj'h@]r(hb)r(}r((hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1410)hK}r((hM]hN]hO]hP]hR]uhFj(h@]r((j)r (}r ((hEUhK}r ((UreftypejjU reftargetXExceptions.ServiceFailurer (U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj(h@]r (j)r(}r((hEj (hK}r((hM]hN]hO]hP]hR]uhFj (h@]r(h^XExceptions.ServiceFailurer(r(}r((hEUhFj(ubahIjubahIjubh^X -- r(r(}r((hEUhFj(ubj)r(}r((hEX$``(errorCode=500, detailCode=1410)``hK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^X (errorCode=500, detailCode=1410)r(r(}r((hEUhFj(ubahIjubehIhfubahIjubj)r(}r ((hEUhK}r!((hM]hN]hO]hP]hR]uhFj'h@]r"(hb)r#(}r$((hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1430)hK}r%((hM]hN]hO]hP]hR]uhFj(h@]r&((j)r'(}r(((hEUhK}r)((UreftypejjU reftargetXExceptions.InvalidTokenr*(U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFj#(h@]r+(j)r,(}r-((hEj*(hK}r.((hM]hN]hO]hP]hR]uhFj'(h@]r/(h^XExceptions.InvalidTokenr0(r1(}r2((hEUhFj,(ubahIjubahIjubh^X -- r3(r4(}r5((hEUhFj#(ubj)r6(}r7((hEX$``(errorCode=401, detailCode=1430)``hK}r8((hM]hN]hO]hP]hR]uhFj#(h@]r9(h^X (errorCode=401, detailCode=1430)r:(r;(}r<((hEUhFj6(ubahIjubehIhfubahIjubj)r=(}r>((hEUhK}r?((hM]hN]hO]hP]hR]uhFj'h@]r@(hb)rA(}rB((hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1401)hK}rC((hM]hN]hO]hP]hR]uhFj=(h@]rD((j)rE(}rF((hEUhK}rG((UreftypejjU reftargetXExceptions.NotImplementedrH(U refdomainj&hP]hO]U refexplicithM]hN]hR]uhFjA(h@]rI(j)rJ(}rK((hEjH(hK}rL((hM]hN]hO]hP]hR]uhFjE(h@]rM(h^XExceptions.NotImplementedrN(rO(}rP((hEUhFjJ(ubahIjubahIjubh^X -- rQ(rR(}rS((hEUhFjA(ubj)rT(}rU((hEX$``(errorCode=501, detailCode=1401)``hK}rV((hM]hN]hO]hP]hR]uhFjA(h@]rW(h^X (errorCode=501, detailCode=1401)rX(rY(}rZ((hEUhFjT(ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r[(}r\((hEUhFjhGNhIjhK}r]((hP]hO]hM]hN]hR]Uentries]r^((jX listObjects() (in module MNRead)hUNtr_(auhTNhUhh@]ubj)r`(}ra((hEUhFjhGNhIjhK}rb((jjXpyrc(hP]hO]hM]hN]hR]jXfunctionrd(jjd(uhTNhUhh@]re((j)rf(}rg((hEXulistObjects(session,[fromDate],[toDate],[formatId],[identifier],[replicaStatus],[start=0],[count=1000]) -> ObjectListhFj`(hGjhIjhK}rh((hP]ri(hajjhO]hM]hN]hR]rj(hajX listObjectsrk(jUjuhTMhUhh@]rl((j)rm(}rn((hEXMNRead.hFjf(hGjhIjhK}ro((hM]hN]hO]hP]hR]uhTMhUhh@]rp(h^XMNRead.rq(rr(}rs((hEUhFjm(ubaubj)rt(}ru((hEjk(hFjf(hGjhIjhK}rv((hM]hN]hO]hP]hR]uhTMhUhh@]rw(h^X listObjectsrx(ry(}rz((hEUhFjt(ubaubj)r{(}r|((hEXasession, [fromDate], [toDate], [formatId], [identifier], [replicaStatus], [start=0], [count=1000]hFjf(hGjhIjhK}r}((hM]hN]hO]hP]hR]uhTMhUhh@]r~((j)r(}r((hEXsessionhK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(h^Xsessionr(r(}r((hEUhFj(ubahIjubj)r(}r((hEX [fromDate]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEXfromDatehK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^XfromDater(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX[toDate]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEXtoDatehK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^XtoDater(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX [formatId]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEXformatIdhK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^XformatIdr(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX [identifier]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEX identifierhK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^X identifierr(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX[replicaStatus]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEX replicaStatushK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^X replicaStatusr(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX [start=0]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEXstart=0hK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^Xstart=0r(r(}r((hEUhFj(ubahIjubahIjubj)r(}r((hEX [count=1000]hK}r((hM]hN]hO]hP]hR]uhFj{(h@]r(j)r(}r((hEX count=1000hK}r((hM]hN]hO]hP]hR]uhFj(h@]r(h^X count=1000r(r(}r((hEUhFj(ubahIjubahIjubeubj)r(}r((hEX ObjectListhFjf(hGjhIjhK}r((hM]hN]hO]hP]hR]uhTMhUhh@]r(h^X ObjectListr(r(}r((hEUhFj(ubaubeubj)r(}r((hEUhFj`(hGjhIj hK}r((hM]hN]hO]hP]hR]uhTMhUhh@]r((hb)r(}r((hEXRetrieve the list of objects present on the MN that match the calling parameters. This method is required to support the process of :term:`Member Node synchronization`. At a minimum, this method MUST be able to return a list of objects that match::hFj(hGjhIhfhK}r((hM]hN]hO]hP]hR]uhTKhUhh@]r((h^XRetrieve the list of objects present on the MN that match the calling parameters. This method is required to support the process of r(r(}r((hEXRetrieve the list of objects present on the MN that match the calling parameters. This method is required to support the process of hFj(ubj)r(}r((hEX#:term:`Member Node synchronization`r(hFj(hGjhIjhK}r((UreftypeXtermjjXmember node synchronizationU refdomainXstdr(hP]hO]U refexplicithM]hN]hR]jjuhTKh@]r(jr)r(}r((hEj(hK}r((hM]hN]r((jj(Xstd-termr(ehO]hP]hR]uhFj(h@]r(h^XMember Node synchronizationr(r(}r((hEUhFj(ubahIj{ubaubh^XP. At a minimum, this method MUST be able to return a list of objects that match:r(r(}r((hEXP. At a minimum, this method MUST be able to return a list of objects that match:hFj(ubeubj)r(}r((hEX1fromDate < SystemMetadata.dateSysMetadataModifiedhFj(hGjhIjhK}r((hhhP]hO]hM]hN]hR]uhTM\hUhh@]r(h^X1fromDate < SystemMetadata.dateSysMetadataModifiedr(r(}r((hEUhFj(ubaubhb)r(}r((hEXbut 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.hFj(hGjhIhfhK}r)(hM]hN]hO]hP]hR]uhTKhUhh@]r)(h^X?but is expected to also support date range (by also specifying r)r)}r)(hEX?but is expected to also support date range (by also specifying hFj(ubj)r)}r)(hEX*toDate*hK}r)(hM]hN]hO]hP]hR]uhFj(h@]r)h^XtoDater )r )}r )(hEUhFj)ubahIjubh^X]), and should also support slicing of the matching set of records by indicating the starting r )r )}r)(hEX]), and should also support slicing of the matching set of records by indicating the starting hFj(ubj)r)}r)(hEX*index*hK}r)(hM]hN]hO]hP]hR]uhFj(h@]r)h^Xindexr)r)}r)(hEUhFj)ubahIjubh^XB of the response (where 0 is the index of the first item) and the r)r)}r)(hEXB of the response (where 0 is the index of the first item) and the hFj(ubj)r)}r)(hEX*count*hK}r)(hM]hN]hO]hP]hR]uhFj(h@]r)h^Xcountr)r)}r)(hEUhFj)ubahIjubh^X of elements to be returned.r )r!)}r")(hEX of elements to be returned.hFj(ubeubhb)r#)}r$)(hEX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r%)hFj(hGjhIhfhK}r&)(hM]hN]hO]hP]hR]uhTKhUhh@]r')h^X}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r()r))}r*)(hEj%)hFj#)ubaubhb)r+)}r,)(hEX}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r-)hFj(hGjhIhfhK}r.)(hM]hN]hO]hP]hR]uhTKhUhh@]r/)h^X}Note that date time precision is limited to one millisecond. If no timezone information is provided, the UTC will be assumed.r0)r1)}r2)(hEj-)hFj+)ubaubht)r3)}r4)(hEUhFj(hGNhIhwhK}r5)(hM]hN]hO]hP]hR]uhTNhUhh@]r6)(hz)r7)}r8)(hEUhFj3)hGjhIh}hK}r9)(hM]hN]hO]hP]hR]uhTKhUhh@]r:)(h)r;)}r<)(hEXVersionhFj7)hGjhIhhK}r=)(hM]hN]hO]hP]hR]uhTKh@]r>)h^XVersionr?)r@)}rA)(hEUhFj;)ubaubh)rB)}rC)(hEX1.0rD)hK}rE)(hM]hN]hO]hP]hR]uhFj7)h@]rF)hb)rG)}rH)(hEjD)hFjB)hGjhIhfhK}rI)(hM]hN]hO]hP]hR]uhTKh@]rJ)h^X1.0rK)rL)}rM)(hEjD)hFjG)ubaubahIhubeubhz)rN)}rO)(hEUhFj3)hGjhIh}hK}rP)(hM]hN]hO]hP]hR]uhTKhUhh@]rQ)(h)rR)}rS)(hEX Use CaseshFjN)hGjhIhhK}rT)(hM]hN]hO]hP]hR]uhTKh@]rU)h^X Use CasesrV)rW)}rX)(hEUhFjR)ubaubh)rY)}rZ)(hEXJ:doc:`UC06 `, :doc:`UC16 `r[)hK}r\)(hM]hN]hO]hP]hR]uhFjN)h@]r])hb)r^)}r_)(hEj[)hFjY)hGjhIhfhK}r`)(hM]hN]hO]hP]hR]uhTKh@]ra)(j)rb)}rc)(hEX$:doc:`UC06 `rd)hFj^)hGjhIjhK}re)(UreftypeXdocrf)jjX/design/UseCases/06_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKh@]rg)jr)rh)}ri)(hEjd)hK}rj)(hM]hN]rk)(jjf)ehO]hP]hR]uhFjb)h@]rl)h^XUC06rm)rn)}ro)(hEUhFjh)ubahIj{ubaubh^X, rp)rq)}rr)(hEX, hFj^)ubj)rs)}rt)(hEX$:doc:`UC16 `ru)hFj^)hGjhIjhK}rv)(UreftypeXdocrw)jjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKh@]rx)jr)ry)}rz)(hEju)hK}r{)(hM]hN]r|)(jjw)ehO]hP]hR]uhFjs)h@]r})h^XUC16r~)r)}r)(hEUhFjy)ubahIj{ubaubeubahIhubeubhz)r)}r)(hEUhFj3)hGjhIh}hK}r)(hM]hN]hO]hP]hR]uhTKhUhh@]r)(h)r)}r)(hEXREST URLhFj)hGjhIhhK}r)(hM]hN]hO]hP]hR]uhTKh@]r)h^XREST URLr)r)}r)(hEUhFj)ubaubh)r)}r)(hEX``GET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]``r)hK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)hb)r)}r)(hEj)hFj)hGjhIhfhK}r)(hM]hN]hO]hP]hR]uhTKh@]r)j)r)}r)(hEj)hK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)h^XGET /object[?fromDate={fromDate}&toDate={toDate}&identifier={identifier}&formatId={formatId}&replicaStatus={replicaStatus} &start={start}&count={count}]r)r)}r)(hEUhFj)ubahIjubaubahIhubeubhz)r)}r)(hEUhK}r)(hM]hN]hO]hP]hR]uhFj3)h@]r)(h)r)}r)(hEX ParametershFj)hGjhIhhK}r)(hM]hN]hO]hP]hR]uhTKh@]r)h^X Parametersr)r)}r)(hEUhFj)ubaubh)r)}r)(hEUhK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)j)r)}r)(hEUhK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)(j)r)}r)(hEUhK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)hb)r)}r)(hEXTsession (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.hK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)(j)r)}r)(hEXsessionhK}r)(hP]hO]jhM]hN]hR]uhFj)h@]r)h^Xsessionr)r)}r)(hEUhFj)ubahIjubh^X (r)r)}r)(hEUhFj)ubj)r)}r)(hEX:class:`Types.Session`r)hFj)hGjhIjhK}r)(UreftypeXclassjjX Types.SessionU refdomainXpyr)hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r)j)r)}r)(hEj)hK}r)(hM]hN]r)(jj)Xpy-classr)ehO]hP]hR]uhFj)h@]r)h^X Types.Sessionr)r)}r)(hEUhFj)ubahIjubaubh^X)r)}r)(hEUhFj)ubh^X -- r)r)}r)(hEUhFj)ubh^XSession 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)(hEXSession 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 hFj)ubj)r)}r)(hEX:term:`public user`r)hFj)hGjhIjhK}r)(UreftypeXtermjjX public userU refdomainXstdr)hP]hO]U refexplicithM]hN]hR]jjuhTKh@]r)jr)r)}r)(hEj)hK}r)(hM]hN]r)(jj)Xstd-termr)ehO]hP]hR]uhFj)h@]r)h^X public userr)r)}r)(hEUhFj)ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r)r)}r)(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj)ubehIhfubahIjubj)r)}r)(hEUhK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)hb)r)}r)(hEXfromDate (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.hK}r)(hM]hN]hO]hP]hR]uhFj)h@]r)(j)r)}r)(hEXfromDatehK}r)(hP]hO]jhM]hN]hR]uhFj)h@]r)h^XfromDater)r)}r)(hEUhFj)ubahIjubh^X (r)r)}r)(hEUhFj)ubj)r)}r)(hEX:class:`Types.DateTime`r)hFj)hGjhIjhK}r)(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r*j)r*}r*(hEj)hK}r*(hM]hN]r*(jj*Xpy-classr*ehO]hP]hR]uhFj)h@]r*h^XTypes.DateTimer*r *}r *(hEUhFj*ubahIjubaubh^X)r *}r *(hEUhFj)ubh^X -- r *r*}r*(hEUhFj)ubh^X Entries with r*r*}r*(hEX Entries with hFj)ubj)r*}r*(hEX.:attr:`SystemMetadata.dateSysMetadataModified`r*hFj)hGjhIjhK}r*(UreftypeXattrjjX&SystemMetadata.dateSysMetadataModifiedU refdomainXpyr*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r*j)r*}r*(hEj*hK}r*(hM]hN]r*(jj*Xpy-attrr*ehO]hP]hR]uhFj*h@]r*h^X&SystemMetadata.dateSysMetadataModifiedr*r *}r!*(hEUhFj*ubahIjubaubh^X greater than or equal to (>=) r"*r#*}r$*(hEX greater than or equal to (>=) hFj)ubj)r%*}r&*(hEX *fromDate*hK}r'*(hM]hN]hO]hP]hR]uhFj)h@]r(*h^XfromDater)*r**}r+*(hEUhFj%*ubahIjubh^X] must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.r,*r-*}r.*(hEX] must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj)ubehIhfubahIjubj)r/*}r0*(hEUhK}r1*(hM]hN]hO]hP]hR]uhFj)h@]r2*hb)r3*}r4*(hEXtoDate (Types.DateTime) -- Entries with SystemMetadata.dateSysMetadataModified less than (<) toDate must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r5*(hM]hN]hO]hP]hR]uhFj/*h@]r6*(j)r7*}r8*(hEXtoDatehK}r9*(hP]hO]jhM]hN]hR]uhFj3*h@]r:*h^XtoDater;*r<*}r=*(hEUhFj7*ubahIjubh^X (r>*r?*}r@*(hEUhFj3*ubj)rA*}rB*(hEX:class:`Types.DateTime`rC*hFj3*hGjhIjhK}rD*(UreftypeXclassjjXTypes.DateTimeU refdomainXpyrE*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]rF*j)rG*}rH*(hEjC*hK}rI*(hM]hN]rJ*(jjE*Xpy-classrK*ehO]hP]hR]uhFjA*h@]rL*h^XTypes.DateTimerM*rN*}rO*(hEUhFjG*ubahIjubaubh^X)rP*}rQ*(hEUhFj3*ubh^X -- rR*rS*}rT*(hEUhFj3*ubh^X Entries with rU*rV*}rW*(hEX Entries with hFj3*ubj)rX*}rY*(hEX.:attr:`SystemMetadata.dateSysMetadataModified`rZ*hFj3*hGjhIjhK}r[*(UreftypeXattrjjX&SystemMetadata.dateSysMetadataModifiedU refdomainXpyr\*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r]*j)r^*}r_*(hEjZ*hK}r`*(hM]hN]ra*(jj\*Xpy-attrrb*ehO]hP]hR]uhFjX*h@]rc*h^X&SystemMetadata.dateSysMetadataModifiedrd*re*}rf*(hEUhFj^*ubahIjubaubh^X less than (<) rg*rh*}ri*(hEX less than (<) hFj3*ubj)rj*}rk*(hEX*toDate*hK}rl*(hM]hN]hO]hP]hR]uhFj3*h@]rm*h^XtoDatern*ro*}rp*(hEUhFjj*ubahIjubh^X\ must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.rq*rr*}rs*(hEX\ must be returned. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj3*ubehIhfubahIjubj)rt*}ru*(hEUhK}rv*(hM]hN]hO]hP]hR]uhFj)h@]rw*hb)rx*}ry*(hEXformatId (Types.ObjectFormatIdentifier) -- Restrict results to the specified object format identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}rz*(hM]hN]hO]hP]hR]uhFjt*h@]r{*(j)r|*}r}*(hEXformatIdhK}r~*(hP]hO]jhM]hN]hR]uhFjx*h@]r*h^XformatIdr*r*}r*(hEUhFj|*ubahIjubh^X (r*r*}r*(hEUhFjx*ubj)r*}r*(hEX%:class:`Types.ObjectFormatIdentifier`r*hFjx*hGjhIjhK}r*(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyr*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r*j)r*}r*(hEj*hK}r*(hM]hN]r*(jj*Xpy-classr*ehO]hP]hR]uhFj*h@]r*h^XTypes.ObjectFormatIdentifierr*r*}r*(hEUhFj*ubahIjubaubh^X)r*}r*(hEUhFjx*ubh^X -- r*r*}r*(hEUhFjx*ubh^XRestrict results to the specified object format identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.r*r*}r*(hEXRestrict results to the specified object format identifier. Transmitted as a URL query parameter, and so must be escaped accordingly.hFjx*ubehIhfubahIjubj)r*}r*(hEUhK}r*(hM]hN]hO]hP]hR]uhFj)h@]r*hb)r*}r*(hEXidentifier (Types.Identifier) -- Restrict results to the specified identifier. May be a PID or a SID. In the case of the latter, returns a listing of all PIDs that share the given SID. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r*(hM]hN]hO]hP]hR]uhFj*h@]r*(j)r*}r*(hEX identifierhK}r*(hP]hO]jhM]hN]hR]uhFj*h@]r*h^X identifierr*r*}r*(hEUhFj*ubahIjubh^X (r*r*}r*(hEUhFj*ubj)r*}r*(hEX:class:`Types.Identifier`r*hFj*hGjhIjhK}r*(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r*j)r*}r*(hEj*hK}r*(hM]hN]r*(jj*Xpy-classr*ehO]hP]hR]uhFj*h@]r*h^XTypes.Identifierr*r*}r*(hEUhFj*ubahIjubaubh^X)r*}r*(hEUhFj*ubh^X -- r*r*}r*(hEUhFj*ubh^XRestrict results to the specified identifier. May be a PID or a SID. In the case of the latter, returns a listing of all PIDs that share the given SID. Transmitted as a URL query parameter, and so must be escaped accordingly.r*r*}r*(hEXRestrict results to the specified identifier. May be a PID or a SID. In the case of the latter, returns a listing of all PIDs that share the given SID. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj*ubehIhfubahIjubj)r*}r*(hEUhK}r*(hM]hN]hO]hP]hR]uhFj)h@]r*hb)r*}r*(hEXreplicaStatus (boolean) -- Indicates if replicated objects should be returned in the list (i.e. any entries present in the SystemMetadata.replica, objects that have been replicated to this node). If false, then no objects that have been replicated should be returned. If true, then any objects can be returned, regardless of replication status. The default value is true. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}r*(hM]hN]hO]hP]hR]uhFj*h@]r*(j)r*}r*(hEX replicaStatushK}r*(hP]hO]jhM]hN]hR]uhFj*h@]r*h^X replicaStatusr*r*}r*(hEUhFj*ubahIjubh^X (r*r*}r*(hEUhFj*ubj)r*}r*(hEUhK}r*(UreftypejjU reftargetXbooleanr*U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj*h@]r*j)r*}r*(hEj*hK}r*(hM]hN]hO]hP]hR]uhFj*h@]r*h^Xbooleanr*r*}r*(hEUhFj*ubahIjubahIjubh^X)r*}r*(hEUhFj*ubh^X -- r*r*}r*(hEUhFj*ubh^X`Indicates if replicated objects should be returned in the list (i.e. any entries present in the r*r*}r*(hEX`Indicates if replicated objects should be returned in the list (i.e. any entries present in the hFj*ubj)r*}r*(hEX:attr:`SystemMetadata.replica`r*hFj*hGjhIjhK}r*(UreftypeXattrjjXSystemMetadata.replicaU refdomainXpyr*hP]hO]U refexplicithM]hN]hR]jjjNjjuhTKh@]r*j)r*}r*(hEj*hK}r*(hM]hN]r*(jj*Xpy-attrr*ehO]hP]hR]uhFj*h@]r*h^XSystemMetadata.replicar*r*}r*(hEUhFj*ubahIjubaubh^X6, objects that have been replicated to this node). If r*r*}r*(hEX6, objects that have been replicated to this node). If hFj*ubj)r*}r*(hEX ``false``hK}r+(hM]hN]hO]hP]hR]uhFj*h@]r+h^Xfalser+r+}r+(hEUhFj*ubahIjubh^XC, then no objects that have been replicated should be returned. If r+r+}r+(hEXC, then no objects that have been replicated should be returned. If hFj*ubj)r+}r +(hEX``true``hK}r +(hM]hN]hO]hP]hR]uhFj*h@]r +h^Xtruer +r +}r+(hEUhFj+ubahIjubh^X[, then any objects can be returned, regardless of replication status. The default value is r+r+}r+(hEX[, then any objects can be returned, regardless of replication status. The default value is hFj*ubj)r+}r+(hEX``true``hK}r+(hM]hN]hO]hP]hR]uhFj*h@]r+h^Xtruer+r+}r+(hEUhFj+ubahIjubh^XK. Transmitted as a URL query parameter, and so must be escaped accordingly.r+r+}r+(hEXK. Transmitted as a URL query parameter, and so must be escaped accordingly.hFj*ubehIhfubahIjubj)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj)h@]r+hb)r +}r!+(hEXstart=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.hK}r"+(hM]hN]hO]hP]hR]uhFj+h@]r#+(j)r$+}r%+(hEXstart=0hK}r&+(hP]hO]jhM]hN]hR]uhFj +h@]r'+h^Xstart=0r(+r)+}r*+(hEUhFj$+ubahIjubh^X (r++r,+}r-+(hEUhFj +ubj)r.+}r/+(hEUhK}r0+(UreftypejjU reftargetXintegerr1+U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj +h@]r2+j)r3+}r4+(hEj1+hK}r5+(hM]hN]hO]hP]hR]uhFj.+h@]r6+h^Xintegerr7+r8+}r9+(hEUhFj3+ubahIjubahIjubh^X)r:+}r;+(hEUhFj +ubh^X -- r<+r=+}r>+(hEUhFj +ubh^XThe 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.r?+r@+}rA+(hEXThe 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.hFj +ubehIhfubahIjubj)rB+}rC+(hEUhK}rD+(hM]hN]hO]hP]hR]uhFj)h@]rE+hb)rF+}rG+(hEX/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.hK}rH+(hM]hN]hO]hP]hR]uhFjB+h@]rI+(j)rJ+}rK+(hEX count=1000hK}rL+(hP]hO]jhM]hN]hR]uhFjF+h@]rM+h^X count=1000rN+rO+}rP+(hEUhFjJ+ubahIjubh^X (rQ+rR+}rS+(hEUhFjF+ubj)rT+}rU+(hEUhK}rV+(UreftypejjU reftargetXintegerrW+U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFjF+h@]rX+j)rY+}rZ+(hEjW+hK}r[+(hM]hN]hO]hP]hR]uhFjT+h@]r\+h^Xintegerr]+r^+}r_+(hEUhFjY+ubahIjubahIjubh^X)r`+}ra+(hEUhFjF+ubh^X -- rb+rc+}rd+(hEUhFjF+ubh^XThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the re+rf+}rg+(hEXThe maximum number of entries that should be returned in the response. The Member Node may return fewer and the caller should check the hFjF+ubj)rh+}ri+(hEX*total*hK}rj+(hM]hN]hO]hP]hR]uhFjF+h@]rk+h^Xtotalrl+rm+}rn+(hEUhFjh+ubahIjubh^X in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.ro+rp+}rq+(hEX in the response to determine if further pages may be retrieved. Transmitted as a URL query parameter, and so must be escaped accordingly.hFjF+ubehIhfubahIjubehIjmubahIhubehIh}ubhz)rr+}rs+(hEUhK}rt+(hM]hN]hO]hP]hR]uhFj3)h@]ru+(h)rv+}rw+(hEXReturnshFjr+hGjhIhhK}rx+(hM]hN]hO]hP]hR]uhTKh@]ry+h^XReturnsrz+r{+}r|+(hEUhFjv+ubaubh)r}+}r~+(hEUhK}r+(hM]hN]hO]hP]hR]uhFjr+h@]r+hb)r+}r+(hEXYThe list of PIDs that match the query criteria. If none match, an empty list is returned.hK}r+(hM]hN]hO]hP]hR]uhFj}+h@]r+h^XYThe list of PIDs that match the query criteria. If none match, an empty list is returned.r+r+}r+(hEXYThe list of PIDs that match the query criteria. If none match, an empty list is returned.hFj+ubahIhfubahIhubehIh}ubhz)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj3)h@]r+(h)r+}r+(hEX Return typehFj+hGjhIhhK}r+(hM]hN]hO]hP]hR]uhTKh@]r+h^X Return typer+r+}r+(hEUhFj+ubaubh)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+hb)r+}r+(hEXTypes.ObjectListhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+j)r+}r+(hEX:class:`Types.ObjectList`r+hFj+hGjhIjhK}r+(UreftypeXclassjjXTypes.ObjectListU refdomainXpyr+hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMh@]r+j)r+}r+(hEj+hK}r+(hM]hN]r+(jj+Xpy-classr+ehO]hP]hR]uhFj+h@]r+h^XTypes.ObjectListr+r+}r+(hEUhFj+ubahIjubaubahIhfubahIhubehIh}ubhz)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj3)h@]r+(h)r+}r+(hEXRaiseshFj+hGjhIhhK}r+(hM]hN]hO]hP]hR]uhTKh@]r+h^XRaisesr+r+}r+(hEUhFj+ubaubh)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+j)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+(j)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+hb)r+}r+(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1520)hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+(j)r+}r+(hEUhK}r+(UreftypejjU reftargetXExceptions.NotAuthorizedr+U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj+h@]r+j)r+}r+(hEj+hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+h^XExceptions.NotAuthorizedr+r+}r+(hEUhFj+ubahIjubahIjubh^X -- r+r+}r+(hEUhFj+ubj)r+}r+(hEX$``(errorCode=401, detailCode=1520)``hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+h^X (errorCode=401, detailCode=1520)r+r+}r+(hEUhFj+ubahIjubehIhfubahIjubj)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+hb)r+}r+(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1540)hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+(j)r+}r+(hEUhK}r+(UreftypejjU reftargetXExceptions.InvalidRequestr+U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj+h@]r+j)r+}r+(hEj+hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+h^XExceptions.InvalidRequestr+r+}r+(hEUhFj+ubahIjubahIjubh^X -- r+r+}r+(hEUhFj+ubj)r+}r+(hEX$``(errorCode=400, detailCode=1540)``hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+h^X (errorCode=400, detailCode=1540)r+r+}r+(hEUhFj+ubahIjubehIhfubahIjubj)r+}r+(hEUhK}r+(hM]hN]hO]hP]hR]uhFj+h@]r+hb)r+}r+(hEXXExceptions.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.hK}r+(hM]hN]hO]hP]hR]uhFj+h@]r,(j)r,}r,(hEUhK}r,(UreftypejjU reftargetXExceptions.NotImplementedr,U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj+h@]r,j)r,}r,(hEj,hK}r,(hM]hN]hO]hP]hR]uhFj,h@]r ,h^XExceptions.NotImplementedr ,r ,}r ,(hEUhFj,ubahIjubahIjubh^X -- r ,r,}r,(hEUhFj+ubhb)r,}r,(hEX$``(errorCode=501, detailCode=1560)``r,hFj+hGjhIhfhK}r,(hM]hN]hO]hP]hR]uhTMh@]r,j)r,}r,(hEj,hK}r,(hM]hN]hO]hP]hR]uhFj,h@]r,h^X (errorCode=501, detailCode=1560)r,r,}r,(hEUhFj,ubahIjubaubhb)r,}r,(hEXRaised 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.r,hFj+hGjhIhfhK}r,(hM]hN]hO]hP]hR]uhTM h@]r ,h^XRaised 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.r!,r",}r#,(hEj,hFj,ubaubehIhfubahIjubj)r$,}r%,(hEUhK}r&,(hM]hN]hO]hP]hR]uhFj+h@]r',hb)r(,}r),(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1580)hK}r*,(hM]hN]hO]hP]hR]uhFj$,h@]r+,(j)r,,}r-,(hEUhK}r.,(UreftypejjU reftargetXExceptions.ServiceFailurer/,U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFj(,h@]r0,j)r1,}r2,(hEj/,hK}r3,(hM]hN]hO]hP]hR]uhFj,,h@]r4,h^XExceptions.ServiceFailurer5,r6,}r7,(hEUhFj1,ubahIjubahIjubh^X -- r8,r9,}r:,(hEUhFj(,ubj)r;,}r<,(hEX$``(errorCode=500, detailCode=1580)``hK}r=,(hM]hN]hO]hP]hR]uhFj(,h@]r>,h^X (errorCode=500, detailCode=1580)r?,r@,}rA,(hEUhFj;,ubahIjubehIhfubahIjubj)rB,}rC,(hEUhK}rD,(hM]hN]hO]hP]hR]uhFj+h@]rE,hb)rF,}rG,(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1530)hK}rH,(hM]hN]hO]hP]hR]uhFjB,h@]rI,(j)rJ,}rK,(hEUhK}rL,(UreftypejjU reftargetXExceptions.InvalidTokenrM,U refdomainjc(hP]hO]U refexplicithM]hN]hR]uhFjF,h@]rN,j)rO,}rP,(hEjM,hK}rQ,(hM]hN]hO]hP]hR]uhFjJ,h@]rR,h^XExceptions.InvalidTokenrS,rT,}rU,(hEUhFjO,ubahIjubahIjubh^X -- rV,rW,}rX,(hEUhFjF,ubj)rY,}rZ,(hEX$``(errorCode=401, detailCode=1530)``hK}r[,(hM]hN]hO]hP]hR]uhFjF,h@]r\,h^X (errorCode=401, detailCode=1530)r],r^,}r_,(hEUhFjY,ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubhb)r`,}ra,(hEX **Example**rb,hFjhGjX$source/apis/examples/listObjects.txtrc,rd,}re,bhIhfhK}rf,(hM]hN]hO]hP]hR]uhTKhUhh@]rg,j|)rh,}ri,(hEjb,hK}rj,(hM]hN]hO]hP]hR]uhFj`,h@]rk,h^XExamplerl,rm,}rn,(hEUhFjh,ubahIjubaubhb)ro,}rp,(hEXoRetrieve an object list from a member node, and pipe the response through an xml formatter for easier viewing::hFjhGjd,hIhfhK}rq,(hM]hN]hO]hP]hR]uhTKhUhh@]rr,h^XnRetrieve an object list from a member node, and pipe the response through an xml formatter for easier viewing:rs,rt,}ru,(hEXnRetrieve an object list from a member node, and pipe the response through an xml formatter for easier viewing:hFjo,ubaubj)rv,}rw,(hEXMcurl "https://gmn-dev.test.dataone.org/mn/v1/object?count=5" | xml fo AnserMatrix.htm eml://ecoinformatics.org/eml-2.0.0 0e25cf59d7bd4d57154cc83e0aa32b34 1970-05-27T06:12:49 11048 ... hdl:10255/dryad.218/mets.xml eml://ecoinformatics.org/eml-2.0.0 65c4e0a9c4ccf37c1e3ecaaa2541e9d5 1987-01-14T07:09:09 2796 hFjhGX;internal padding after source/apis/examples/listObjects.txtrx,hIjhK}ry,(hhhP]hO]hM]hN]hR]uhTMhUhh@]rz,h^XMcurl "https://gmn-dev.test.dataone.org/mn/v1/object?count=5" | xml fo AnserMatrix.htm eml://ecoinformatics.org/eml-2.0.0 0e25cf59d7bd4d57154cc83e0aa32b34 1970-05-27T06:12:49 11048 ... hdl:10255/dryad.218/mets.xml eml://ecoinformatics.org/eml-2.0.0 65c4e0a9c4ccf37c1e3ecaaa2541e9d5 1987-01-14T07:09:09 2796 r{,r|,}r},(hEUhFjv,ubaubj)r~,}r,(hEUhFjhGNhIjhK}r,(hP]hO]hM]hN]hR]Uentries]r,(jX*synchronizationFailed() (in module MNRead)hUNtr,auhTNhUhh@]ubj)r,}r,(hEUhFjhGNhIjhK}r,(jjXpyr,hP]hO]hM]hN]hR]jXfunctionr,jj,uhTNhUhh@]r,(j)r,}r,(hEX1synchronizationFailed(session,message) -> BooleanhFj,hGjhIjhK}r,(hP]r,hajjhO]hM]hN]hR]r,hajXsynchronizationFailedr,jUjuhTM6hUhh@]r,(j)r,}r,(hEXMNRead.hFj,hGjhIjhK}r,(hM]hN]hO]hP]hR]uhTM6hUhh@]r,h^XMNRead.r,r,}r,(hEUhFj,ubaubj)r,}r,(hEj,hFj,hGjhIjhK}r,(hM]hN]hO]hP]hR]uhTM6hUhh@]r,h^XsynchronizationFailedr,r,}r,(hEUhFj,ubaubj)r,}r,(hEXsession, messagehFj,hGjhIjhK}r,(hM]hN]hO]hP]hR]uhTM6hUhh@]r,(j)r,}r,(hEXsessionhK}r,(hM]hN]hO]hP]hR]uhFj,h@]r,h^Xsessionr,r,}r,(hEUhFj,ubahIjubj)r,}r,(hEXmessagehK}r,(hM]hN]hO]hP]hR]uhFj,h@]r,h^Xmessager,r,}r,(hEUhFj,ubahIjubeubj)r,}r,(hEXBooleanhFj,hGjhIjhK}r,(hM]hN]hO]hP]hR]uhTM6hUhh@]r,h^XBooleanr,r,}r,(hEUhFj,ubaubeubj)r,}r,(hEUhFj,hGjhIj hK}r,(hM]hN]hO]hP]hR]uhTM6hUhh@]r,(hb)r,}r,(hEXThis is a callback method used by a CN to indicate to a MN that it cannot complete synchronization of the science metadata identified by *pid*. When called, the MN should take steps to record the problem description and notify an administrator or the data owner of the issue.hFj,hGjhIhfhK}r,(hM]hN]hO]hP]hR]uhTMhUhh@]r,(h^XThis is a callback method used by a CN to indicate to a MN that it cannot complete synchronization of the science metadata identified by r,r,}r,(hEXThis is a callback method used by a CN to indicate to a MN that it cannot complete synchronization of the science metadata identified by hFj,ubj)r,}r,(hEX*pid*hK}r,(hM]hN]hO]hP]hR]uhFj,h@]r,h^Xpidr,r,}r,(hEUhFj,ubahIjubh^X. When called, the MN should take steps to record the problem description and notify an administrator or the data owner of the issue.r,r,}r,(hEX. When called, the MN should take steps to record the problem description and notify an administrator or the data owner of the issue.hFj,ubeubhb)r,}r,(hEXA successful response is indicated by a HTTP status of 200. An unsuccessful call is indicated by a returned exception and associated HTTP status code.r,hFj,hGjhIhfhK}r,(hM]hN]hO]hP]hR]uhTMhUhh@]r,h^XA successful response is indicated by a HTTP status of 200. An unsuccessful call is indicated by a returned exception and associated HTTP status code.r,r,}r,(hEj,hFj,ubaubhb)r,}r,(hEXAccess control for this method MUST be configured to allow calling by Coordinating Nodes and MAY be configured to allow more general access.r,hFj,hGjhIhfhK}r,(hM]hN]hO]hP]hR]uhTMhUhh@]r,h^XAccess control for this method MUST be configured to allow calling by Coordinating Nodes and MAY be configured to allow more general access.r,r,}r,(hEj,hFj,ubaubht)r,}r,(hEUhFj,hGNhIhwhK}r,(hM]hN]hO]hP]hR]uhTNhUhh@]r,(hz)r,}r,(hEUhFj,hGjhIh}hK}r,(hM]hN]hO]hP]hR]uhTMhUhh@]r,(h)r,}r,(hEXVersionhFj,hGjhIhhK}r,(hM]hN]hO]hP]hR]uhTKh@]r,h^XVersionr,r,}r,(hEUhFj,ubaubh)r,}r,(hEUhK}r,(hM]hN]hO]hP]hR]uhFj,h@]hIhubeubhz)r,}r,(hEUhFj,hGjhIh}hK}r,(hM]hN]hO]hP]hR]uhTMhUhh@]r,(h)r,}r,(hEX Use CaseshFj,hGjhIhhK}r,(hM]hN]hO]hP]hR]uhTKh@]r,h^X Use Casesr,r,}r,(hEUhFj,ubaubh)r,}r,(hEX$:doc:`UC06 `r,hK}r,(hM]hN]hO]hP]hR]uhFj,h@]r,hb)r,}r,(hEj,hFj,hGjhIhfhK}r-(hM]hN]hO]hP]hR]uhTMh@]r-j)r-}r-(hEj,hFj,hGjhIjhK}r-(UreftypeXdocr-jjX/design/UseCases/06_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTMh@]r-jr)r-}r-(hEj,hK}r -(hM]hN]r -(jj-ehO]hP]hR]uhFj-h@]r -h^XUC06r -r -}r-(hEUhFj-ubahIj{ubaubaubahIhubeubhz)r-}r-(hEUhFj,hGjhIh}hK}r-(hM]hN]hO]hP]hR]uhTM hUhh@]r-(h)r-}r-(hEXREST URLhFj-hGjhIhhK}r-(hM]hN]hO]hP]hR]uhTKh@]r-h^XREST URLr-r-}r-(hEUhFj-ubaubh)r-}r-(hEX``POST /error``r-hK}r-(hM]hN]hO]hP]hR]uhFj-h@]r-hb)r-}r -(hEj-hFj-hGjhIhfhK}r!-(hM]hN]hO]hP]hR]uhTM h@]r"-j)r#-}r$-(hEj-hK}r%-(hM]hN]hO]hP]hR]uhFj-h@]r&-h^X POST /errorr'-r(-}r)-(hEUhFj#-ubahIjubaubahIhubeubhz)r*-}r+-(hEUhK}r,-(hM]hN]hO]hP]hR]uhFj,h@]r--(h)r.-}r/-(hEX ParametershFj*-hGjhIhhK}r0-(hM]hN]hO]hP]hR]uhTKh@]r1-h^X Parametersr2-r3-}r4-(hEUhFj.-ubaubh)r5-}r6-(hEUhK}r7-(hM]hN]hO]hP]hR]uhFj*-h@]r8-j)r9-}r:-(hEUhK}r;-(hM]hN]hO]hP]hR]uhFj5-h@]r<-(j)r=-}r>-(hEUhK}r?-(hM]hN]hO]hP]hR]uhFj9-h@]r@-hb)rA-}rB-(hEXTsession (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.hK}rC-(hM]hN]hO]hP]hR]uhFj=-h@]rD-(j)rE-}rF-(hEXsessionhK}rG-(hP]hO]jhM]hN]hR]uhFjA-h@]rH-h^XsessionrI-rJ-}rK-(hEUhFjE-ubahIjubh^X (rL-rM-}rN-(hEUhFjA-ubj)rO-}rP-(hEX:class:`Types.Session`rQ-hFjA-hGjhIjhK}rR-(UreftypeXclassjjX Types.SessionU refdomainXpyrS-hP]hO]U refexplicithM]hN]hR]jjjNjjuhTM"h@]rT-j)rU-}rV-(hEjQ-hK}rW-(hM]hN]rX-(jjS-Xpy-classrY-ehO]hP]hR]uhFjO-h@]rZ-h^X Types.Sessionr[-r\-}r]-(hEUhFjU-ubahIjubaubh^X)r^-}r_-(hEUhFjA-ubh^X -- r`-ra-}rb-(hEUhFjA-ubh^XSession 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 rc-rd-}re-(hEXSession 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 hFjA-ubj)rf-}rg-(hEX:term:`public user`rh-hFjA-hGjhIjhK}ri-(UreftypeXtermjjX public userU refdomainXstdrj-hP]hO]U refexplicithM]hN]hR]jjuhTM!h@]rk-jr)rl-}rm-(hEjh-hK}rn-(hM]hN]ro-(jjj-Xstd-termrp-ehO]hP]hR]uhFjf-h@]rq-h^X public userrr-rs-}rt-(hEUhFjl-ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.ru-rv-}rw-(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFjA-ubehIhfubahIjubj)rx-}ry-(hEUhK}rz-(hM]hN]hO]hP]hR]uhFj9-h@]r{-hb)r|-}r}-(hEXmessage (Types.Exception) -- An instance of the Exceptions.SynchronizationFailed exception with body appropriately filled. 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.hK}r~-(hM]hN]hO]hP]hR]uhFjx-h@]r-(j)r-}r-(hEXmessagehK}r-(hP]hO]jhM]hN]hR]uhFj|-h@]r-h^Xmessager-r-}r-(hEUhFj-ubahIjubh^X (r-r-}r-(hEUhFj|-ubj)r-}r-(hEX:class:`Types.Exception`r-hFj|-hGjhIjhK}r-(UreftypeXclassjjXTypes.ExceptionU refdomainXpyr-hP]hO]U refexplicithM]hN]hR]jjjNjjuhTM%h@]r-j)r-}r-(hEj-hK}r-(hM]hN]r-(jj-Xpy-classr-ehO]hP]hR]uhFj-h@]r-h^XTypes.Exceptionr-r-}r-(hEUhFj-ubahIjubaubh^X)r-}r-(hEUhFj|-ubh^X -- r-r-}r-(hEUhFj|-ubh^XAn instance of the r-r-}r-(hEXAn instance of the hFj|-ubj)r-}r-(hEX':exc:`Exceptions.SynchronizationFailed`r-hFj|-hGjhIjhK}r-(UreftypeXexcjjX Exceptions.SynchronizationFailedU refdomainXpyr-hP]hO]U refexplicithM]hN]hR]jjjNjjuhTM$h@]r-j)r-}r-(hEj-hK}r-(hM]hN]r-(jj-Xpy-excr-ehO]hP]hR]uhFj-h@]r-h^X Exceptions.SynchronizationFailedr-r-}r-(hEUhFj-ubahIjubaubh^X exception with body appropriately filled. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a r-r-}r-(hEX exception with body appropriately filled. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hFj|-ubj)r-}r-(hEX *File part*hK}r-(hM]hN]hO]hP]hR]uhFj|-h@]r-h^X File partr-r-}r-(hEUhFj-ubahIjubh^X% of the MIME multipart/mixed message.r-r-}r-(hEX% of the MIME multipart/mixed message.hFj|-ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r-}r-(hEUhK}r-(hM]hN]hO]hP]hR]uhFj,h@]r-(h)r-}r-(hEXReturnshFj-hGjhIhhK}r-(hM]hN]hO]hP]hR]uhTKh@]r-h^XReturnsr-r-}r-(hEUhFj-ubaubh)r-}r-(hEUhK}r-(hM]hN]hO]hP]hR]uhFj-h@]r-hb)r-}r-(hEXA successful response is indicated by a HTTP 200 status. An unsuccessful call is indicated by returing the appropriate exception.hK}r-(hM]hN]hO]hP]hR]uhFj-h@]r-h^XA successful response is indicated by a HTTP 200 status. An unsuccessful call is indicated by returing the appropriate exception.r-r-}r-(hEXA successful response is indicated by a HTTP 200 status. An unsuccessful call is indicated by returing the appropriate exception.r-hFj-ubahIhfubahIhubehIh}ubhz)r-}r-(hEUhK}r-(hM]hN]hO]hP]hR]uhFj,h@]r-(h)r-}r-(hEX Return typehFj-hGjhIhhK}r-(hM]hN]hO]hP]hR]uhTKh@]r-h^X Return typer-r-}r-(hEUhFj-ubaubh)r-}r-(hEUhK}r-(hM]hN]hO]hP]hR]uhFj-h@]r-hb)r-}r-(hEX Types.BooleanhK}r-(hM]hN]hO]hP]hR]uhFj-h@]r-j)r-}r-(hEX:class:`Types.Boolean`r-hFj-hGjhIjhK}r-(UreftypeXclassjjX Types.BooleanU refdomainXpyr-hP]hO]U refexplicithM]hN]hR]jjjNjjuhTM(h@]r-j)r-}r-(hEj-hK}r-(hM]hN]r-(jj-Xpy-classr-ehO]hP]hR]uhFj-h@]r-h^X Types.Booleanr-r-}r-(hEUhFj-ubahIjubaubahIhfubahIhubehIh}ubhz)r-}r-(hEUhK}r-(hM]hN]hO]hP]hR]uhFj,h@]r-(h)r-}r-(hEXRaiseshFj-hGjhIhhK}r-(hM]hN]hO]hP]hR]uhTKh@]r-h^XRaisesr-r-}r.(hEUhFj-ubaubh)r.}r.(hEUhK}r.(hM]hN]hO]hP]hR]uhFj-h@]r.j)r.}r.(hEUhK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.(j)r .}r .(hEUhK}r .(hM]hN]hO]hP]hR]uhFj.h@]r .hb)r .}r.(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2160)hK}r.(hM]hN]hO]hP]hR]uhFj .h@]r.(j)r.}r.(hEUhK}r.(UreftypejjU reftargetXExceptions.NotImplementedr.U refdomainj,hP]hO]U refexplicithM]hN]hR]uhFj .h@]r.j)r.}r.(hEj.hK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.h^XExceptions.NotImplementedr.r.}r.(hEUhFj.ubahIjubahIjubh^X -- r.r.}r.(hEUhFj .ubj)r .}r!.(hEX$``(errorCode=501, detailCode=2160)``r".hK}r#.(hM]hN]hO]hP]hR]uhFj .h@]r$.h^X (errorCode=501, detailCode=2160)r%.r&.}r'.(hEUhFj .ubahIjubehIhfubahIjubj)r(.}r).(hEUhK}r*.(hM]hN]hO]hP]hR]uhFj.h@]r+.hb)r,.}r-.(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2161)hK}r..(hM]hN]hO]hP]hR]uhFj(.h@]r/.(j)r0.}r1.(hEUhK}r2.(UreftypejjU reftargetXExceptions.ServiceFailurer3.U refdomainj,hP]hO]U refexplicithM]hN]hR]uhFj,.h@]r4.j)r5.}r6.(hEj3.hK}r7.(hM]hN]hO]hP]hR]uhFj0.h@]r8.h^XExceptions.ServiceFailurer9.r:.}r;.(hEUhFj5.ubahIjubahIjubh^X -- r<.r=.}r>.(hEUhFj,.ubj)r?.}r@.(hEX$``(errorCode=500, detailCode=2161)``rA.hK}rB.(hM]hN]hO]hP]hR]uhFj,.h@]rC.h^X (errorCode=500, detailCode=2161)rD.rE.}rF.(hEUhFj?.ubahIjubehIhfubahIjubj)rG.}rH.(hEUhK}rI.(hM]hN]hO]hP]hR]uhFj.h@]rJ.hb)rK.}rL.(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2162)hK}rM.(hM]hN]hO]hP]hR]uhFjG.h@]rN.(j)rO.}rP.(hEUhK}rQ.(UreftypejjU reftargetXExceptions.NotAuthorizedrR.U refdomainj,hP]hO]U refexplicithM]hN]hR]uhFjK.h@]rS.j)rT.}rU.(hEjR.hK}rV.(hM]hN]hO]hP]hR]uhFjO.h@]rW.h^XExceptions.NotAuthorizedrX.rY.}rZ.(hEUhFjT.ubahIjubahIjubh^X -- r[.r\.}r].(hEUhFjK.ubj)r^.}r_.(hEX$``(errorCode=401, detailCode=2162)``r`.hK}ra.(hM]hN]hO]hP]hR]uhFjK.h@]rb.h^X (errorCode=401, detailCode=2162)rc.rd.}re.(hEUhFj^.ubahIjubehIhfubahIjubj)rf.}rg.(hEUhK}rh.(hM]hN]hO]hP]hR]uhFj.h@]ri.hb)rj.}rk.(hEX~Exceptions.InvalidToken -- (errorCode=401, detailCode=2164)Optionally raised by the receiving MN, depending on implementation.hK}rl.(hM]hN]hO]hP]hR]uhFjf.h@]rm.(j)rn.}ro.(hEUhK}rp.(UreftypejjU reftargetXExceptions.InvalidTokenrq.U refdomainj,hP]hO]U refexplicithM]hN]hR]uhFjj.h@]rr.j)rs.}rt.(hEjq.hK}ru.(hM]hN]hO]hP]hR]uhFjn.h@]rv.h^XExceptions.InvalidTokenrw.rx.}ry.(hEUhFjs.ubahIjubahIjubh^X -- rz.r{.}r|.(hEUhFjj.ubhb)r}.}r~.(hEX$``(errorCode=401, detailCode=2164)``r.hFjj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM0h@]r.j)r.}r.(hEj.hK}r.(hM]hN]hO]hP]hR]uhFj}.h@]r.h^X (errorCode=401, detailCode=2164)r.r.}r.(hEUhFj.ubahIjubaubhb)r.}r.(hEXCOptionally raised by the receiving MN, depending on implementation.r.hFjj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM2h@]r.h^XCOptionally raised by the receiving MN, depending on implementation.r.r.}r.(hEj.hFj.ubaubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r.}r.(hEUhFjhGNhIjhK}r.(hP]hO]hM]hN]hR]Uentries]r.(jX*systemMetadataChanged() (in module MNRead)h&UNtr.auhTNhUhh@]ubj)r.}r.(hEUhFjhGNhIjhK}r.(jjXpyr.hP]hO]hM]hN]hR]jXfunctionr.jj.uhTNhUhh@]r.(j)r.}r.(hEXRsystemMetadataChanged(session,id,serialVersion,dateSysMetaLastModified) -> booleanhFj.hGjhIjhK}r.(hP]r.h&ajjhO]hM]hN]hR]r.h&ajXsystemMetadataChangedr.jUjuhTM^hUhh@]r.(j)r.}r.(hEXMNRead.hFj.hGjhIjhK}r.(hM]hN]hO]hP]hR]uhTM^hUhh@]r.h^XMNRead.r.r.}r.(hEUhFj.ubaubj)r.}r.(hEj.hFj.hGjhIjhK}r.(hM]hN]hO]hP]hR]uhTM^hUhh@]r.h^XsystemMetadataChangedr.r.}r.(hEUhFj.ubaubj)r.}r.(hEX3session, id, serialVersion, dateSysMetaLastModifiedhFj.hGjhIjhK}r.(hM]hN]hO]hP]hR]uhTM^hUhh@]r.(j)r.}r.(hEXsessionhK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.h^Xsessionr.r.}r.(hEUhFj.ubahIjubj)r.}r.(hEXidhK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.h^Xidr.r.}r.(hEUhFj.ubahIjubj)r.}r.(hEX serialVersionhK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.h^X serialVersionr.r.}r.(hEUhFj.ubahIjubj)r.}r.(hEXdateSysMetaLastModifiedhK}r.(hM]hN]hO]hP]hR]uhFj.h@]r.h^XdateSysMetaLastModifiedr.r.}r.(hEUhFj.ubahIjubeubj)r.}r.(hEXbooleanhFj.hGjhIjhK}r.(hM]hN]hO]hP]hR]uhTM^hUhh@]r.h^Xbooleanr.r.}r.(hEUhFj.ubaubeubj)r.}r.(hEUhFj.hGjhIj hK}r.(hM]hN]hO]hP]hR]uhTM^hUhh@]r.(hb)r.}r.(hEXnNotifies the Member Node that the authoritative copy of system metadata on the Coordinating Nodes has changed.r.hFj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM9hUhh@]r.h^XnNotifies the Member Node that the authoritative copy of system metadata on the Coordinating Nodes has changed.r.r.}r.(hEj.hFj.ubaubhb)r.}r.(hEXThe Member Node SHOULD schedule an update to its information about the affected object by retrieving an authoritative copy from a Coordinating Node.r.hFj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM;hUhh@]r.h^XThe Member Node SHOULD schedule an update to its information about the affected object by retrieving an authoritative copy from a Coordinating Node.r.r.}r.(hEj.hFj.ubaubhb)r.}r.(hEX<Note that date time precision is limited to one millisecond.r.hFj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM=hUhh@]r.h^X<Note that date time precision is limited to one millisecond.r.r.}r.(hEj.hFj.ubaubhb)r.}r.(hEXYAccess control for this method MUST be configured to allow calling by Coordinating Nodes.r.hFj.hGjhIhfhK}r.(hM]hN]hO]hP]hR]uhTM?hUhh@]r.h^XYAccess control for this method MUST be configured to allow calling by Coordinating Nodes.r.r.}r.(hEj.hFj.ubaubht)r.}r.(hEUhFj.hGNhIhwhK}r.(hM]hN]hO]hP]hR]uhTNhUhh@]r.(hz)r/}r/(hEUhFj.hGjhIh}hK}r/(hM]hN]hO]hP]hR]uhTMAhUhh@]r/(h)r/}r/(hEXVersionhFj/hGjhIhhK}r/(hM]hN]hO]hP]hR]uhTKh@]r/h^XVersionr/r /}r /(hEUhFj/ubaubh)r /}r /(hEX1.0r /hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/hb)r/}r/(hEj /hFj /hGjhIhfhK}r/(hM]hN]hO]hP]hR]uhTMAh@]r/h^X1.0r/r/}r/(hEj /hFj/ubaubahIhubeubhz)r/}r/(hEUhFj.hGjhIh}hK}r/(hM]hN]hO]hP]hR]uhTMBhUhh@]r/(h)r/}r/(hEXREST URLhFj/hGjhIhhK}r/(hM]hN]hO]hP]hR]uhTKh@]r/h^XREST URLr/r /}r!/(hEUhFj/ubaubh)r"/}r#/(hEX``POST /dirtySystemMetadata``r$/hK}r%/(hM]hN]hO]hP]hR]uhFj/h@]r&/hb)r'/}r(/(hEj$/hFj"/hGjhIhfhK}r)/(hM]hN]hO]hP]hR]uhTMBh@]r*/j)r+/}r,/(hEj$/hK}r-/(hM]hN]hO]hP]hR]uhFj'/h@]r./h^XPOST /dirtySystemMetadatar//r0/}r1/(hEUhFj+/ubahIjubaubahIhubeubhz)r2/}r3/(hEUhK}r4/(hM]hN]hO]hP]hR]uhFj.h@]r5/(h)r6/}r7/(hEX ParametershFj2/hGjhIhhK}r8/(hM]hN]hO]hP]hR]uhTKh@]r9/h^X Parametersr:/r;/}r/(hEUhK}r?/(hM]hN]hO]hP]hR]uhFj2/h@]r@/j)rA/}rB/(hEUhK}rC/(hM]hN]hO]hP]hR]uhFj=/h@]rD/(j)rE/}rF/(hEUhK}rG/(hM]hN]hO]hP]hR]uhFjA/h@]rH/hb)rI/}rJ/(hEXTsession (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.hK}rK/(hM]hN]hO]hP]hR]uhFjE/h@]rL/(j)rM/}rN/(hEXsessionhK}rO/(hP]hO]jhM]hN]hR]uhFjI/h@]rP/h^XsessionrQ/rR/}rS/(hEUhFjM/ubahIjubh^X (rT/rU/}rV/(hEUhFjI/ubj)rW/}rX/(hEX:class:`Types.Session`rY/hFjI/hGjhIjhK}rZ/(UreftypeXclassjjX Types.SessionU refdomainXpyr[/hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMDh@]r\/j)r]/}r^/(hEjY/hK}r_/(hM]hN]r`/(jj[/Xpy-classra/ehO]hP]hR]uhFjW/h@]rb/h^X Types.Sessionrc/rd/}re/(hEUhFj]/ubahIjubaubh^X)rf/}rg/(hEUhFjI/ubh^X -- rh/ri/}rj/(hEUhFjI/ubh^XSession 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 rk/rl/}rm/(hEXSession 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 hFjI/ubj)rn/}ro/(hEX:term:`public user`rp/hFjI/hGjhIjhK}rq/(UreftypeXtermjjX public userU refdomainXstdrr/hP]hO]U refexplicithM]hN]hR]jjuhTMCh@]rs/jr)rt/}ru/(hEjp/hK}rv/(hM]hN]rw/(jjr/Xstd-termrx/ehO]hP]hR]uhFjn/h@]ry/h^X public userrz/r{/}r|/(hEUhFjt/ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r}/r~/}r/(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFjI/ubehIhfubahIjubj)r/}r/(hEUhK}r/(hM]hN]hO]hP]hR]uhFjA/h@]r/hb)r/}r/(hEXid (Types.Identifier) -- Identifier of the object for which system metadata was changed. May be either a PID or a SID. Calling with SID is equivalent to calling with HEAD PID. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/(j)r/}r/(hEXidhK}r/(hP]hO]jhM]hN]hR]uhFj/h@]r/h^Xidr/r/}r/(hEUhFj/ubahIjubh^X (r/r/}r/(hEUhFj/ubj)r/}r/(hEX:class:`Types.Identifier`r/hFj/hGjhIjhK}r/(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr/hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMGh@]r/j)r/}r/(hEj/hK}r/(hM]hN]r/(jj/Xpy-classr/ehO]hP]hR]uhFj/h@]r/h^XTypes.Identifierr/r/}r/(hEUhFj/ubahIjubaubh^X)r/}r/(hEUhFj/ubh^X -- r/r/}r/(hEUhFj/ubh^XIdentifier of the object for which system metadata was changed. May be either a PID or a SID. Calling with SID is equivalent to calling with HEAD PID. Transmitted as a UTF-8 String as a r/r/}r/(hEXIdentifier of the object for which system metadata was changed. May be either a PID or a SID. Calling with SID is equivalent to calling with HEAD PID. Transmitted as a UTF-8 String as a hFj/ubj)r/}r/(hEX *Param part*hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/h^X Param partr/r/}r/(hEUhFj/ubahIjubh^X% of the MIME multipart/mixed message.r/r/}r/(hEX% of the MIME multipart/mixed message.hFj/ubehIhfubahIjubj)r/}r/(hEUhK}r/(hM]hN]hO]hP]hR]uhFjA/h@]r/hb)r/}r/(hEXserialVersion (unsigned long) -- The serialVersion of the system metadata. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/(j)r/}r/(hEX serialVersionhK}r/(hP]hO]jhM]hN]hR]uhFj/h@]r/h^X serialVersionr/r/}r/(hEUhFj/ubahIjubh^X (r/r/}r/(hEUhFj/ubj)r/}r/(hEUhK}r/(UreftypejjU reftargetX unsigned longr/U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj/h@]r/j)r/}r/(hEj/hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/h^X unsigned longr/r/}r/(hEUhFj/ubahIjubahIjubh^X)r/}r/(hEUhFj/ubh^X -- r/r/}r/(hEUhFj/ubh^XMThe serialVersion of the system metadata. Transmitted as a UTF-8 String as a r/r/}r/(hEXMThe serialVersion of the system metadata. Transmitted as a UTF-8 String as a hFj/ubj)r/}r/(hEX *Param part*hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/h^X Param partr/r/}r/(hEUhFj/ubahIjubh^X% of the MIME multipart/mixed message.r/r/}r/(hEX% of the MIME multipart/mixed message.hFj/ubehIhfubahIjubj)r/}r/(hEUhK}r/(hM]hN]hO]hP]hR]uhFjA/h@]r/hb)r/}r/(hEXdateSysMetaLastModified (Types.DateTime) -- The time stamp for when the system metadata was changed. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hK}r/(hM]hN]hO]hP]hR]uhFj/h@]r/(j)r/}r/(hEXdateSysMetaLastModifiedhK}r/(hP]hO]jhM]hN]hR]uhFj/h@]r/h^XdateSysMetaLastModifiedr/r/}r/(hEUhFj/ubahIjubh^X (r/r/}r/(hEUhFj/ubj)r/}r/(hEX:class:`Types.DateTime`r/hFj/hGjhIjhK}r/(UreftypeXclassjjXTypes.DateTimeU refdomainXpyr/hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMMh@]r/j)r/}r/(hEj/hK}r/(hM]hN]r/(jj/Xpy-classr/ehO]hP]hR]uhFj/h@]r0h^XTypes.DateTimer0r0}r0(hEUhFj/ubahIjubaubh^X)r0}r0(hEUhFj/ubh^X -- r0r0}r0(hEUhFj/ubh^X\The time stamp for when the system metadata was changed. Transmitted as a UTF-8 String as a r 0r 0}r 0(hEX\The time stamp for when the system metadata was changed. Transmitted as a UTF-8 String as a hFj/ubj)r 0}r 0(hEX *Param part*hK}r0(hM]hN]hO]hP]hR]uhFj/h@]r0h^X Param partr0r0}r0(hEUhFj 0ubahIjubh^X% of the MIME multipart/mixed message.r0r0}r0(hEX% of the MIME multipart/mixed message.hFj/ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r0}r0(hEUhK}r0(hM]hN]hO]hP]hR]uhFj.h@]r0(h)r0}r0(hEXReturnshFj0hGjhIhhK}r0(hM]hN]hO]hP]hR]uhTKh@]r0h^XReturnsr0r0}r 0(hEUhFj0ubaubh)r!0}r"0(hEUhK}r#0(hM]hN]hO]hP]hR]uhFj0h@]r$0hb)r%0}r&0(hEXETrue if notification was received OK, otherwise an error is returned.hK}r'0(hM]hN]hO]hP]hR]uhFj!0h@]r(0h^XETrue if notification was received OK, otherwise an error is returned.r)0r*0}r+0(hEXETrue if notification was received OK, otherwise an error is returned.hFj%0ubahIhfubahIhubehIh}ubhz)r,0}r-0(hEUhK}r.0(hM]hN]hO]hP]hR]uhFj.h@]r/0(h)r00}r10(hEX Return typehFj,0hGjhIhhK}r20(hM]hN]hO]hP]hR]uhTKh@]r30h^X Return typer40r50}r60(hEUhFj00ubaubh)r70}r80(hEUhK}r90(hM]hN]hO]hP]hR]uhFj,0h@]r:0hb)r;0}r<0(hEXbooleanhK}r=0(hM]hN]hO]hP]hR]uhFj70h@]r>0j)r?0}r@0(hEUhK}rA0(UreftypejjU reftargetXbooleanU refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj;0h@]rB0h^XbooleanrC0rD0}rE0(hEUhFj?0ubahIjubahIhfubahIhubehIh}ubhz)rF0}rG0(hEUhK}rH0(hM]hN]hO]hP]hR]uhFj.h@]rI0(h)rJ0}rK0(hEXRaiseshFjF0hGjhIhhK}rL0(hM]hN]hO]hP]hR]uhTKh@]rM0h^XRaisesrN0rO0}rP0(hEUhFjJ0ubaubh)rQ0}rR0(hEUhK}rS0(hM]hN]hO]hP]hR]uhFjF0h@]rT0j)rU0}rV0(hEUhK}rW0(hM]hN]hO]hP]hR]uhFjQ0h@]rX0(j)rY0}rZ0(hEUhK}r[0(hM]hN]hO]hP]hR]uhFjU0h@]r\0hb)r]0}r^0(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1330)hK}r_0(hM]hN]hO]hP]hR]uhFjY0h@]r`0(j)ra0}rb0(hEUhK}rc0(UreftypejjU reftargetXExceptions.NotImplementedrd0U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj]0h@]re0j)rf0}rg0(hEjd0hK}rh0(hM]hN]hO]hP]hR]uhFja0h@]ri0h^XExceptions.NotImplementedrj0rk0}rl0(hEUhFjf0ubahIjubahIjubh^X -- rm0rn0}ro0(hEUhFj]0ubj)rp0}rq0(hEX$``(errorCode=501, detailCode=1330)``hK}rr0(hM]hN]hO]hP]hR]uhFj]0h@]rs0h^X (errorCode=501, detailCode=1330)rt0ru0}rv0(hEUhFjp0ubahIjubehIhfubahIjubj)rw0}rx0(hEUhK}ry0(hM]hN]hO]hP]hR]uhFjU0h@]rz0hb)r{0}r|0(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1331)hK}r}0(hM]hN]hO]hP]hR]uhFjw0h@]r~0(j)r0}r0(hEUhK}r0(UreftypejjU reftargetXExceptions.NotAuthorizedr0U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj{0h@]r0j)r0}r0(hEj0hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^XExceptions.NotAuthorizedr0r0}r0(hEUhFj0ubahIjubahIjubh^X -- r0r0}r0(hEUhFj{0ubj)r0}r0(hEX$``(errorCode=401, detailCode=1331)``hK}r0(hM]hN]hO]hP]hR]uhFj{0h@]r0h^X (errorCode=401, detailCode=1331)r0r0}r0(hEUhFj0ubahIjubehIhfubahIjubj)r0}r0(hEUhK}r0(hM]hN]hO]hP]hR]uhFjU0h@]r0hb)r0}r0(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1332)hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0(j)r0}r0(hEUhK}r0(UreftypejjU reftargetXExceptions.InvalidTokenr0U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj0h@]r0j)r0}r0(hEj0hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^XExceptions.InvalidTokenr0r0}r0(hEUhFj0ubahIjubahIjubh^X -- r0r0}r0(hEUhFj0ubj)r0}r0(hEX$``(errorCode=401, detailCode=1332)``hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^X (errorCode=401, detailCode=1332)r0r0}r0(hEUhFj0ubahIjubehIhfubahIjubj)r0}r0(hEUhK}r0(hM]hN]hO]hP]hR]uhFjU0h@]r0hb)r0}r0(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1333)hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0(j)r0}r0(hEUhK}r0(UreftypejjU reftargetXExceptions.ServiceFailurer0U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj0h@]r0j)r0}r0(hEj0hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^XExceptions.ServiceFailurer0r0}r0(hEUhFj0ubahIjubahIjubh^X -- r0r0}r0(hEUhFj0ubj)r0}r0(hEX$``(errorCode=500, detailCode=1333)``hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^X (errorCode=500, detailCode=1333)r0r0}r0(hEUhFj0ubahIjubehIhfubahIjubj)r0}r0(hEUhK}r0(hM]hN]hO]hP]hR]uhFjU0h@]r0hb)r0}r0(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1334)hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0(j)r0}r0(hEUhK}r0(UreftypejjU reftargetXExceptions.InvalidRequestr0U refdomainj.hP]hO]U refexplicithM]hN]hR]uhFj0h@]r0j)r0}r0(hEj0hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^XExceptions.InvalidRequestr0r0}r0(hEUhFj0ubahIjubahIjubh^X -- r0r0}r0(hEUhFj0ubj)r0}r0(hEX$``(errorCode=400, detailCode=1334)``hK}r0(hM]hN]hO]hP]hR]uhFj0h@]r0h^X (errorCode=400, detailCode=1334)r0r0}r0(hEUhFj0ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r0}r0(hEUhFjhGNhIjhK}r0(hP]hO]hM]hN]hR]Uentries]r0(jXgetReplica() (in module MNRead)hUNtr0auhTNhUhh@]ubj)r0}r0(hEUhFjhGNhIjhK}r0(jjXpyr0hP]hO]hM]hN]hR]jXfunctionr0jj0uhTNhUhh@]r0(j)r0}r0(hEX&getReplica(session,pid) -> OctetStreamhFj0hGXAinternal padding after source/apis/generated/generated_MNRead.txtr0hIjhK}r0(hP]r0hajjhO]hM]hN]hR]r0hajX getReplicar1jUjuhTMhUhh@]r1(j)r1}r1(hEXMNRead.hFj0hGj0hIjhK}r1(hM]hN]hO]hP]hR]uhTMhUhh@]r1h^XMNRead.r1r1}r1(hEUhFj1ubaubj)r 1}r 1(hEj1hFj0hGj0hIjhK}r 1(hM]hN]hO]hP]hR]uhTMhUhh@]r 1h^X getReplicar 1r1}r1(hEUhFj 1ubaubj)r1}r1(hEX session, pidhFj0hGj0hIjhK}r1(hM]hN]hO]hP]hR]uhTMhUhh@]r1(j)r1}r1(hEXsessionhK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1h^Xsessionr1r1}r1(hEUhFj1ubahIjubj)r1}r1(hEXpidhK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1h^Xpidr1r 1}r!1(hEUhFj1ubahIjubeubj)r"1}r#1(hEX OctetStreamhFj0hGj0hIjhK}r$1(hM]hN]hO]hP]hR]uhTMhUhh@]r%1h^X OctetStreamr&1r'1}r(1(hEUhFj"1ubaubeubj)r)1}r*1(hEUhFj0hGj0hIj hK}r+1(hM]hN]hO]hP]hR]uhTMhUhh@]r,1(hb)r-1}r.1(hEXHCalled by a target Member Node to fullfill the replication request originated by a Coordinating Node calling :func:`MNReplication.replicate`. This is a request to make a replica copy of the object, and differs from a call to GET /object in that it should be logged as a replication event rather than a read event on that object.hFj)1hGjhIhfhK}r/1(hM]hN]hO]hP]hR]uhTMahUhh@]r01(h^XmCalled by a target Member Node to fullfill the replication request originated by a Coordinating Node calling r11r21}r31(hEXmCalled by a target Member Node to fullfill the replication request originated by a Coordinating Node calling hFj-1ubj)r41}r51(hEX:func:`MNReplication.replicate`r61hFj-1hGjhIjhK}r71(UreftypeXfuncjjXMNReplication.replicateU refdomainXpyr81hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMah@]r91j)r:1}r;1(hEj61hK}r<1(hM]hN]r=1(jj81Xpy-funcr>1ehO]hP]hR]uhFj41h@]r?1h^XMNReplication.replicate()r@1rA1}rB1(hEUhFj:1ubahIjubaubh^X. This is a request to make a replica copy of the object, and differs from a call to GET /object in that it should be logged as a replication event rather than a read event on that object.rC1rD1}rE1(hEX. This is a request to make a replica copy of the object, and differs from a call to GET /object in that it should be logged as a replication event rather than a read event on that object.hFj-1ubeubhb)rF1}rG1(hEXIf the object being retrieved is restricted access, then a Tier 2 or higher Member Node MUST make a call to :func:`CNReplication.isNodeAuthorized` to verify that the Subject of the caller is authorized to retrieve the content.hFj)1hGjhIhfhK}rH1(hM]hN]hO]hP]hR]uhTMchUhh@]rI1(h^XlIf the object being retrieved is restricted access, then a Tier 2 or higher Member Node MUST make a call to rJ1rK1}rL1(hEXlIf the object being retrieved is restricted access, then a Tier 2 or higher Member Node MUST make a call to hFjF1ubj)rM1}rN1(hEX&:func:`CNReplication.isNodeAuthorized`rO1hFjF1hGjhIjhK}rP1(UreftypeXfuncjjXCNReplication.isNodeAuthorizedU refdomainXpyrQ1hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMch@]rR1j)rS1}rT1(hEjO1hK}rU1(hM]hN]rV1(jjQ1Xpy-funcrW1ehO]hP]hR]uhFjM1h@]rX1h^X CNReplication.isNodeAuthorized()rY1rZ1}r[1(hEUhFjS1ubahIjubaubh^XP to verify that the Subject of the caller is authorized to retrieve the content.r\1r]1}r^1(hEXP to verify that the Subject of the caller is authorized to retrieve the content.hFjF1ubeubhb)r_1}r`1(hEXLA successful operation is indicated by a HTTP status of 200 on the response.ra1hFj)1hGjhIhfhK}rb1(hM]hN]hO]hP]hR]uhTMehUhh@]rc1h^XLA successful operation is indicated by a HTTP status of 200 on the response.rd1re1}rf1(hEja1hFj_1ubaubhb)rg1}rh1(hEXQFailure of the operation MUST be indicated by returning an appropriate exception.ri1hFj)1hGjhIhfhK}rj1(hM]hN]hO]hP]hR]uhTMghUhh@]rk1h^XQFailure of the operation MUST be indicated by returning an appropriate exception.rl1rm1}rn1(hEji1hFjg1ubaubht)ro1}rp1(hEUhFj)1hGNhIhwhK}rq1(hM]hN]hO]hP]hR]uhTNhUhh@]rr1(hz)rs1}rt1(hEUhFjo1hGjhIh}hK}ru1(hM]hN]hO]hP]hR]uhTMihUhh@]rv1(h)rw1}rx1(hEXVersionhFjs1hGjhIhhK}ry1(hM]hN]hO]hP]hR]uhTKh@]rz1h^XVersionr{1r|1}r}1(hEUhFjw1ubaubh)r~1}r1(hEX1.0r1hK}r1(hM]hN]hO]hP]hR]uhFjs1h@]r1hb)r1}r1(hEj1hFj~1hGjhIhfhK}r1(hM]hN]hO]hP]hR]uhTMih@]r1h^X1.0r1r1}r1(hEj1hFj1ubaubahIhubeubhz)r1}r1(hEUhFjo1hGjhIh}hK}r1(hM]hN]hO]hP]hR]uhTMjhUhh@]r1(h)r1}r1(hEX Use CaseshFj1hGjhIhhK}r1(hM]hN]hO]hP]hR]uhTKh@]r1h^X Use Casesr1r1}r1(hEUhFj1ubaubh)r1}r1(hEX$:doc:`UC09 `r1hK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1hb)r1}r1(hEj1hFj1hGjhIhfhK}r1(hM]hN]hO]hP]hR]uhTMkh@]r1j)r1}r1(hEj1hFj1hGjhIjhK}r1(UreftypeXdocr1jjX/design/UseCases/09_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTMkh@]r1jr)r1}r1(hEj1hK}r1(hM]hN]r1(jj1ehO]hP]hR]uhFj1h@]r1h^XUC09r1r1}r1(hEUhFj1ubahIj{ubaubaubahIhubeubhz)r1}r1(hEUhFjo1hGjhIh}hK}r1(hM]hN]hO]hP]hR]uhTMlhUhh@]r1(h)r1}r1(hEXREST URLhFj1hGjhIhhK}r1(hM]hN]hO]hP]hR]uhTKh@]r1h^XREST URLr1r1}r1(hEUhFj1ubaubh)r1}r1(hEX``GET /replica/{pid}``r1hK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1hb)r1}r1(hEj1hFj1hGjhIhfhK}r1(hM]hN]hO]hP]hR]uhTMlh@]r1j)r1}r1(hEj1hK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1h^XGET /replica/{pid}r1r1}r1(hEUhFj1ubahIjubaubahIhubeubhz)r1}r1(hEUhK}r1(hM]hN]hO]hP]hR]uhFjo1h@]r1(h)r1}r1(hEX ParametershFj1hGj0hIhhK}r1(hM]hN]hO]hP]hR]uhTKh@]r1h^X Parametersr1r1}r1(hEUhFj1ubaubh)r1}r1(hEUhK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1j)r1}r1(hEUhK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1(j)r1}r1(hEUhK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1hb)r1}r1(hEXTsession (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.hK}r1(hM]hN]hO]hP]hR]uhFj1h@]r1(j)r1}r1(hEXsessionhK}r1(hP]hO]jhM]hN]hR]uhFj1h@]r1h^Xsessionr1r1}r1(hEUhFj1ubahIjubh^X (r1r1}r1(hEUhFj1ubj)r1}r1(hEX:class:`Types.Session`r1hFj1hGjhIjhK}r1(UreftypeXclassjjX Types.SessionU refdomainXpyr1hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMnh@]r1j)r1}r1(hEj1hK}r1(hM]hN]r1(jj1Xpy-classr1ehO]hP]hR]uhFj1h@]r1h^X Types.Sessionr1r1}r1(hEUhFj1ubahIjubaubh^X)r1}r1(hEUhFj1ubh^X -- r1r1}r1(hEUhFj1ubh^XSession 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 r1r2}r2(hEXSession 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 hFj1ubj)r2}r2(hEX:term:`public user`r2hFj1hGjhIjhK}r2(UreftypeXtermjjX public userU refdomainXstdr2hP]hO]U refexplicithM]hN]hR]jjuhTMmh@]r2jr)r2}r 2(hEj2hK}r 2(hM]hN]r 2(jj2Xstd-termr 2ehO]hP]hR]uhFj2h@]r 2h^X public userr2r2}r2(hEUhFj2ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r2r2}r2(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj1ubehIhfubahIjubj)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj1h@]r2hb)r2}r2(hEXpid (Types.Identifier) -- The identifier of the object to get as a replica Transmitted as part of the URL path and must be escaped accordingly.hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEXpidhK}r2(hP]hO]jhM]hN]hR]uhFj2h@]r2h^Xpidr 2r!2}r"2(hEUhFj2ubahIjubh^X (r#2r$2}r%2(hEUhFj2ubj)r&2}r'2(hEX:class:`Types.Identifier`r(2hFj2hGjhIjhK}r)2(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr*2hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMqh@]r+2j)r,2}r-2(hEj(2hK}r.2(hM]hN]r/2(jj*2Xpy-classr02ehO]hP]hR]uhFj&2h@]r12h^XTypes.Identifierr22r32}r42(hEUhFj,2ubahIjubaubh^X)r52}r62(hEUhFj2ubh^X -- r72r82}r92(hEUhFj2ubh^XuThe identifier of the object to get as a replica Transmitted as part of the URL path and must be escaped accordingly.r:2r;2}r<2(hEXuThe identifier of the object to get as a replica Transmitted as part of the URL path and must be escaped accordingly.hFj2ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r=2}r>2(hEUhK}r?2(hM]hN]hO]hP]hR]uhFjo1h@]r@2(h)rA2}rB2(hEXReturnshFj=2hGj0hIhhK}rC2(hM]hN]hO]hP]hR]uhTKh@]rD2h^XReturnsrE2rF2}rG2(hEUhFjA2ubaubh)rH2}rI2(hEUhK}rJ2(hM]hN]hO]hP]hR]uhFj=2h@]rK2hb)rL2}rM2(hEXBytes of the specified object.hK}rN2(hM]hN]hO]hP]hR]uhFjH2h@]rO2h^XBytes of the specified object.rP2rQ2}rR2(hEXBytes of the specified object.hFjL2ubahIhfubahIhubehIh}ubhz)rS2}rT2(hEUhK}rU2(hM]hN]hO]hP]hR]uhFjo1h@]rV2(h)rW2}rX2(hEX Return typehFjS2hGj0hIhhK}rY2(hM]hN]hO]hP]hR]uhTKh@]rZ2h^X Return typer[2r\2}r]2(hEUhFjW2ubaubh)r^2}r_2(hEUhK}r`2(hM]hN]hO]hP]hR]uhFjS2h@]ra2hb)rb2}rc2(hEXTypes.OctetStreamhK}rd2(hM]hN]hO]hP]hR]uhFj^2h@]re2j)rf2}rg2(hEX:class:`Types.OctetStream`rh2hFjb2hGjhIjhK}ri2(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrj2hP]hO]U refexplicithM]hN]hR]jjjNjjuhTMth@]rk2j)rl2}rm2(hEjh2hK}rn2(hM]hN]ro2(jjj2Xpy-classrp2ehO]hP]hR]uhFjf2h@]rq2h^XTypes.OctetStreamrr2rs2}rt2(hEUhFjl2ubahIjubaubahIhfubahIhubehIh}ubhz)ru2}rv2(hEUhK}rw2(hM]hN]hO]hP]hR]uhFjo1h@]rx2(h)ry2}rz2(hEXRaiseshFju2hGj0hIhhK}r{2(hM]hN]hO]hP]hR]uhTKh@]r|2h^XRaisesr}2r~2}r2(hEUhFjy2ubaubh)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFju2h@]r2j)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2hb)r2}r2(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2180)hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEUhK}r2(UreftypejjU reftargetXExceptions.NotImplementedr2U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj2h@]r2j)r2}r2(hEj2hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^XExceptions.NotImplementedr2r2}r2(hEUhFj2ubahIjubahIjubh^X -- r2r2}r2(hEUhFj2ubj)r2}r2(hEX$``(errorCode=501, detailCode=2180)``hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^X (errorCode=501, detailCode=2180)r2r2}r2(hEUhFj2ubahIjubehIhfubahIjubj)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2hb)r2}r2(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2181)hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEUhK}r2(UreftypejjU reftargetXExceptions.ServiceFailurer2U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj2h@]r2j)r2}r2(hEj2hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^XExceptions.ServiceFailurer2r2}r2(hEUhFj2ubahIjubahIjubh^X -- r2r2}r2(hEUhFj2ubj)r2}r2(hEX$``(errorCode=500, detailCode=2181)``hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^X (errorCode=500, detailCode=2181)r2r2}r2(hEUhFj2ubahIjubehIhfubahIjubj)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2hb)r2}r2(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2182)hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEUhK}r2(UreftypejjU reftargetXExceptions.NotAuthorizedr2U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj2h@]r2j)r2}r2(hEj2hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^XExceptions.NotAuthorizedr2r2}r2(hEUhFj2ubahIjubahIjubh^X -- r2r2}r2(hEUhFj2ubj)r2}r2(hEX$``(errorCode=401, detailCode=2182)``hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^X (errorCode=401, detailCode=2182)r2r2}r2(hEUhFj2ubahIjubehIhfubahIjubj)r2}r2(hEUhK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2hb)r2}r2(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2183)hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2(j)r2}r2(hEUhK}r2(UreftypejjU reftargetXExceptions.InvalidTokenr2U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj2h@]r2j)r2}r2(hEj2hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^XExceptions.InvalidTokenr2r2}r2(hEUhFj2ubahIjubahIjubh^X -- r2r2}r2(hEUhFj2ubj)r2}r2(hEX$``(errorCode=401, detailCode=2183)``hK}r2(hM]hN]hO]hP]hR]uhFj2h@]r2h^X (errorCode=401, detailCode=2183)r2r2}r2(hEUhFj2ubahIjubehIhfubahIjubj)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj2h@]r3hb)r3}r3(hEXExceptions.InsufficientResources -- (errorCode=413, detailCode=2184)The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.hK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3(j)r3}r 3(hEUhK}r 3(UreftypejjU reftargetX Exceptions.InsufficientResourcesr 3U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj3h@]r 3j)r 3}r3(hEj 3hK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3h^X Exceptions.InsufficientResourcesr3r3}r3(hEUhFj 3ubahIjubahIjubh^X -- r3r3}r3(hEUhFj3ubhb)r3}r3(hEX$``(errorCode=413, detailCode=2184)``r3hFj3hGjhIhfhK}r3(hM]hN]hO]hP]hR]uhTM~h@]r3j)r3}r3(hEj3hK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3h^X (errorCode=413, detailCode=2184)r 3r!3}r"3(hEUhFj3ubahIjubaubhb)r#3}r$3(hEX~The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.r%3hFj3hGjhIhfhK}r&3(hM]hN]hO]hP]hR]uhTMh@]r'3h^X~The node is unable to service the request due to insufficient resources such as CPU, memory, or bandwidth being over utilized.r(3r)3}r*3(hEj%3hFj#3ubaubehIhfubahIjubj)r+3}r,3(hEUhK}r-3(hM]hN]hO]hP]hR]uhFj2h@]r.3hb)r/3}r03(hEX7Exceptions.NotFound -- (errorCode=404, detailCode=2185)hK}r13(hM]hN]hO]hP]hR]uhFj+3h@]r23(j)r33}r43(hEUhK}r53(UreftypejjU reftargetXExceptions.NotFoundr63U refdomainj0hP]hO]U refexplicithM]hN]hR]uhFj/3h@]r73j)r83}r93(hEj63hK}r:3(hM]hN]hO]hP]hR]uhFj33h@]r;3h^XExceptions.NotFoundr<3r=3}r>3(hEUhFj83ubahIjubahIjubh^X -- r?3r@3}rA3(hEUhFj/3ubj)rB3}rC3(hEX$``(errorCode=404, detailCode=2185)``hK}rD3(hM]hN]hO]hP]hR]uhFj/3h@]rE3h^X (errorCode=404, detailCode=2185)rF3rG3}rH3(hEUhFjB3ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubeubhB)rI3}rJ3(hEUhFhChGhHhIhJhK}rK3(hM]hN]hO]hP]rL3(Xmodule-MNQueryrM3h;ehR]rN3hauhTKphUhh@]rO3(hW)rP3}rQ3(hEX Query APIrR3hFjI3hGhHhIh[hK}rS3(hM]hN]hO]hP]hR]uhTKphUhh@]rT3h^X Query APIrU3rV3}rW3(hEjR3hFjP3ubaubj)rX3}rY3(hEUhFjI3hGhHhIjhK}rZ3(hP]hO]hM]hN]hR]Uentries]r[3(jXMNQuery (module)Xmodule-MNQueryUNtr\3auhTNhUhh@]ubhb)r]3}r^3(hEXThe *MNQuery* API is an optional API that may be implemented by Member Nodes that intend to support querying the local repository. The actual form of the query is undefined, and t is expected that a small set of well known query engine types will be supported.hFjI3hGhHhIhfhK}r_3(hM]hN]hO]hP]hR]uhTKuhUhh@]r`3(h^XThe ra3rb3}rc3(hEXThe hFj]3ubj)rd3}re3(hEX *MNQuery*hK}rf3(hM]hN]hO]hP]hR]uhFj]3h@]rg3h^XMNQueryrh3ri3}rj3(hEUhFjd3ubahIjubh^X API is an optional API that may be implemented by Member Nodes that intend to support querying the local repository. The actual form of the query is undefined, and t is expected that a small set of well known query engine types will be supported.rk3rl3}rm3(hEX API is an optional API that may be implemented by Member Nodes that intend to support querying the local repository. The actual form of the query is undefined, and t is expected that a small set of well known query engine types will be supported.hFj]3ubeubh)rn3}ro3(hEXBWarning: this file is automatically generated. Edits will be losthFjI3hGjX+source/apis/generated/generated_MNQuery.txtrp3rq3}rr3bhIhhK}rs3(hhhP]hO]hM]hN]hR]uhTKhUhh@]rt3h^XBWarning: this file is automatically generated. Edits will be lostru3rv3}rw3(hEUhFjn3ubaubj)rx3}ry3(hEUhFjI3hGNhIjhK}rz3(hM]hN]hO]hP]r{3Uid4r|3ahR]uhTNhUhh@]r}3(hW)r~3}r3(hEX#Functions defined in :mod:`MNQuery`hK}r3(hM]hN]hO]hP]hR]uhFjx3h@]r3(h^XFunctions defined in r3r3}r3(hEXFunctions defined in hFj~3ubj)r3}r3(hEX:mod:`MNQuery`r3hFj~3hGjq3hIjhK}r3(UreftypeXmodjjXMNQueryU refdomainXpyr3hP]hO]U refexplicithM]hN]hR]jjjNjXMNQueryr3uhTKh@]r3j)r3}r3(hEj3hK}r3(hM]hN]r3(jj3Xpy-modr3ehO]hP]hR]uhFj3h@]r3h^XMNQueryr3r3}r3(hEUhFj3ubahIjubaubehIh[ubj)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolsKuhFjx3h@]r3(j#)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthKuhFj3h@]hIj'ubj#)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthKuhFj3h@]hIj'ubj#)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthK uhFj3h@]hIj'ubj#)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthK uhFj3h@]hIj'ubj#)r3}r3(hEUhK}r3(hP]hO]hM]hN]hR]UcolwidthKuhFj3h@]hIj'ubj4)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3j9)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3(j>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEXTierr3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTK h@]r3h^XTierr3r3}r3(hEj3hFj3ubaubahIjKubj>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEXVersionr3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTK h@]r3h^XVersionr3r3}r3(hEj3hFj3ubaubahIjKubj>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEXRESTr3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTK h@]r3h^XRESTr3r3}r3(hEj3hFj3ubaubahIjKubj>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEXFunctionr3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTK h@]r3h^XFunctionr3r3}r3(hEj3hFj3ubaubahIjKubj>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEX Parametersr3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTK h@]r3h^X Parametersr3r3}r3(hEj3hFj3ubaubahIjKubehIj|ubahIj}ubj~)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3(j9)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3(j>)r3}r3(hEUhK}r3(hM]hN]hO]hP]hR]uhFj3h@]r3hb)r3}r3(hEXTier 1r3hFj3hGjq3hIhfhK}r3(hM]hN]hO]hP]hR]uhTKh@]r3h^XTier 1r3r3}r3(hEj3hFj3ubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj3h@]r4hb)r4}r4(hEX1.1r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4h^X1.1r 4r 4}r 4(hEj4hFj4ubaubahIjKubj>)r 4}r 4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj3h@]r4hb)r4}r4(hEX$``GET /query/{queryEngine}/{query}``r4hFj 4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4j)r4}r4(hEj4hK}r4(hM]hN]hO]hP]hR]uhFj4h@]r4h^X GET /query/{queryEngine}/{query}r4r4}r4(hEUhFj4ubahIjubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj3h@]r4hb)r 4}r!4(hEX :func:`query`r"4hFj4hGjq3hIhfhK}r#4(hM]hN]hO]hP]hR]uhTKh@]r$4j)r%4}r&4(hEj"4hFj 4hGjq3hIjhK}r'4(UreftypeXfuncjjXqueryU refdomainXpyr(4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]r)4j)r*4}r+4(hEj"4hK}r,4(hM]hN]r-4(jj(4Xpy-funcr.4ehO]hP]hR]uhFj%4h@]r/4h^Xquery()r04r14}r24(hEUhFj*4ubahIjubaubaubahIjKubj>)r34}r44(hEUhK}r54(hM]hN]hO]hP]hR]uhFj3h@]r64hb)r74}r84(hEX_(:class:`session`, ``queryEngine``, ``query``) ``->`` :class:`Types.OctetStream`r94hFj34hGjq3hIhfhK}r:4(hM]hN]hO]hP]hR]uhTKh@]r;4(h^X(r<4}r=4(hEX(hFj74ubj)r>4}r?4(hEX:class:`session`r@4hFj74hGjq3hIjhK}rA4(UreftypeXclassjjX Types.SessionU refdomainXpyrB4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]rC4j)rD4}rE4(hEj@4hK}rF4(hM]hN]rG4(jjB4Xpy-classrH4ehO]hP]hR]uhFj>4h@]rI4h^XsessionrJ4rK4}rL4(hEUhFjD4ubahIjubaubh^X, rM4rN4}rO4(hEX, hFj74ubj)rP4}rQ4(hEX``queryEngine``hK}rR4(hM]hN]hO]hP]hR]uhFj74h@]rS4h^X queryEnginerT4rU4}rV4(hEUhFjP4ubahIjubh^X, rW4rX4}rY4(hEX, hFj74ubj)rZ4}r[4(hEX ``query``hK}r\4(hM]hN]hO]hP]hR]uhFj74h@]r]4h^Xqueryr^4r_4}r`4(hEUhFjZ4ubahIjubh^X) ra4rb4}rc4(hEX) hFj74ubj)rd4}re4(hEX``->``hK}rf4(hM]hN]hO]hP]hR]uhFj74h@]rg4h^X->rh4ri4}rj4(hEUhFjd4ubahIjubh^X rk4}rl4(hEX hFj74ubj)rm4}rn4(hEX:class:`Types.OctetStream`ro4hFj74hGjq3hIjhK}rp4(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrq4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]rr4j)rs4}rt4(hEjo4hK}ru4(hM]hN]rv4(jjq4Xpy-classrw4ehO]hP]hR]uhFjm4h@]rx4h^XTypes.OctetStreamry4rz4}r{4(hEUhFjs4ubahIjubaubeubahIjKubehIj|ubj9)r|4}r}4(hEUhK}r~4(hM]hN]hO]hP]hR]uhFj3h@]r4(j>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj|4h@]r4hb)r4}r4(hEXTier 1r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4h^XTier 1r4r4}r4(hEj4hFj4ubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj|4h@]r4hb)r4}r4(hEX1.1r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4h^X1.1r4r4}r4(hEj4hFj4ubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj|4h@]r4hb)r4}r4(hEX``GET /query/{queryType}``r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4j)r4}r4(hEj4hK}r4(hM]hN]hO]hP]hR]uhFj4h@]r4h^XGET /query/{queryType}r4r4}r4(hEUhFj4ubahIjubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj|4h@]r4hb)r4}r4(hEX!:func:`getQueryEngineDescription`r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4j)r4}r4(hEj4hFj4hGjq3hIjhK}r4(UreftypeXfuncjjXgetQueryEngineDescriptionU refdomainXpyr4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]r4j)r4}r4(hEj4hK}r4(hM]hN]r4(jj4Xpy-funcr4ehO]hP]hR]uhFj4h@]r4h^XgetQueryEngineDescription()r4r4}r4(hEUhFj4ubahIjubaubaubahIjKubj>)r4}r4(hEUhK}r4(hM]hN]hO]hP]hR]uhFj|4h@]r4hb)r4}r4(hEX_(:class:`session`, ``queryEngine``) ``->`` :class:`Types.QueryEngineDescription`r4hFj4hGjq3hIhfhK}r4(hM]hN]hO]hP]hR]uhTKh@]r4(h^X(r4}r4(hEX(hFj4ubj)r4}r4(hEX:class:`session`r4hFj4hGjq3hIjhK}r4(UreftypeXclassjjX Types.SessionU refdomainXpyr4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]r4j)r4}r4(hEj4hK}r4(hM]hN]r4(jj4Xpy-classr4ehO]hP]hR]uhFj4h@]r4h^Xsessionr4r4}r4(hEUhFj4ubahIjubaubh^X, r4r4}r4(hEX, hFj4ubj)r4}r4(hEX``queryEngine``hK}r4(hM]hN]hO]hP]hR]uhFj4h@]r4h^X queryEnginer4r4}r4(hEUhFj4ubahIjubh^X) r4r4}r4(hEX) hFj4ubj)r4}r4(hEX``->``hK}r4(hM]hN]hO]hP]hR]uhFj4h@]r4h^X->r4r4}r4(hEUhFj4ubahIjubh^X r4}r4(hEX hFj4ubj)r4}r4(hEX%:class:`Types.QueryEngineDescription`r4hFj4hGjq3hIjhK}r4(UreftypeXclassjjXTypes.QueryEngineDescriptionU refdomainXpyr4hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]r4j)r4}r4(hEj4hK}r4(hM]hN]r4(jj4Xpy-classr4ehO]hP]hR]uhFj4h@]r4h^XTypes.QueryEngineDescriptionr4r4}r4(hEUhFj4ubahIjubaubeubahIjKubehIj|ubj9)r4}r4(hEUhK}r5(hM]hN]hO]hP]hR]uhFj3h@]r5(j>)r5}r5(hEUhK}r5(hM]hN]hO]hP]hR]uhFj4h@]r5hb)r5}r5(hEXTier 1r5hFj5hGjq3hIhfhK}r 5(hM]hN]hO]hP]hR]uhTKh@]r 5h^XTier 1r 5r 5}r 5(hEj5hFj5ubaubahIjKubj>)r5}r5(hEUhK}r5(hM]hN]hO]hP]hR]uhFj4h@]r5hb)r5}r5(hEX1.1r5hFj5hGjq3hIhfhK}r5(hM]hN]hO]hP]hR]uhTKh@]r5h^X1.1r5r5}r5(hEj5hFj5ubaubahIjKubj>)r5}r5(hEUhK}r5(hM]hN]hO]hP]hR]uhFj4h@]r5hb)r5}r5(hEX``GET /query``r 5hFj5hGjq3hIhfhK}r!5(hM]hN]hO]hP]hR]uhTKh@]r"5j)r#5}r$5(hEj 5hK}r%5(hM]hN]hO]hP]hR]uhFj5h@]r&5h^X GET /queryr'5r(5}r)5(hEUhFj#5ubahIjubaubahIjKubj>)r*5}r+5(hEUhK}r,5(hM]hN]hO]hP]hR]uhFj4h@]r-5hb)r.5}r/5(hEX:func:`listQueryEngines`r05hFj*5hGjq3hIhfhK}r15(hM]hN]hO]hP]hR]uhTKh@]r25j)r35}r45(hEj05hFj.5hGjq3hIjhK}r55(UreftypeXfuncjjXlistQueryEnginesU refdomainXpyr65hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]r75j)r85}r95(hEj05hK}r:5(hM]hN]r;5(jj65Xpy-funcr<5ehO]hP]hR]uhFj35h@]r=5h^XlistQueryEngines()r>5r?5}r@5(hEUhFj85ubahIjubaubaubahIjKubj>)rA5}rB5(hEUhK}rC5(hM]hN]hO]hP]hR]uhFj4h@]rD5hb)rE5}rF5(hEXG(:class:`session`) ``->`` :class:`Types.QueryEngineList`rG5hFjA5hGjq3hIhfhK}rH5(hM]hN]hO]hP]hR]uhTKh@]rI5(h^X(rJ5}rK5(hEX(hFjE5ubj)rL5}rM5(hEX:class:`session`rN5hFjE5hGjq3hIjhK}rO5(UreftypeXclassjjX Types.SessionU refdomainXpyrP5hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]rQ5j)rR5}rS5(hEjN5hK}rT5(hM]hN]rU5(jjP5Xpy-classrV5ehO]hP]hR]uhFjL5h@]rW5h^XsessionrX5rY5}rZ5(hEUhFjR5ubahIjubaubh^X) r[5r\5}r]5(hEX) hFjE5ubj)r^5}r_5(hEX``->``hK}r`5(hM]hN]hO]hP]hR]uhFjE5h@]ra5h^X->rb5rc5}rd5(hEUhFj^5ubahIjubh^X re5}rf5(hEX hFjE5ubj)rg5}rh5(hEX:class:`Types.QueryEngineList`ri5hFjE5hGjq3hIjhK}rj5(UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyrk5hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKh@]rl5j)rm5}rn5(hEji5hK}ro5(hM]hN]rp5(jjk5Xpy-classrq5ehO]hP]hR]uhFjg5h@]rr5h^XTypes.QueryEngineListrs5rt5}ru5(hEUhFjm5ubahIjubaubeubahIjKubehIj|ubehIjubehIjubeubj)rv5}rw5(hEUhFjI3hGNhIjhK}rx5(hP]hO]hM]hN]hR]Uentries]ry5(jXquery() (in module MNQuery)h"UNtrz5auhTNhUhh@]ubj)r{5}r|5(hEUhFjI3hGNhIjhK}r}5(jjXpyr~5hP]hO]hM]hN]hR]jXfunctionr5jj5uhTNhUhh@]r5(j)r5}r5(hEX/query(session,queryEngine,query) -> OctetStreamhFj{5hGjq3hIjhK}r5(hP]r5h"ajj3hO]hM]hN]hR]r5h"ajXqueryr5jUjuhTKKhUhh@]r5(j)r5}r5(hEXMNQuery.hFj5hGjq3hIjhK}r5(hM]hN]hO]hP]hR]uhTKKhUhh@]r5h^XMNQuery.r5r5}r5(hEUhFj5ubaubj)r5}r5(hEj5hFj5hGjq3hIjhK}r5(hM]hN]hO]hP]hR]uhTKKhUhh@]r5h^Xqueryr5r5}r5(hEUhFj5ubaubj)r5}r5(hEXsession, queryEngine, queryhFj5hGjq3hIjhK}r5(hM]hN]hO]hP]hR]uhTKKhUhh@]r5(j)r5}r5(hEXsessionhK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^Xsessionr5r5}r5(hEUhFj5ubahIjubj)r5}r5(hEX queryEnginehK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^X queryEnginer5r5}r5(hEUhFj5ubahIjubj)r5}r5(hEXqueryhK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^Xqueryr5r5}r5(hEUhFj5ubahIjubeubj)r5}r5(hEX OctetStreamhFj5hGjq3hIjhK}r5(hM]hN]hO]hP]hR]uhTKKhUhh@]r5h^X OctetStreamr5r5}r5(hEUhFj5ubaubeubj)r5}r5(hEUhFj{5hGjq3hIj hK}r5(hM]hN]hO]hP]hR]uhTKKhUhh@]r5(hb)r5}r5(hEXkSubmit a query against the specified *queryEngine* and return the response as formatted by the queryEngine.hFj5hGjq3hIhfhK}r5(hM]hN]hO]hP]hR]uhTK#hUhh@]r5(h^X%Submit a query against the specified r5r5}r5(hEX%Submit a query against the specified hFj5ubj)r5}r5(hEX *queryEngine*hK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^X queryEnginer5r5}r5(hEUhFj5ubahIjubh^X9 and return the response as formatted by the queryEngine.r5r5}r5(hEX9 and return the response as formatted by the queryEngine.hFj5ubeubhb)r5}r5(hEXThe :func:`MNQuery.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.hFj5hGjq3hIhfhK}r5(hM]hN]hO]hP]hR]uhTK%hUhh@]r5(h^XThe r5r5}r5(hEXThe hFj5ubj)r5}r5(hEX:func:`MNQuery.query`r5hFj5hGjq3hIjhK}r5(UreftypeXfuncjjX MNQuery.queryU refdomainXpyr5hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTK%h@]r5j)r5}r5(hEj5hK}r5(hM]hN]r5(jj5Xpy-funcr5ehO]hP]hR]uhFj5h@]r5h^XMNQuery.query()r5r5}r5(hEUhFj5ubahIjubaubh^XM operation may be implemented by more than one type of search engine and the r5r5}r5(hEXM operation may be implemented by more than one type of search engine and the hFj5ubj)r5}r5(hEX *queryEngine*hK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^X queryEnginer5r5}r5(hEUhFj5ubahIjubh^XL parameter indicates which search engine is targeted. The value and form of r5r5}r5(hEXL parameter indicates which search engine is targeted. The value and form of hFj5ubj)r5}r5(hEX*query*hK}r5(hM]hN]hO]hP]hR]uhFj5h@]r5h^Xqueryr5r5}r5(hEUhFj5ubahIjubh^X, is determined by the specific query engine.r5r5}r5(hEX, is determined by the specific query engine.hFj5ubeubhb)r5}r5(hEXFor example, the SOLR search engine will accept many of the standard parameters of SOLR, including field restrictions and faceting.r5hFj5hGjq3hIhfhK}r5(hM]hN]hO]hP]hR]uhTK'hUhh@]r5h^XFor example, the SOLR search engine will accept many of the standard parameters of SOLR, including field restrictions and faceting.r5r5}r5(hEj5hFj5ubaubhb)r6}r6(hEXThis method is optional for Member Nodes, but if implemented, both getQueryEngineDescription and listQueryEngines must also be implemented.r6hFj5hGjq3hIhfhK}r6(hM]hN]hO]hP]hR]uhTK)hUhh@]r6h^XThis method is optional for Member Nodes, but if implemented, both getQueryEngineDescription and listQueryEngines must also be implemented.r6r6}r6(hEj6hFj6ubaubht)r6}r 6(hEUhFj5hGNhIhwhK}r 6(hM]hN]hO]hP]hR]uhTNhUhh@]r 6(hz)r 6}r 6(hEUhFj6hGjq3hIh}hK}r6(hM]hN]hO]hP]hR]uhTK+hUhh@]r6(h)r6}r6(hEXVersionhFj 6hGjq3hIhhK}r6(hM]hN]hO]hP]hR]uhTKh@]r6h^XVersionr6r6}r6(hEUhFj6ubaubh)r6}r6(hEX1.1r6hK}r6(hM]hN]hO]hP]hR]uhFj 6h@]r6hb)r6}r6(hEj6hFj6hGjq3hIhfhK}r6(hM]hN]hO]hP]hR]uhTK+h@]r6h^X1.1r 6r!6}r"6(hEj6hFj6ubaubahIhubeubhz)r#6}r$6(hEUhFj6hGjq3hIh}hK}r%6(hM]hN]hO]hP]hR]uhTK,hUhh@]r&6(h)r'6}r(6(hEX Use CaseshFj#6hGjq3hIhhK}r)6(hM]hN]hO]hP]hR]uhTKh@]r*6h^X Use Casesr+6r,6}r-6(hEUhFj'6ubaubh)r.6}r/6(hEXJ:doc:`UC02 `, :doc:`UC16 `r06hK}r16(hM]hN]hO]hP]hR]uhFj#6h@]r26hb)r36}r46(hEj06hFj.6hGjq3hIhfhK}r56(hM]hN]hO]hP]hR]uhTK-h@]r66(j)r76}r86(hEX$:doc:`UC02 `r96hFj36hGjq3hIjhK}r:6(UreftypeXdocr;6jjX/design/UseCases/02_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK-h@]r<6jr)r=6}r>6(hEj96hK}r?6(hM]hN]r@6(jj;6ehO]hP]hR]uhFj76h@]rA6h^XUC02rB6rC6}rD6(hEUhFj=6ubahIj{ubaubh^X, rE6rF6}rG6(hEX, hFj36ubj)rH6}rI6(hEX$:doc:`UC16 `rJ6hFj36hGjq3hIjhK}rK6(UreftypeXdocrL6jjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK-h@]rM6jr)rN6}rO6(hEjJ6hK}rP6(hM]hN]rQ6(jjL6ehO]hP]hR]uhFjH6h@]rR6h^XUC16rS6rT6}rU6(hEUhFjN6ubahIj{ubaubeubahIhubeubhz)rV6}rW6(hEUhFj6hGjq3hIh}hK}rX6(hM]hN]hO]hP]hR]uhTK.hUhh@]rY6(h)rZ6}r[6(hEXREST URLhFjV6hGjq3hIhhK}r\6(hM]hN]hO]hP]hR]uhTKh@]r]6h^XREST URLr^6r_6}r`6(hEUhFjZ6ubaubh)ra6}rb6(hEX$``GET /query/{queryEngine}/{query}``rc6hK}rd6(hM]hN]hO]hP]hR]uhFjV6h@]re6hb)rf6}rg6(hEjc6hFja6hGjq3hIhfhK}rh6(hM]hN]hO]hP]hR]uhTK.h@]ri6j)rj6}rk6(hEjc6hK}rl6(hM]hN]hO]hP]hR]uhFjf6h@]rm6h^X GET /query/{queryEngine}/{query}rn6ro6}rp6(hEUhFjj6ubahIjubaubahIhubeubhz)rq6}rr6(hEUhK}rs6(hM]hN]hO]hP]hR]uhFj6h@]rt6(h)ru6}rv6(hEX ParametershFjq6hGjq3hIhhK}rw6(hM]hN]hO]hP]hR]uhTKh@]rx6h^X Parametersry6rz6}r{6(hEUhFju6ubaubh)r|6}r}6(hEUhK}r~6(hM]hN]hO]hP]hR]uhFjq6h@]r6j)r6}r6(hEUhK}r6(hM]hN]hO]hP]hR]uhFj|6h@]r6(j)r6}r6(hEUhK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6hb)r6}r6(hEXTsession (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.hK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6(j)r6}r6(hEXsessionhK}r6(hP]hO]jhM]hN]hR]uhFj6h@]r6h^Xsessionr6r6}r6(hEUhFj6ubahIjubh^X (r6r6}r6(hEUhFj6ubj)r6}r6(hEX:class:`Types.Session`r6hFj6hGjq3hIjhK}r6(UreftypeXclassjjX Types.SessionU refdomainXpyr6hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTK0h@]r6j)r6}r6(hEj6hK}r6(hM]hN]r6(jj6Xpy-classr6ehO]hP]hR]uhFj6h@]r6h^X Types.Sessionr6r6}r6(hEUhFj6ubahIjubaubh^X)r6}r6(hEUhFj6ubh^X -- r6r6}r6(hEUhFj6ubh^XSession 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 r6r6}r6(hEXSession 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 hFj6ubj)r6}r6(hEX:term:`public user`r6hFj6hGjq3hIjhK}r6(UreftypeXtermjjX public userU refdomainXstdr6hP]hO]U refexplicithM]hN]hR]jjuhTK/h@]r6jr)r6}r6(hEj6hK}r6(hM]hN]r6(jj6Xstd-termr6ehO]hP]hR]uhFj6h@]r6h^X public userr6r6}r6(hEUhFj6ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r6r6}r6(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj6ubehIhfubahIjubj)r6}r6(hEUhK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6hb)r6}r6(hEXqueryEngine (string) -- Indicates which search engine will be used to handle the query. Supported search engines can be determined through the MNQuery.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.hK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6(j)r6}r6(hEX queryEnginehK}r6(hP]hO]jhM]hN]hR]uhFj6h@]r6h^X queryEnginer6r6}r6(hEUhFj6ubahIjubh^X (r6r6}r6(hEUhFj6ubj)r6}r6(hEUhK}r6(UreftypejjU reftargetXstringr6U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj6h@]r6j)r6}r6(hEj6hK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6h^Xstringr6r6}r6(hEUhFj6ubahIjubahIjubh^X)r6}r6(hEUhFj6ubh^X -- r6r6}r6(hEUhFj6ubh^XIndicates which search engine will be used to handle the query. Supported search engines can be determined through the MNQuery.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.r6r6}r6(hEXIndicates which search engine will be used to handle the query. Supported search engines can be determined through the MNQuery.listQueryEngines API call. Transmitted as part of the URL path and must be escaped accordingly.hFj6ubehIhfubahIjubj)r6}r6(hEUhK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6hb)r6}r6(hEXquery (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.hK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6(j)r6}r6(hEXqueryhK}r6(hP]hO]jhM]hN]hR]uhFj6h@]r6h^Xqueryr6r6}r6(hEUhFj6ubahIjubh^X (r6r6}r6(hEUhFj6ubj)r6}r6(hEUhK}r6(UreftypejjU reftargetXstringr6U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj6h@]r6j)r6}r6(hEj6hK}r6(hM]hN]hO]hP]hR]uhFj6h@]r6h^Xstringr7r7}r7(hEUhFj6ubahIjubahIjubh^X)r7}r7(hEUhFj6ubh^X -- r7r7}r7(hEUhFj6ubh^XThe 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.r7r 7}r 7(hEXThe 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.hFj6ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r 7}r 7(hEUhK}r 7(hM]hN]hO]hP]hR]uhFj6h@]r7(h)r7}r7(hEXReturnshFj 7hGjq3hIhhK}r7(hM]hN]hO]hP]hR]uhTKh@]r7h^XReturnsr7r7}r7(hEUhFj7ubaubh)r7}r7(hEUhK}r7(hM]hN]hO]hP]hR]uhFj 7h@]r7hb)r7}r7(hEXfThe structure of the response is determined by the chosen search engine and parameters provided to it.hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^XfThe structure of the response is determined by the chosen search engine and parameters provided to it.r7r7}r 7(hEXfThe structure of the response is determined by the chosen search engine and parameters provided to it.hFj7ubahIhfubahIhubehIh}ubhz)r!7}r"7(hEUhK}r#7(hM]hN]hO]hP]hR]uhFj6h@]r$7(h)r%7}r&7(hEX Return typehFj!7hGjq3hIhhK}r'7(hM]hN]hO]hP]hR]uhTKh@]r(7h^X Return typer)7r*7}r+7(hEUhFj%7ubaubh)r,7}r-7(hEUhK}r.7(hM]hN]hO]hP]hR]uhFj!7h@]r/7hb)r07}r17(hEXTypes.OctetStreamhK}r27(hM]hN]hO]hP]hR]uhFj,7h@]r37j)r47}r57(hEX:class:`Types.OctetStream`r67hFj07hGjq3hIjhK}r77(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr87hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTK9h@]r97j)r:7}r;7(hEj67hK}r<7(hM]hN]r=7(jj87Xpy-classr>7ehO]hP]hR]uhFj47h@]r?7h^XTypes.OctetStreamr@7rA7}rB7(hEUhFj:7ubahIjubaubahIhfubahIhubehIh}ubhz)rC7}rD7(hEUhK}rE7(hM]hN]hO]hP]hR]uhFj6h@]rF7(h)rG7}rH7(hEXRaiseshFjC7hGjq3hIhhK}rI7(hM]hN]hO]hP]hR]uhTKh@]rJ7h^XRaisesrK7rL7}rM7(hEUhFjG7ubaubh)rN7}rO7(hEUhK}rP7(hM]hN]hO]hP]hR]uhFjC7h@]rQ7j)rR7}rS7(hEUhK}rT7(hM]hN]hO]hP]hR]uhFjN7h@]rU7(j)rV7}rW7(hEUhK}rX7(hM]hN]hO]hP]hR]uhFjR7h@]rY7hb)rZ7}r[7(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2820)hK}r\7(hM]hN]hO]hP]hR]uhFjV7h@]r]7(j)r^7}r_7(hEUhK}r`7(UreftypejjU reftargetXExceptions.InvalidTokenra7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFjZ7h@]rb7j)rc7}rd7(hEja7hK}re7(hM]hN]hO]hP]hR]uhFj^7h@]rf7h^XExceptions.InvalidTokenrg7rh7}ri7(hEUhFjc7ubahIjubahIjubh^X -- rj7rk7}rl7(hEUhFjZ7ubj)rm7}rn7(hEX$``(errorCode=401, detailCode=2820)``hK}ro7(hM]hN]hO]hP]hR]uhFjZ7h@]rp7h^X (errorCode=401, detailCode=2820)rq7rr7}rs7(hEUhFjm7ubahIjubehIhfubahIjubj)rt7}ru7(hEUhK}rv7(hM]hN]hO]hP]hR]uhFjR7h@]rw7hb)rx7}ry7(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2821)hK}rz7(hM]hN]hO]hP]hR]uhFjt7h@]r{7(j)r|7}r}7(hEUhK}r~7(UreftypejjU reftargetXExceptions.ServiceFailurer7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFjx7h@]r7j)r7}r7(hEj7hK}r7(hM]hN]hO]hP]hR]uhFj|7h@]r7h^XExceptions.ServiceFailurer7r7}r7(hEUhFj7ubahIjubahIjubh^X -- r7r7}r7(hEUhFjx7ubj)r7}r7(hEX$``(errorCode=500, detailCode=2821)``hK}r7(hM]hN]hO]hP]hR]uhFjx7h@]r7h^X (errorCode=500, detailCode=2821)r7r7}r7(hEUhFj7ubahIjubehIhfubahIjubj)r7}r7(hEUhK}r7(hM]hN]hO]hP]hR]uhFjR7h@]r7hb)r7}r7(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2822)hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7(j)r7}r7(hEUhK}r7(UreftypejjU reftargetXExceptions.NotAuthorizedr7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj7h@]r7j)r7}r7(hEj7hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^XExceptions.NotAuthorizedr7r7}r7(hEUhFj7ubahIjubahIjubh^X -- r7r7}r7(hEUhFj7ubj)r7}r7(hEX$``(errorCode=401, detailCode=2822)``hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^X (errorCode=401, detailCode=2822)r7r7}r7(hEUhFj7ubahIjubehIhfubahIjubj)r7}r7(hEUhK}r7(hM]hN]hO]hP]hR]uhFjR7h@]r7hb)r7}r7(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2823)hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7(j)r7}r7(hEUhK}r7(UreftypejjU reftargetXExceptions.InvalidRequestr7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj7h@]r7j)r7}r7(hEj7hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^XExceptions.InvalidRequestr7r7}r7(hEUhFj7ubahIjubahIjubh^X -- r7r7}r7(hEUhFj7ubj)r7}r7(hEX$``(errorCode=400, detailCode=2823)``hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^X (errorCode=400, detailCode=2823)r7r7}r7(hEUhFj7ubahIjubehIhfubahIjubj)r7}r7(hEUhK}r7(hM]hN]hO]hP]hR]uhFjR7h@]r7hb)r7}r7(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2824)hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7(j)r7}r7(hEUhK}r7(UreftypejjU reftargetXExceptions.NotImplementedr7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj7h@]r7j)r7}r7(hEj7hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^XExceptions.NotImplementedr7r7}r7(hEUhFj7ubahIjubahIjubh^X -- r7r7}r7(hEUhFj7ubj)r7}r7(hEX$``(errorCode=501, detailCode=2824)``hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^X (errorCode=501, detailCode=2824)r7r7}r7(hEUhFj7ubahIjubehIhfubahIjubj)r7}r7(hEUhK}r7(hM]hN]hO]hP]hR]uhFjR7h@]r7hb)r7}r7(hEX_Exceptions.NotFound -- (errorCode=404, detailCode=2825)The specified queryEngine does not existhK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7(j)r7}r7(hEUhK}r7(UreftypejjU reftargetXExceptions.NotFoundr7U refdomainj~5hP]hO]U refexplicithM]hN]hR]uhFj7h@]r7j)r7}r7(hEj7hK}r7(hM]hN]hO]hP]hR]uhFj7h@]r7h^XExceptions.NotFoundr7r7}r7(hEUhFj7ubahIjubahIjubh^X -- r8r8}r8(hEUhFj7ubhb)r8}r8(hEX$``(errorCode=404, detailCode=2825)``r8hFj7hGjq3hIhfhK}r8(hM]hN]hO]hP]hR]uhTKEh@]r8j)r8}r 8(hEj8hK}r 8(hM]hN]hO]hP]hR]uhFj8h@]r 8h^X (errorCode=404, detailCode=2825)r 8r 8}r8(hEUhFj8ubahIjubaubhb)r8}r8(hEX(The specified queryEngine does not existr8hFj7hGjq3hIhfhK}r8(hM]hN]hO]hP]hR]uhTKGh@]r8h^X(The specified queryEngine does not existr8r8}r8(hEj8hFj8ubaubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r8}r8(hEUhFjI3hGNhIjhK}r8(hP]hO]hM]hN]hR]Uentries]r8(jX/getQueryEngineDescription() (in module MNQuery)hUNtr8auhTNhUhh@]ubj)r8}r8(hEUhFjI3hGNhIjhK}r8(jjXpyr8hP]hO]hM]hN]hR]jXfunctionr 8jj 8uhTNhUhh@]r!8(j)r"8}r#8(hEXHgetQueryEngineDescription(session,queryEngine) -> QueryEngineDescriptionhFj8hGjq3hIjhK}r$8(hP]r%8hajj3hO]hM]hN]hR]r&8hajXgetQueryEngineDescriptionr'8jUjuhTKihUhh@]r(8(j)r)8}r*8(hEXMNQuery.hFj"8hGjq3hIjhK}r+8(hM]hN]hO]hP]hR]uhTKihUhh@]r,8h^XMNQuery.r-8r.8}r/8(hEUhFj)8ubaubj)r08}r18(hEj'8hFj"8hGjq3hIjhK}r28(hM]hN]hO]hP]hR]uhTKihUhh@]r38h^XgetQueryEngineDescriptionr48r58}r68(hEUhFj08ubaubj)r78}r88(hEXsession, queryEnginehFj"8hGjq3hIjhK}r98(hM]hN]hO]hP]hR]uhTKihUhh@]r:8(j)r;8}r<8(hEXsessionhK}r=8(hM]hN]hO]hP]hR]uhFj78h@]r>8h^Xsessionr?8r@8}rA8(hEUhFj;8ubahIjubj)rB8}rC8(hEX queryEnginehK}rD8(hM]hN]hO]hP]hR]uhFj78h@]rE8h^X queryEnginerF8rG8}rH8(hEUhFjB8ubahIjubeubj)rI8}rJ8(hEXQueryEngineDescriptionhFj"8hGjq3hIjhK}rK8(hM]hN]hO]hP]hR]uhTKihUhh@]rL8h^XQueryEngineDescriptionrM8rN8}rO8(hEUhFjI8ubaubeubj)rP8}rQ8(hEUhFj8hGjq3hIj hK}rR8(hM]hN]hO]hP]hR]uhTKihUhh@]rS8(hb)rT8}rU8(hEXProvides 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.hFjP8hGjq3hIhfhK}rV8(hM]hN]hO]hP]hR]uhTKNhUhh@]rW8(h^X;Provides metadata about the query service of the specified rX8rY8}rZ8(hEX;Provides metadata about the query service of the specified hFjT8ubj)r[8}r\8(hEX *queryEngine*hK}r]8(hM]hN]hO]hP]hR]uhFjT8h@]r^8h^X queryEnginer_8r`8}ra8(hEUhFj[8ubahIjubh^X. 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.rb8rc8}rd8(hEX. 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.hFjT8ubeubht)re8}rf8(hEUhFjP8hGNhIhwhK}rg8(hM]hN]hO]hP]hR]uhTNhUhh@]rh8(hz)ri8}rj8(hEUhFje8hGjq3hIh}hK}rk8(hM]hN]hO]hP]hR]uhTKPhUhh@]rl8(h)rm8}rn8(hEXVersionhFji8hGjq3hIhhK}ro8(hM]hN]hO]hP]hR]uhTKh@]rp8h^XVersionrq8rr8}rs8(hEUhFjm8ubaubh)rt8}ru8(hEX1.1rv8hK}rw8(hM]hN]hO]hP]hR]uhFji8h@]rx8hb)ry8}rz8(hEjv8hFjt8hGjq3hIhfhK}r{8(hM]hN]hO]hP]hR]uhTKPh@]r|8h^X1.1r}8r~8}r8(hEjv8hFjy8ubaubahIhubeubhz)r8}r8(hEUhFje8hGjq3hIh}hK}r8(hM]hN]hO]hP]hR]uhTKQhUhh@]r8(h)r8}r8(hEXREST URLhFj8hGjq3hIhhK}r8(hM]hN]hO]hP]hR]uhTKh@]r8h^XREST URLr8r8}r8(hEUhFj8ubaubh)r8}r8(hEX``GET /query/{queryType}``r8hK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8hb)r8}r8(hEj8hFj8hGjq3hIhfhK}r8(hM]hN]hO]hP]hR]uhTKQh@]r8j)r8}r8(hEj8hK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8h^XGET /query/{queryType}r8r8}r8(hEUhFj8ubahIjubaubahIhubeubhz)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFje8h@]r8(h)r8}r8(hEX ParametershFj8hGjq3hIhhK}r8(hM]hN]hO]hP]hR]uhTKh@]r8h^X Parametersr8r8}r8(hEUhFj8ubaubh)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8j)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8(j)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8hb)r8}r8(hEX.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.hK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8(j)r8}r8(hEXsessionhK}r8(hP]hO]jhM]hN]hR]uhFj8h@]r8h^Xsessionr8r8}r8(hEUhFj8ubahIjubh^X (r8r8}r8(hEUhFj8ubj)r8}r8(hEX:class:`Types.Session`r8hFj8hGjq3hIjhK}r8(UreftypeXclassjjX Types.SessionU refdomainXpyr8hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKSh@]r8j)r8}r8(hEj8hK}r8(hM]hN]r8(jj8Xpy-classr8ehO]hP]hR]uhFj8h@]r8h^X Types.Sessionr8r8}r8(hEUhFj8ubahIjubaubh^X)r8}r8(hEUhFj8ubh^X -- r8r8}r8(hEUhFj8ubh^XSession 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.r8r8}r8(hEXSession 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.hFj8ubehIhfubahIjubj)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8hb)r8}r8(hEXqueryEngine (string) -- Indicates which query engine for which to provide descriptive metadata. Currently supported search engines can be determined through MNQuery.listQueryEngines. Transmitted as part of the URL path and must be escaped accordingly.hK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8(j)r8}r8(hEX queryEnginehK}r8(hP]hO]jhM]hN]hR]uhFj8h@]r8h^X queryEnginer8r8}r8(hEUhFj8ubahIjubh^X (r8r8}r8(hEUhFj8ubj)r8}r8(hEUhK}r8(UreftypejjU reftargetXstringr8U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFj8h@]r8j)r8}r8(hEj8hK}r8(hM]hN]hO]hP]hR]uhFj8h@]r8h^Xstringr8r8}r8(hEUhFj8ubahIjubahIjubh^X)r8}r8(hEUhFj8ubh^X -- r8r8}r8(hEUhFj8ubh^XIndicates which query engine for which to provide descriptive metadata. Currently supported search engines can be determined through MNQuery.listQueryEngines. Transmitted as part of the URL path and must be escaped accordingly.r8r8}r8(hEXIndicates which query engine for which to provide descriptive metadata. Currently supported search engines can be determined through MNQuery.listQueryEngines. Transmitted as part of the URL path and must be escaped accordingly.hFj8ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r8}r8(hEUhK}r8(hM]hN]hO]hP]hR]uhFje8h@]r9(h)r9}r9(hEXReturnshFj8hGjq3hIhhK}r9(hM]hN]hO]hP]hR]uhTKh@]r9h^XReturnsr9r9}r9(hEUhFj9ubaubh)r9}r 9(hEUhK}r 9(hM]hN]hO]hP]hR]uhFj8h@]r 9hb)r 9}r 9(hEXPA list of fields that are supported by the search index and additional metadata.hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^XPA list of fields that are supported by the search index and additional metadata.r9r9}r9(hEXPA list of fields that are supported by the search index and additional metadata.hFj 9ubahIhfubahIhubehIh}ubhz)r9}r9(hEUhK}r9(hM]hN]hO]hP]hR]uhFje8h@]r9(h)r9}r9(hEX Return typehFj9hGjq3hIhhK}r9(hM]hN]hO]hP]hR]uhTKh@]r9h^X Return typer9r9}r9(hEUhFj9ubaubh)r9}r9(hEUhK}r 9(hM]hN]hO]hP]hR]uhFj9h@]r!9hb)r"9}r#9(hEXTypes.QueryEngineDescriptionhK}r$9(hM]hN]hO]hP]hR]uhFj9h@]r%9j)r&9}r'9(hEX%:class:`Types.QueryEngineDescription`r(9hFj"9hGjq3hIjhK}r)9(UreftypeXclassjjXTypes.QueryEngineDescriptionU refdomainXpyr*9hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKYh@]r+9j)r,9}r-9(hEj(9hK}r.9(hM]hN]r/9(jj*9Xpy-classr09ehO]hP]hR]uhFj&9h@]r19h^XTypes.QueryEngineDescriptionr29r39}r49(hEUhFj,9ubahIjubaubahIhfubahIhubehIh}ubhz)r59}r69(hEUhK}r79(hM]hN]hO]hP]hR]uhFje8h@]r89(h)r99}r:9(hEXRaiseshFj59hGjq3hIhhK}r;9(hM]hN]hO]hP]hR]uhTKh@]r<9h^XRaisesr=9r>9}r?9(hEUhFj99ubaubh)r@9}rA9(hEUhK}rB9(hM]hN]hO]hP]hR]uhFj59h@]rC9j)rD9}rE9(hEUhK}rF9(hM]hN]hO]hP]hR]uhFj@9h@]rG9(j)rH9}rI9(hEUhK}rJ9(hM]hN]hO]hP]hR]uhFjD9h@]rK9hb)rL9}rM9(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2810)hK}rN9(hM]hN]hO]hP]hR]uhFjH9h@]rO9(j)rP9}rQ9(hEUhK}rR9(UreftypejjU reftargetXExceptions.NotImplementedrS9U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFjL9h@]rT9j)rU9}rV9(hEjS9hK}rW9(hM]hN]hO]hP]hR]uhFjP9h@]rX9h^XExceptions.NotImplementedrY9rZ9}r[9(hEUhFjU9ubahIjubahIjubh^X -- r\9r]9}r^9(hEUhFjL9ubj)r_9}r`9(hEX$``(errorCode=501, detailCode=2810)``hK}ra9(hM]hN]hO]hP]hR]uhFjL9h@]rb9h^X (errorCode=501, detailCode=2810)rc9rd9}re9(hEUhFj_9ubahIjubehIhfubahIjubj)rf9}rg9(hEUhK}rh9(hM]hN]hO]hP]hR]uhFjD9h@]ri9hb)rj9}rk9(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2811)hK}rl9(hM]hN]hO]hP]hR]uhFjf9h@]rm9(j)rn9}ro9(hEUhK}rp9(UreftypejjU reftargetXExceptions.ServiceFailurerq9U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFjj9h@]rr9j)rs9}rt9(hEjq9hK}ru9(hM]hN]hO]hP]hR]uhFjn9h@]rv9h^XExceptions.ServiceFailurerw9rx9}ry9(hEUhFjs9ubahIjubahIjubh^X -- rz9r{9}r|9(hEUhFjj9ubj)r}9}r~9(hEX$``(errorCode=500, detailCode=2811)``hK}r9(hM]hN]hO]hP]hR]uhFjj9h@]r9h^X (errorCode=500, detailCode=2811)r9r9}r9(hEUhFj}9ubahIjubehIhfubahIjubj)r9}r9(hEUhK}r9(hM]hN]hO]hP]hR]uhFjD9h@]r9hb)r9}r9(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2812)hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9(j)r9}r9(hEUhK}r9(UreftypejjU reftargetXExceptions.InvalidTokenr9U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFj9h@]r9j)r9}r9(hEj9hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^XExceptions.InvalidTokenr9r9}r9(hEUhFj9ubahIjubahIjubh^X -- r9r9}r9(hEUhFj9ubj)r9}r9(hEX$``(errorCode=401, detailCode=2812)``hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^X (errorCode=401, detailCode=2812)r9r9}r9(hEUhFj9ubahIjubehIhfubahIjubj)r9}r9(hEUhK}r9(hM]hN]hO]hP]hR]uhFjD9h@]r9hb)r9}r9(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2813)hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9(j)r9}r9(hEUhK}r9(UreftypejjU reftargetXExceptions.NotAuthorizedr9U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFj9h@]r9j)r9}r9(hEj9hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^XExceptions.NotAuthorizedr9r9}r9(hEUhFj9ubahIjubahIjubh^X -- r9r9}r9(hEUhFj9ubj)r9}r9(hEX$``(errorCode=401, detailCode=2813)``hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^X (errorCode=401, detailCode=2813)r9r9}r9(hEUhFj9ubahIjubehIhfubahIjubj)r9}r9(hEUhK}r9(hM]hN]hO]hP]hR]uhFjD9h@]r9hb)r9}r9(hEX_Exceptions.NotFound -- (errorCode=404, detailCode=2814)The specified queryEngine does not existhK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9(j)r9}r9(hEUhK}r9(UreftypejjU reftargetXExceptions.NotFoundr9U refdomainj8hP]hO]U refexplicithM]hN]hR]uhFj9h@]r9j)r9}r9(hEj9hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^XExceptions.NotFoundr9r9}r9(hEUhFj9ubahIjubahIjubh^X -- r9r9}r9(hEUhFj9ubhb)r9}r9(hEX$``(errorCode=404, detailCode=2814)``r9hFj9hGjq3hIhfhK}r9(hM]hN]hO]hP]hR]uhTKch@]r9j)r9}r9(hEj9hK}r9(hM]hN]hO]hP]hR]uhFj9h@]r9h^X (errorCode=404, detailCode=2814)r9r9}r9(hEUhFj9ubahIjubaubhb)r9}r9(hEX(The specified queryEngine does not existr9hFj9hGjq3hIhfhK}r9(hM]hN]hO]hP]hR]uhTKeh@]r9h^X(The specified queryEngine does not existr9r9}r9(hEj9hFj9ubaubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r9}r9(hEUhFjI3hGNhIjhK}r9(hP]hO]hM]hN]hR]Uentries]r9(jX&listQueryEngines() (in module MNQuery)hUNtr9auhTNhUhh@]ubj)r9}r9(hEUhFjI3hGNhIjhK}r9(jjXpyr9hP]hO]hM]hN]hR]jXfunctionr9jj9uhTNhUhh@]r9(j)r9}r9(hEX,listQueryEngines(session) -> QueryEngineListhFj9hGXBinternal padding after source/apis/generated/generated_MNQuery.txtr9hIjhK}r9(hP]r9hajj3hO]hM]hN]hR]r9hajXlistQueryEnginesr9jUjuhTKhUhh@]r9(j)r9}r9(hEXMNQuery.hFj9hGj9hIjhK}r:(hM]hN]hO]hP]hR]uhTKhUhh@]r:h^XMNQuery.r:r:}r:(hEUhFj9ubaubj)r:}r:(hEj9hFj9hGj9hIjhK}r:(hM]hN]hO]hP]hR]uhTKhUhh@]r:h^XlistQueryEnginesr :r :}r :(hEUhFj:ubaubj)r :}r :(hEXsessionhFj9hGj9hIjhK}r:(hM]hN]hO]hP]hR]uhTKhUhh@]r:j)r:}r:(hEXsessionhK}r:(hM]hN]hO]hP]hR]uhFj :h@]r:h^Xsessionr:r:}r:(hEUhFj:ubahIjubaubj)r:}r:(hEXQueryEngineListhFj9hGj9hIjhK}r:(hM]hN]hO]hP]hR]uhTKhUhh@]r:h^XQueryEngineListr:r:}r:(hEUhFj:ubaubeubj)r:}r:(hEUhFj9hGj9hIj hK}r :(hM]hN]hO]hP]hR]uhTKhUhh@]r!:(hb)r":}r#:(hEXReturns a list of query engines, i.e. supported values for the *queryEngine* parameter of the *getQueryEngineDescription* and *query* operations.hFj:hGjq3hIhfhK}r$:(hM]hN]hO]hP]hR]uhTKlhUhh@]r%:(h^X?Returns a list of query engines, i.e. supported values for the r&:r':}r(:(hEX?Returns a list of query engines, i.e. supported values for the hFj":ubj)r):}r*:(hEX *queryEngine*hK}r+:(hM]hN]hO]hP]hR]uhFj":h@]r,:h^X queryEnginer-:r.:}r/:(hEUhFj):ubahIjubh^X parameter of the r0:r1:}r2:(hEX parameter of the hFj":ubj)r3:}r4:(hEX*getQueryEngineDescription*hK}r5:(hM]hN]hO]hP]hR]uhFj":h@]r6:h^XgetQueryEngineDescriptionr7:r8:}r9:(hEUhFj3:ubahIjubh^X and r::r;:}r<:(hEX and hFj":ubj)r=:}r>:(hEX*query*hK}r?:(hM]hN]hO]hP]hR]uhFj":h@]r@:h^XqueryrA:rB:}rC:(hEUhFj=:ubahIjubh^X operations.rD:rE:}rF:(hEX operations.hFj":ubeubhb)rG:}rH:(hEXcThe list of search engines available may be influenced by the authentication status of the request.rI:hFj:hGjq3hIhfhK}rJ:(hM]hN]hO]hP]hR]uhTKnhUhh@]rK:h^XcThe list of search engines available may be influenced by the authentication status of the request.rL:rM:}rN:(hEjI:hFjG:ubaubht)rO:}rP:(hEUhFj:hGNhIhwhK}rQ:(hM]hN]hO]hP]hR]uhTNhUhh@]rR:(hz)rS:}rT:(hEUhFjO:hGjq3hIh}hK}rU:(hM]hN]hO]hP]hR]uhTKphUhh@]rV:(h)rW:}rX:(hEXVersionhFjS:hGjq3hIhhK}rY:(hM]hN]hO]hP]hR]uhTKh@]rZ:h^XVersionr[:r\:}r]:(hEUhFjW:ubaubh)r^:}r_:(hEX1.1r`:hK}ra:(hM]hN]hO]hP]hR]uhFjS:h@]rb:hb)rc:}rd:(hEj`:hFj^:hGjq3hIhfhK}re:(hM]hN]hO]hP]hR]uhTKph@]rf:h^X1.1rg:rh:}ri:(hEj`:hFjc:ubaubahIhubeubhz)rj:}rk:(hEUhFjO:hGjq3hIh}hK}rl:(hM]hN]hO]hP]hR]uhTKqhUhh@]rm:(h)rn:}ro:(hEXREST URLhFjj:hGjq3hIhhK}rp:(hM]hN]hO]hP]hR]uhTKh@]rq:h^XREST URLrr:rs:}rt:(hEUhFjn:ubaubh)ru:}rv:(hEX``GET /query``rw:hK}rx:(hM]hN]hO]hP]hR]uhFjj:h@]ry:hb)rz:}r{:(hEjw:hFju:hGjq3hIhfhK}r|:(hM]hN]hO]hP]hR]uhTKqh@]r}:j)r~:}r:(hEjw:hK}r:(hM]hN]hO]hP]hR]uhFjz:h@]r:h^X GET /queryr:r:}r:(hEUhFj~:ubahIjubaubahIhubeubhz)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFjO:h@]r:(h)r:}r:(hEX ParametershFj:hGj9hIhhK}r:(hM]hN]hO]hP]hR]uhTKh@]r:h^X Parametersr:r:}r:(hEUhFj:ubaubh)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:hb)r:}r:(hEX.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.hK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:(j)r:}r:(hEXsessionhK}r:(hP]hO]jhM]hN]hR]uhFj:h@]r:h^Xsessionr:r:}r:(hEUhFj:ubahIjubh^X (r:r:}r:(hEUhFj:ubj)r:}r:(hEX:class:`Types.Session`r:hFj:hGjq3hIjhK}r:(UreftypeXclassjjX Types.SessionU refdomainXpyr:hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKsh@]r:j)r:}r:(hEj:hK}r:(hM]hN]r:(jj:Xpy-classr:ehO]hP]hR]uhFj:h@]r:h^X Types.Sessionr:r:}r:(hEUhFj:ubahIjubaubh^X)r:}r:(hEUhFj:ubh^X -- r:r:}r:(hEUhFj:ubh^XSession 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.r:r:}r:(hEXSession 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.hFj:ubehIhfubahIhubehIh}ubhz)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFjO:h@]r:(h)r:}r:(hEXReturnshFj:hGj9hIhhK}r:(hM]hN]hO]hP]hR]uhTKh@]r:h^XReturnsr:r:}r:(hEUhFj:ubaubh)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:hb)r:}r:(hEXLA list of names of queryEngines available to the user identified by session.hK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:(h^XDA list of names of queryEngines available to the user identified by r:r:}r:(hEXDA list of names of queryEngines available to the user identified by hFj:ubj)r:}r:(hEX *session*hK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:h^Xsessionr:r:}r:(hEUhFj:ubahIjubh^X.r:}r:(hEX.hFj:ubehIhfubahIhubehIh}ubhz)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFjO:h@]r:(h)r:}r:(hEX Return typehFj:hGj9hIhhK}r:(hM]hN]hO]hP]hR]uhTKh@]r:h^X Return typer:r:}r:(hEUhFj:ubaubh)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:hb)r:}r:(hEXTypes.QueryEngineListhK}r:(hM]hN]hO]hP]hR]uhFj:h@]r:j)r:}r:(hEX:class:`Types.QueryEngineList`r:hFj:hGjq3hIjhK}r:(UreftypeXclassjjXTypes.QueryEngineListU refdomainXpyr:hP]hO]U refexplicithM]hN]hR]jjjNjj3uhTKvh@]r:j)r:}r:(hEj:hK}r:(hM]hN]r:(jj:Xpy-classr:ehO]hP]hR]uhFj:h@]r:h^XTypes.QueryEngineListr:r:}r:(hEUhFj:ubahIjubaubahIhfubahIhubehIh}ubhz)r:}r:(hEUhK}r:(hM]hN]hO]hP]hR]uhFjO:h@]r:(h)r:}r:(hEXRaiseshFj:hGj9hIhhK}r;(hM]hN]hO]hP]hR]uhTKh@]r;h^XRaisesr;r;}r;(hEUhFj:ubaubh)r;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj:h@]r;j)r ;}r ;(hEUhK}r ;(hM]hN]hO]hP]hR]uhFj;h@]r ;(j)r ;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj ;h@]r;hb)r;}r;(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2800)hK}r;(hM]hN]hO]hP]hR]uhFj ;h@]r;(j)r;}r;(hEUhK}r;(UreftypejjU reftargetXExceptions.NotImplementedr;U refdomainj9hP]hO]U refexplicithM]hN]hR]uhFj;h@]r;j)r;}r;(hEj;hK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;h^XExceptions.NotImplementedr;r;}r ;(hEUhFj;ubahIjubahIjubh^X -- r!;r";}r#;(hEUhFj;ubj)r$;}r%;(hEX$``(errorCode=501, detailCode=2800)``hK}r&;(hM]hN]hO]hP]hR]uhFj;h@]r';h^X (errorCode=501, detailCode=2800)r(;r);}r*;(hEUhFj$;ubahIjubehIhfubahIjubj)r+;}r,;(hEUhK}r-;(hM]hN]hO]hP]hR]uhFj ;h@]r.;hb)r/;}r0;(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2801)hK}r1;(hM]hN]hO]hP]hR]uhFj+;h@]r2;(j)r3;}r4;(hEUhK}r5;(UreftypejjU reftargetXExceptions.ServiceFailurer6;U refdomainj9hP]hO]U refexplicithM]hN]hR]uhFj/;h@]r7;j)r8;}r9;(hEj6;hK}r:;(hM]hN]hO]hP]hR]uhFj3;h@]r;;h^XExceptions.ServiceFailurer<;r=;}r>;(hEUhFj8;ubahIjubahIjubh^X -- r?;r@;}rA;(hEUhFj/;ubj)rB;}rC;(hEX$``(errorCode=500, detailCode=2801)``hK}rD;(hM]hN]hO]hP]hR]uhFj/;h@]rE;h^X (errorCode=500, detailCode=2801)rF;rG;}rH;(hEUhFjB;ubahIjubehIhfubahIjubj)rI;}rJ;(hEUhK}rK;(hM]hN]hO]hP]hR]uhFj ;h@]rL;hb)rM;}rN;(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2802)hK}rO;(hM]hN]hO]hP]hR]uhFjI;h@]rP;(j)rQ;}rR;(hEUhK}rS;(UreftypejjU reftargetXExceptions.InvalidTokenrT;U refdomainj9hP]hO]U refexplicithM]hN]hR]uhFjM;h@]rU;j)rV;}rW;(hEjT;hK}rX;(hM]hN]hO]hP]hR]uhFjQ;h@]rY;h^XExceptions.InvalidTokenrZ;r[;}r\;(hEUhFjV;ubahIjubahIjubh^X -- r];r^;}r_;(hEUhFjM;ubj)r`;}ra;(hEX$``(errorCode=401, detailCode=2802)``hK}rb;(hM]hN]hO]hP]hR]uhFjM;h@]rc;h^X (errorCode=401, detailCode=2802)rd;re;}rf;(hEUhFj`;ubahIjubehIhfubahIjubj)rg;}rh;(hEUhK}ri;(hM]hN]hO]hP]hR]uhFj ;h@]rj;hb)rk;}rl;(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2803)hK}rm;(hM]hN]hO]hP]hR]uhFjg;h@]rn;(j)ro;}rp;(hEUhK}rq;(UreftypejjU reftargetXExceptions.NotAuthorizedrr;U refdomainj9hP]hO]U refexplicithM]hN]hR]uhFjk;h@]rs;j)rt;}ru;(hEjr;hK}rv;(hM]hN]hO]hP]hR]uhFjo;h@]rw;h^XExceptions.NotAuthorizedrx;ry;}rz;(hEUhFjt;ubahIjubahIjubh^X -- r{;r|;}r};(hEUhFjk;ubj)r~;}r;(hEX$``(errorCode=401, detailCode=2803)``hK}r;(hM]hN]hO]hP]hR]uhFjk;h@]r;h^X (errorCode=401, detailCode=2803)r;r;}r;(hEUhFj~;ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubeubhB)r;}r;(hEUhFhChGhHhIhJhK}r;(hM]hN]hO]hP]r;(X module-MNViewr;h:ehR]r;hauhTK}hUhh@]r;(hW)r;}r;(hEXView APIr;hFj;hGhHhIh[hK}r;(hM]hN]hO]hP]hR]uhTK}hUhh@]r;h^XView APIr;r;}r;(hEj;hFj;ubaubj)r;}r;(hEUhFj;hGhHhIjhK}r;(hP]hO]hM]hN]hR]Uentries]r;(jXMNView (module)X module-MNViewUNtr;auhTNhUhh@]ubhb)r;}r;(hEXThe *MNView* API is an optional API that may be implemented by Member Nodes that intend to support providing rendered views of content on their repository. Each repository can implement multipe themed views of their content, each accesed using the name of the theme and the identifier of the content to be viewed. Unlike the MNRead service, which returns the exact bytes of content, the MNView service provides a rendered view of the content which can transform the content into different formats. The most common use of the view service will likely be to provide a rendered HTML landing page at a well-known URL that can be used to provide a human-readable view of metadata and data. Other potential uses include providing alternative formats for metadata and data. Each Member Node that implements the MNView service must implement at least one theme named 'default' which provides the default view of all content. Other themes can be provided for use by various clients.hFj;hGhHhIhfhK}r;(hM]hN]hO]hP]hR]uhTKhUhh@]r;(h^XThe r;r;}r;(hEXThe hFj;ubj)r;}r;(hEX*MNView*hK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;h^XMNViewr;r;}r;(hEUhFj;ubahIjubh^X API is an optional API that may be implemented by Member Nodes that intend to support providing rendered views of content on their repository. Each repository can implement multipe themed views of their content, each accesed using the name of the theme and the identifier of the content to be viewed. Unlike the MNRead service, which returns the exact bytes of content, the MNView service provides a rendered view of the content which can transform the content into different formats. The most common use of the view service will likely be to provide a rendered HTML landing page at a well-known URL that can be used to provide a human-readable view of metadata and data. Other potential uses include providing alternative formats for metadata and data. Each Member Node that implements the MNView service must implement at least one theme named 'default' which provides the default view of all content. Other themes can be provided for use by various clients.r;r;}r;(hEX API is an optional API that may be implemented by Member Nodes that intend to support providing rendered views of content on their repository. Each repository can implement multipe themed views of their content, each accesed using the name of the theme and the identifier of the content to be viewed. Unlike the MNRead service, which returns the exact bytes of content, the MNView service provides a rendered view of the content which can transform the content into different formats. The most common use of the view service will likely be to provide a rendered HTML landing page at a well-known URL that can be used to provide a human-readable view of metadata and data. Other potential uses include providing alternative formats for metadata and data. Each Member Node that implements the MNView service must implement at least one theme named 'default' which provides the default view of all content. Other themes can be provided for use by various clients.hFj;ubeubh)r;}r;(hEXBWarning: this file is automatically generated. Edits will be losthFj;hGjX*source/apis/generated/generated_MNView.txtr;r;}r;bhIhhK}r;(hhhP]hO]hM]hN]hR]uhTKhUhh@]r;h^XBWarning: this file is automatically generated. Edits will be lostr;r;}r;(hEUhFj;ubaubj)r;}r;(hEUhFj;hGNhIjhK}r;(hM]hN]hO]hP]r;Uid5r;ahR]uhTNhUhh@]r;(hW)r;}r;(hEX"Functions defined in :mod:`MNView`hK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;(h^XFunctions defined in r;r;}r;(hEXFunctions defined in hFj;ubj)r;}r;(hEX :mod:`MNView`r;hFj;hGj;hIjhK}r;(UreftypeXmodjjXMNViewU refdomainXpyr;hP]hO]U refexplicithM]hN]hR]jjjNjXMNViewr;uhTKh@]r;j)r;}r;(hEj;hK}r;(hM]hN]r;(jj;Xpy-modr;ehO]hP]hR]uhFj;h@]r;h^XMNViewr;r;}r;(hEUhFj;ubahIjubaubehIh[ubj)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolsKuhFj;h@]r;(j#)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolwidthKuhFj;h@]hIj'ubj#)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolwidthKuhFj;h@]hIj'ubj#)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolwidthK uhFj;h@]hIj'ubj#)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolwidthK uhFj;h@]hIj'ubj#)r;}r;(hEUhK}r;(hP]hO]hM]hN]hR]UcolwidthKuhFj;h@]hIj'ubj4)r;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;j9)r;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;(j>)r;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;hb)r;}r;(hEXTierr;hFj;hGj;hIhfhK}r;(hM]hN]hO]hP]hR]uhTK h@]r;h^XTierr;r;}r;(hEj;hFj;ubaubahIjKubj>)r;}r;(hEUhK}r;(hM]hN]hO]hP]hR]uhFj;h@]r;hb)r;}r;(hEXVersionr;hFj;hGj;hIhfhK}r;(hM]hN]hO]hP]hR]uhTK h@]r<h^XVersionr<r<}r<(hEj;hFj;ubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj;h@]r<hb)r<}r <(hEXRESTr <hFj<hGj;hIhfhK}r <(hM]hN]hO]hP]hR]uhTK h@]r <h^XRESTr <r<}r<(hEj <hFj<ubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj;h@]r<hb)r<}r<(hEXFunctionr<hFj<hGj;hIhfhK}r<(hM]hN]hO]hP]hR]uhTK h@]r<h^XFunctionr<r<}r<(hEj<hFj<ubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj;h@]r<hb)r <}r!<(hEX Parametersr"<hFj<hGj;hIhfhK}r#<(hM]hN]hO]hP]hR]uhTK h@]r$<h^X Parametersr%<r&<}r'<(hEj"<hFj <ubaubahIjKubehIj|ubahIj}ubj~)r(<}r)<(hEUhK}r*<(hM]hN]hO]hP]hR]uhFj;h@]r+<(j9)r,<}r-<(hEUhK}r.<(hM]hN]hO]hP]hR]uhFj(<h@]r/<(j>)r0<}r1<(hEUhK}r2<(hM]hN]hO]hP]hR]uhFj,<h@]r3<hb)r4<}r5<(hEXTier 1r6<hFj0<hGj;hIhfhK}r7<(hM]hN]hO]hP]hR]uhTKh@]r8<h^XTier 1r9<r:<}r;<(hEj6<hFj4<ubaubahIjKubj>)r<<}r=<(hEUhK}r><(hM]hN]hO]hP]hR]uhFj,<h@]r?<hb)r@<}rA<(hEX1.2rB<hFj<<hGj;hIhfhK}rC<(hM]hN]hO]hP]hR]uhTKh@]rD<h^X1.2rE<rF<}rG<(hEjB<hFj@<ubaubahIjKubj>)rH<}rI<(hEUhK}rJ<(hM]hN]hO]hP]hR]uhFj,<h@]rK<hb)rL<}rM<(hEX``GET /views/{theme}/{pid}``rN<hFjH<hGj;hIhfhK}rO<(hM]hN]hO]hP]hR]uhTKh@]rP<j)rQ<}rR<(hEjN<hK}rS<(hM]hN]hO]hP]hR]uhFjL<h@]rT<h^XGET /views/{theme}/{pid}rU<rV<}rW<(hEUhFjQ<ubahIjubaubahIjKubj>)rX<}rY<(hEUhK}rZ<(hM]hN]hO]hP]hR]uhFj,<h@]r[<hb)r\<}r]<(hEX :func:`view`r^<hFjX<hGj;hIhfhK}r_<(hM]hN]hO]hP]hR]uhTKh@]r`<j)ra<}rb<(hEj^<hFj\<hGj;hIjhK}rc<(UreftypeXfuncjjXviewU refdomainXpyrd<hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]re<j)rf<}rg<(hEj^<hK}rh<(hM]hN]ri<(jjd<Xpy-funcrj<ehO]hP]hR]uhFja<h@]rk<h^Xview()rl<rm<}rn<(hEUhFjf<ubahIjubaubaubahIjKubj>)ro<}rp<(hEUhK}rq<(hM]hN]hO]hP]hR]uhFj,<h@]rr<hb)rs<}rt<(hEXm(:class:`session`, ``theme``, :class:`id`) ``->`` :class:`Types.OctetStream`ru<hFjo<hGj;hIhfhK}rv<(hM]hN]hO]hP]hR]uhTKh@]rw<(h^X(rx<}ry<(hEX(hFjs<ubj)rz<}r{<(hEX:class:`session`r|<hFjs<hGj;hIjhK}r}<(UreftypeXclassjjX Types.SessionU refdomainXpyr~<hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r<j)r<}r<(hEj|<hK}r<(hM]hN]r<(jj~<Xpy-classr<ehO]hP]hR]uhFjz<h@]r<h^Xsessionr<r<}r<(hEUhFj<ubahIjubaubh^X, r<r<}r<(hEX, hFjs<ubj)r<}r<(hEX ``theme``hK}r<(hM]hN]hO]hP]hR]uhFjs<h@]r<h^Xthemer<r<}r<(hEUhFj<ubahIjubh^X, r<r<}r<(hEX, hFjs<ubj)r<}r<(hEX:class:`id`r<hFjs<hGj;hIjhK}r<(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr<hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r<j)r<}r<(hEj<hK}r<(hM]hN]r<(jj<Xpy-classr<ehO]hP]hR]uhFj<h@]r<h^Xidr<r<}r<(hEUhFj<ubahIjubaubh^X) r<r<}r<(hEX) hFjs<ubj)r<}r<(hEX``->``hK}r<(hM]hN]hO]hP]hR]uhFjs<h@]r<h^X->r<r<}r<(hEUhFj<ubahIjubh^X r<}r<(hEX hFjs<ubj)r<}r<(hEX:class:`Types.OctetStream`r<hFjs<hGj;hIjhK}r<(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr<hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r<j)r<}r<(hEj<hK}r<(hM]hN]r<(jj<Xpy-classr<ehO]hP]hR]uhFj<h@]r<h^XTypes.OctetStreamr<r<}r<(hEUhFj<ubahIjubaubeubahIjKubehIj|ubj9)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj(<h@]r<(j>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj<h@]r<hb)r<}r<(hEXTier 1r<hFj<hGj;hIhfhK}r<(hM]hN]hO]hP]hR]uhTKh@]r<h^XTier 1r<r<}r<(hEj<hFj<ubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj<h@]r<hb)r<}r<(hEX1.2r<hFj<hGj;hIhfhK}r<(hM]hN]hO]hP]hR]uhTKh@]r<h^X1.2r<r<}r<(hEj<hFj<ubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj<h@]r<hb)r<}r<(hEX``GET /views``r<hFj<hGj;hIhfhK}r<(hM]hN]hO]hP]hR]uhTKh@]r<j)r<}r<(hEj<hK}r<(hM]hN]hO]hP]hR]uhFj<h@]r<h^X GET /viewsr<r<}r<(hEUhFj<ubahIjubaubahIjKubj>)r<}r<(hEUhK}r<(hM]hN]hO]hP]hR]uhFj<h@]r<hb)r<}r<(hEX:func:`listViews`r<hFj<hGj;hIhfhK}r<(hM]hN]hO]hP]hR]uhTKh@]r<j)r<}r<(hEj<hFj<hGj;hIjhK}r<(UreftypeXfuncjjX listViewsU refdomainXpyr<hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r<j)r<}r<(hEj<hK}r<(hM]hN]r<(jj<Xpy-funcr<ehO]hP]hR]uhFj<h@]r<h^X listViews()r=r=}r=(hEUhFj<ubahIjubaubaubahIjKubj>)r=}r=(hEUhK}r=(hM]hN]hO]hP]hR]uhFj<h@]r=hb)r=}r=(hEXB(:class:`session`) ``->`` :class:`Types.OptionList`r =hFj=hGj;hIhfhK}r =(hM]hN]hO]hP]hR]uhTKh@]r =(h^X(r =}r =(hEX(hFj=ubj)r=}r=(hEX:class:`session`r=hFj=hGj;hIjhK}r=(UreftypeXclassjjX Types.SessionU refdomainXpyr=hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r=j)r=}r=(hEj=hK}r=(hM]hN]r=(jj=Xpy-classr=ehO]hP]hR]uhFj=h@]r=h^Xsessionr=r=}r=(hEUhFj=ubahIjubaubh^X) r=r=}r=(hEX) hFj=ubj)r =}r!=(hEX``->``hK}r"=(hM]hN]hO]hP]hR]uhFj=h@]r#=h^X->r$=r%=}r&=(hEUhFj =ubahIjubh^X r'=}r(=(hEX hFj=ubj)r)=}r*=(hEX:class:`Types.OptionList`r+=hFj=hGj;hIjhK}r,=(UreftypeXclassjjXTypes.OptionListU refdomainXpyr-=hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKh@]r.=j)r/=}r0=(hEj+=hK}r1=(hM]hN]r2=(jj-=Xpy-classr3=ehO]hP]hR]uhFj)=h@]r4=h^XTypes.OptionListr5=r6=}r7=(hEUhFj/=ubahIjubaubeubahIjKubehIj|ubehIjubehIjubeubj)r8=}r9=(hEUhFj;hGNhIjhK}r:=(hP]hO]hM]hN]hR]Uentries]r;=(jXview() (in module MNView)hUNtr<=auhTNhUhh@]ubj)r==}r>=(hEUhFj;hGNhIjhK}r?=(jjXpyr@=hP]hO]hM]hN]hR]jXfunctionrA=jjA=uhTNhUhh@]rB=(j)rC=}rD=(hEX%view(session,theme,id) -> OctetStreamhFj==hGj;hIjhK}rE=(hP]rF=hajj;hO]hM]hN]hR]rG=hajXviewrH=jUjuhTKDhUhh@]rI=(j)rJ=}rK=(hEXMNView.hFjC=hGj;hIjhK}rL=(hM]hN]hO]hP]hR]uhTKDhUhh@]rM=h^XMNView.rN=rO=}rP=(hEUhFjJ=ubaubj)rQ=}rR=(hEjH=hFjC=hGj;hIjhK}rS=(hM]hN]hO]hP]hR]uhTKDhUhh@]rT=h^XviewrU=rV=}rW=(hEUhFjQ=ubaubj)rX=}rY=(hEXsession, theme, idhFjC=hGj;hIjhK}rZ=(hM]hN]hO]hP]hR]uhTKDhUhh@]r[=(j)r\=}r]=(hEXsessionhK}r^=(hM]hN]hO]hP]hR]uhFjX=h@]r_=h^Xsessionr`=ra=}rb=(hEUhFj\=ubahIjubj)rc=}rd=(hEXthemehK}re=(hM]hN]hO]hP]hR]uhFjX=h@]rf=h^Xthemerg=rh=}ri=(hEUhFjc=ubahIjubj)rj=}rk=(hEXidhK}rl=(hM]hN]hO]hP]hR]uhFjX=h@]rm=h^Xidrn=ro=}rp=(hEUhFjj=ubahIjubeubj)rq=}rr=(hEX OctetStreamhFjC=hGj;hIjhK}rs=(hM]hN]hO]hP]hR]uhTKDhUhh@]rt=h^X OctetStreamru=rv=}rw=(hEUhFjq=ubaubeubj)rx=}ry=(hEUhFj==hGj;hIj hK}rz=(hM]hN]hO]hP]hR]uhTKDhUhh@]r{=(hb)r|=}r}=(hEXpProvides a formatted view of an object (science metadata, data, resource, or other) using the given named theme.r~=hFjx=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTKhUhh@]r=h^XpProvides a formatted view of an object (science metadata, data, resource, or other) using the given named theme.r=r=}r=(hEj~=hFj|=ubaubhb)r=}r=(hEXIf this service is implemented, the :func:`MNView.view` operation must implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format.hFjx=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTK hUhh@]r=(h^X$If this service is implemented, the r=r=}r=(hEX$If this service is implemented, the hFj=ubj)r=}r=(hEX:func:`MNView.view`r=hFj=hGj;hIjhK}r=(UreftypeXfuncjjX MNView.viewU refdomainXpyr=hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTK h@]r=j)r=}r=(hEj=hK}r=(hM]hN]r=(jj=Xpy-funcr=ehO]hP]hR]uhFj=h@]r=h^X MNView.view()r=r=}r=(hEUhFj=ubahIjubaubh^X operation must implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format.r=r=}r=(hEX operation must implement at least one {theme} named 'default' to provide a standard (possibly minimalistic) view of the content in HTML format.hFj=ubeubhb)r=}r=(hEXhIf 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.r=hFjx=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTK"hUhh@]r=h^XhIf 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.r=r=}r=(hEj=hFj=ubaubhb)r=}r=(hEXiThis method is optional for Member Nodes, but if implemented, MNView.listViews must also be implemented.r=hFjx=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTK$hUhh@]r=h^XiThis method is optional for Member Nodes, but if implemented, MNView.listViews must also be implemented.r=r=}r=(hEj=hFj=ubaubht)r=}r=(hEUhFjx=hGNhIhwhK}r=(hM]hN]hO]hP]hR]uhTNhUhh@]r=(hz)r=}r=(hEUhFj=hGj;hIh}hK}r=(hM]hN]hO]hP]hR]uhTK&hUhh@]r=(h)r=}r=(hEXVersionhFj=hGj;hIhhK}r=(hM]hN]hO]hP]hR]uhTKh@]r=h^XVersionr=r=}r=(hEUhFj=ubaubh)r=}r=(hEX1.2r=hK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=hb)r=}r=(hEj=hFj=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTK&h@]r=h^X1.2r=r=}r=(hEj=hFj=ubaubahIhubeubhz)r=}r=(hEUhFj=hGj;hIh}hK}r=(hM]hN]hO]hP]hR]uhTK'hUhh@]r=(h)r=}r=(hEXREST URLhFj=hGj;hIhhK}r=(hM]hN]hO]hP]hR]uhTKh@]r=h^XREST URLr=r=}r=(hEUhFj=ubaubh)r=}r=(hEX``GET /views/{theme}/{pid}``r=hK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=hb)r=}r=(hEj=hFj=hGj;hIhfhK}r=(hM]hN]hO]hP]hR]uhTK'h@]r=j)r=}r=(hEj=hK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=h^XGET /views/{theme}/{pid}r=r=}r=(hEUhFj=ubahIjubaubahIhubeubhz)r=}r=(hEUhK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=(h)r=}r=(hEX ParametershFj=hGj;hIhhK}r=(hM]hN]hO]hP]hR]uhTKh@]r=h^X Parametersr=r=}r=(hEUhFj=ubaubh)r=}r=(hEUhK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=j)r=}r=(hEUhK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=(j)r=}r=(hEUhK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=hb)r=}r=(hEXTsession (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.hK}r=(hM]hN]hO]hP]hR]uhFj=h@]r=(j)r=}r=(hEXsessionhK}r>(hP]hO]jhM]hN]hR]uhFj=h@]r>h^Xsessionr>r>}r>(hEUhFj=ubahIjubh^X (r>r>}r>(hEUhFj=ubj)r>}r >(hEX:class:`Types.Session`r >hFj=hGj;hIjhK}r >(UreftypeXclassjjX Types.SessionU refdomainXpyr >hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTK)h@]r >j)r>}r>(hEj >hK}r>(hM]hN]r>(jj >Xpy-classr>ehO]hP]hR]uhFj>h@]r>h^X Types.Sessionr>r>}r>(hEUhFj>ubahIjubaubh^X)r>}r>(hEUhFj=ubh^X -- r>r>}r>(hEUhFj=ubh^XSession 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>(hEXSession 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 hFj=ubj)r>}r >(hEX:term:`public user`r!>hFj=hGj;hIjhK}r">(UreftypeXtermjjX public userU refdomainXstdr#>hP]hO]U refexplicithM]hN]hR]jjuhTK(h@]r$>jr)r%>}r&>(hEj!>hK}r'>(hM]hN]r(>(jj#>Xstd-termr)>ehO]hP]hR]uhFj>h@]r*>h^X public userr+>r,>}r->(hEUhFj%>ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r.>r/>}r0>(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj=ubehIhfubahIjubj)r1>}r2>(hEUhK}r3>(hM]hN]hO]hP]hR]uhFj=h@]r4>hb)r5>}r6>(hEX'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.hK}r7>(hM]hN]hO]hP]hR]uhFj1>h@]r8>(j)r9>}r:>(hEXthemehK}r;>(hP]hO]jhM]hN]hR]uhFj5>h@]r<>h^Xthemer=>r>>}r?>(hEUhFj9>ubahIjubh^X (r@>rA>}rB>(hEUhFj5>ubj)rC>}rD>(hEUhK}rE>(UreftypejjU reftargetXstringrF>U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFj5>h@]rG>j)rH>}rI>(hEjF>hK}rJ>(hM]hN]hO]hP]hR]uhFjC>h@]rK>h^XstringrL>rM>}rN>(hEUhFjH>ubahIjubahIjubh^X)rO>}rP>(hEUhFj5>ubh^X -- rQ>rR>}rS>(hEUhFj5>ubh^XIndicates 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.rT>rU>}rV>(hEXIndicates 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.rW>hFj5>ubehIhfubahIjubj)rX>}rY>(hEUhK}rZ>(hM]hN]hO]hP]hR]uhFj=h@]r[>hb)r\>}r]>(hEXid (Types.Identifier) -- The identifier of the object to render in a view. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.hK}r^>(hM]hN]hO]hP]hR]uhFjX>h@]r_>(j)r`>}ra>(hEXidhK}rb>(hP]hO]jhM]hN]hR]uhFj\>h@]rc>h^Xidrd>re>}rf>(hEUhFj`>ubahIjubh^X (rg>rh>}ri>(hEUhFj\>ubj)rj>}rk>(hEX:class:`Types.Identifier`rl>hFj\>hGj;hIjhK}rm>(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrn>hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTK/h@]ro>j)rp>}rq>(hEjl>hK}rr>(hM]hN]rs>(jjn>Xpy-classrt>ehO]hP]hR]uhFjj>h@]ru>h^XTypes.Identifierrv>rw>}rx>(hEUhFjp>ubahIjubaubh^X)ry>}rz>(hEUhFj\>ubh^X -- r{>r|>}r}>(hEUhFj\>ubh^XThe identifier of the object to render in a view. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.r~>r>}r>(hEXThe identifier of the object to render in a view. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.r>hFj\>ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj=h@]r>(h)r>}r>(hEXReturnshFj>hGj;hIhhK}r>(hM]hN]hO]hP]hR]uhTKh@]r>h^XReturnsr>r>}r>(hEUhFj>ubaubh)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>hb)r>}r>(hEXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>h^XAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.r>r>}r>(hEXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested theme.r>hFj>ubahIhfubahIhubehIh}ubhz)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj=h@]r>(h)r>}r>(hEX Return typehFj>hGj;hIhhK}r>(hM]hN]hO]hP]hR]uhTKh@]r>h^X Return typer>r>}r>(hEUhFj>ubaubh)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>hb)r>}r>(hEXTypes.OctetStreamhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>j)r>}r>(hEX:class:`Types.OctetStream`r>hFj>hGj;hIjhK}r>(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyr>hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTK2h@]r>j)r>}r>(hEj>hK}r>(hM]hN]r>(jj>Xpy-classr>ehO]hP]hR]uhFj>h@]r>h^XTypes.OctetStreamr>r>}r>(hEUhFj>ubahIjubaubahIhfubahIhubehIh}ubhz)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj=h@]r>(h)r>}r>(hEXRaiseshFj>hGj;hIhhK}r>(hM]hN]hO]hP]hR]uhTKh@]r>h^XRaisesr>r>}r>(hEUhFj>ubaubh)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>j)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>(j)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>hb)r>}r>(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2830)hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>(j)r>}r>(hEUhK}r>(UreftypejjU reftargetXExceptions.InvalidTokenr>U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFj>h@]r>j)r>}r>(hEj>hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>h^XExceptions.InvalidTokenr>r>}r>(hEUhFj>ubahIjubahIjubh^X -- r>r>}r>(hEUhFj>ubj)r>}r>(hEX$``(errorCode=401, detailCode=2830)``r>hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>h^X (errorCode=401, detailCode=2830)r>r>}r>(hEUhFj>ubahIjubehIhfubahIjubj)r>}r>(hEUhK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>hb)r>}r>(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2831)hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>(j)r>}r>(hEUhK}r>(UreftypejjU reftargetXExceptions.ServiceFailurer>U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFj>h@]r>j)r>}r>(hEj>hK}r>(hM]hN]hO]hP]hR]uhFj>h@]r>h^XExceptions.ServiceFailurer>r>}r?(hEUhFj>ubahIjubahIjubh^X -- r?r?}r?(hEUhFj>ubj)r?}r?(hEX$``(errorCode=500, detailCode=2831)``r?hK}r?(hM]hN]hO]hP]hR]uhFj>h@]r?h^X (errorCode=500, detailCode=2831)r ?r ?}r ?(hEUhFj?ubahIjubehIhfubahIjubj)r ?}r ?(hEUhK}r?(hM]hN]hO]hP]hR]uhFj>h@]r?hb)r?}r?(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2832)hK}r?(hM]hN]hO]hP]hR]uhFj ?h@]r?(j)r?}r?(hEUhK}r?(UreftypejjU reftargetXExceptions.NotAuthorizedr?U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFj?h@]r?j)r?}r?(hEj?hK}r?(hM]hN]hO]hP]hR]uhFj?h@]r?h^XExceptions.NotAuthorizedr?r?}r?(hEUhFj?ubahIjubahIjubh^X -- r ?r!?}r"?(hEUhFj?ubj)r#?}r$?(hEX$``(errorCode=401, detailCode=2832)``r%?hK}r&?(hM]hN]hO]hP]hR]uhFj?h@]r'?h^X (errorCode=401, detailCode=2832)r(?r)?}r*?(hEUhFj#?ubahIjubehIhfubahIjubj)r+?}r,?(hEUhK}r-?(hM]hN]hO]hP]hR]uhFj>h@]r.?hb)r/?}r0?(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2833)hK}r1?(hM]hN]hO]hP]hR]uhFj+?h@]r2?(j)r3?}r4?(hEUhK}r5?(UreftypejjU reftargetXExceptions.InvalidRequestr6?U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFj/?h@]r7?j)r8?}r9?(hEj6?hK}r:?(hM]hN]hO]hP]hR]uhFj3?h@]r;?h^XExceptions.InvalidRequestr?(hEUhFj8?ubahIjubahIjubh^X -- r??r@?}rA?(hEUhFj/?ubj)rB?}rC?(hEX$``(errorCode=400, detailCode=2833)``rD?hK}rE?(hM]hN]hO]hP]hR]uhFj/?h@]rF?h^X (errorCode=400, detailCode=2833)rG?rH?}rI?(hEUhFjB?ubahIjubehIhfubahIjubj)rJ?}rK?(hEUhK}rL?(hM]hN]hO]hP]hR]uhFj>h@]rM?hb)rN?}rO?(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2834)hK}rP?(hM]hN]hO]hP]hR]uhFjJ?h@]rQ?(j)rR?}rS?(hEUhK}rT?(UreftypejjU reftargetXExceptions.NotImplementedrU?U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFjN?h@]rV?j)rW?}rX?(hEjU?hK}rY?(hM]hN]hO]hP]hR]uhFjR?h@]rZ?h^XExceptions.NotImplementedr[?r\?}r]?(hEUhFjW?ubahIjubahIjubh^X -- r^?r_?}r`?(hEUhFjN?ubj)ra?}rb?(hEX$``(errorCode=501, detailCode=2834)``rc?hK}rd?(hM]hN]hO]hP]hR]uhFjN?h@]re?h^X (errorCode=501, detailCode=2834)rf?rg?}rh?(hEUhFja?ubahIjubehIhfubahIjubj)ri?}rj?(hEUhK}rk?(hM]hN]hO]hP]hR]uhFj>h@]rl?hb)rm?}rn?(hEXXExceptions.NotFound -- (errorCode=404, detailCode=2835)The specified pid does not exist.hK}ro?(hM]hN]hO]hP]hR]uhFji?h@]rp?(j)rq?}rr?(hEUhK}rs?(UreftypejjU reftargetXExceptions.NotFoundrt?U refdomainj@=hP]hO]U refexplicithM]hN]hR]uhFjm?h@]ru?j)rv?}rw?(hEjt?hK}rx?(hM]hN]hO]hP]hR]uhFjq?h@]ry?h^XExceptions.NotFoundrz?r{?}r|?(hEUhFjv?ubahIjubahIjubh^X -- r}?r~?}r?(hEUhFjm?ubhb)r?}r?(hEX$``(errorCode=404, detailCode=2835)``r?hFjm?hGj;hIhfhK}r?(hM]hN]hO]hP]hR]uhTK>h@]r?j)r?}r?(hEj?hK}r?(hM]hN]hO]hP]hR]uhFj?h@]r?h^X (errorCode=404, detailCode=2835)r?r?}r?(hEUhFj?ubahIjubaubhb)r?}r?(hEX!The specified pid does not exist.r?hFjm?hGj;hIhfhK}r?(hM]hN]hO]hP]hR]uhTK@h@]r?h^X!The specified pid does not exist.r?r?}r?(hEj?hFj?ubaubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r?}r?(hEUhFj;hGNhIjhK}r?(hP]hO]hM]hN]hR]Uentries]r?(jXlistViews() (in module MNView)hUNtr?auhTNhUhh@]ubj)r?}r?(hEUhFj;hGNhIjhK}r?(jjXpyr?hP]hO]hM]hN]hR]jXfunctionr?jj?uhTNhUhh@]r?(j)r?}r?(hEX listViews(session) -> OptionListhFj?hGXAinternal padding after source/apis/generated/generated_MNView.txtr?hIjhK}r?(hP]r?hajj;hO]hM]hN]hR]r?hajX listViewsr?jUjuhTK^hUhh@]r?(j)r?}r?(hEXMNView.hFj?hGj?hIjhK}r?(hM]hN]hO]hP]hR]uhTK^hUhh@]r?h^XMNView.r?r?}r?(hEUhFj?ubaubj)r?}r?(hEj?hFj?hGj?hIjhK}r?(hM]hN]hO]hP]hR]uhTK^hUhh@]r?h^X listViewsr?r?}r?(hEUhFj?ubaubj)r?}r?(hEXsessionhFj?hGj?hIjhK}r?(hM]hN]hO]hP]hR]uhTK^hUhh@]r?j)r?}r?(hEXsessionhK}r?(hM]hN]hO]hP]hR]uhFj?h@]r?h^Xsessionr?r?}r?(hEUhFj?ubahIjubaubj)r?}r?(hEX OptionListhFj?hGj?hIjhK}r?(hM]hN]hO]hP]hR]uhTK^hUhh@]r?h^X OptionListr?r?}r?(hEUhFj?ubaubeubj)r?}r?(hEUhFj?hGj?hIj hK}r?(hM]hN]hO]hP]hR]uhTK^hUhh@]r?(hb)r?}r?(hEXJProvides 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?hFj?hGj;hIhfhK}r?(hM]hN]hO]hP]hR]uhTKGhUhh@]r?h^XJProvides 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?(hEj?hFj?ubaubhb)r?}r?(hEXdThis method is optional for Member Nodes, but if implemented, MNView.view must also be implemented.r?hFj?hGj;hIhfhK}r?(hM]hN]hO]hP]hR]uhTKIhUhh@]r?h^XdThis method is optional for Member Nodes, but if implemented, MNView.view must also be implemented.r?r?}r?(hEj?hFj?ubaubht)r?}r?(hEUhFj?hGNhIhwhK}r?(hM]hN]hO]hP]hR]uhTNhUhh@]r?(hz)r?}r?(hEUhFj?hGj;hIh}hK}r?(hM]hN]hO]hP]hR]uhTKKhUhh@]r?(h)r?}r?(hEXVersionhFj?hGj;hIhhK}r?(hM]hN]hO]hP]hR]uhTKh@]r?h^XVersionr?r?}r?(hEUhFj?ubaubh)r?}r?(hEX1.2r?hK}r?(hM]hN]hO]hP]hR]uhFj?h@]r?hb)r?}r?(hEj?hFj?hGj;hIhfhK}r?(hM]hN]hO]hP]hR]uhTKKh@]r?h^X1.2r?r?}r?(hEj?hFj?ubaubahIhubeubhz)r?}r?(hEUhFj?hGj;hIh}hK}r?(hM]hN]hO]hP]hR]uhTKLhUhh@]r?(h)r?}r?(hEXREST URLhFj?hGj;hIhhK}r?(hM]hN]hO]hP]hR]uhTKh@]r?h^XREST URLr?r?}r@(hEUhFj?ubaubh)r@}r@(hEX``GET /views``r@hK}r@(hM]hN]hO]hP]hR]uhFj?h@]r@hb)r@}r@(hEj@hFj@hGj;hIhfhK}r@(hM]hN]hO]hP]hR]uhTKLh@]r @j)r @}r @(hEj@hK}r @(hM]hN]hO]hP]hR]uhFj@h@]r @h^X GET /viewsr@r@}r@(hEUhFj @ubahIjubaubahIhubeubhz)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj?h@]r@(h)r@}r@(hEX ParametershFj@hGj?hIhhK}r@(hM]hN]hO]hP]hR]uhTKh@]r@h^X Parametersr@r@}r@(hEUhFj@ubaubh)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@hb)r @}r!@(hEXTsession (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.hK}r"@(hM]hN]hO]hP]hR]uhFj@h@]r#@(j)r$@}r%@(hEXsessionhK}r&@(hP]hO]jhM]hN]hR]uhFj @h@]r'@h^Xsessionr(@r)@}r*@(hEUhFj$@ubahIjubh^X (r+@r,@}r-@(hEUhFj @ubj)r.@}r/@(hEX:class:`Types.Session`r0@hFj @hGj;hIjhK}r1@(UreftypeXclassjjX Types.SessionU refdomainXpyr2@hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKNh@]r3@j)r4@}r5@(hEj0@hK}r6@(hM]hN]r7@(jj2@Xpy-classr8@ehO]hP]hR]uhFj.@h@]r9@h^X Types.Sessionr:@r;@}r<@(hEUhFj4@ubahIjubaubh^X)r=@}r>@(hEUhFj @ubh^X -- r?@r@@}rA@(hEUhFj @ubh^XSession 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 rB@rC@}rD@(hEXSession 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 hFj @ubj)rE@}rF@(hEX:term:`public user`rG@hFj @hGj;hIjhK}rH@(UreftypeXtermjjX public userU refdomainXstdrI@hP]hO]U refexplicithM]hN]hR]jjuhTKMh@]rJ@jr)rK@}rL@(hEjG@hK}rM@(hM]hN]rN@(jjI@Xstd-termrO@ehO]hP]hR]uhFjE@h@]rP@h^X public userrQ@rR@}rS@(hEUhFjK@ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rT@rU@}rV@(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj @ubehIhfubahIhubehIh}ubhz)rW@}rX@(hEUhK}rY@(hM]hN]hO]hP]hR]uhFj?h@]rZ@(h)r[@}r\@(hEXReturnshFjW@hGj?hIhhK}r]@(hM]hN]hO]hP]hR]uhTKh@]r^@h^XReturnsr_@r`@}ra@(hEUhFj[@ubaubh)rb@}rc@(hEUhK}rd@(hM]hN]hO]hP]hR]uhFjW@h@]re@hb)rf@}rg@(hEXIA list of available themes that can be used with the MNView.view service.hK}rh@(hM]hN]hO]hP]hR]uhFjb@h@]ri@h^XIA list of available themes that can be used with the MNView.view service.rj@rk@}rl@(hEXIA list of available themes that can be used with the MNView.view service.hFjf@ubahIhfubahIhubehIh}ubhz)rm@}rn@(hEUhK}ro@(hM]hN]hO]hP]hR]uhFj?h@]rp@(h)rq@}rr@(hEX Return typehFjm@hGj?hIhhK}rs@(hM]hN]hO]hP]hR]uhTKh@]rt@h^X Return typeru@rv@}rw@(hEUhFjq@ubaubh)rx@}ry@(hEUhK}rz@(hM]hN]hO]hP]hR]uhFjm@h@]r{@hb)r|@}r}@(hEXTypes.OptionListhK}r~@(hM]hN]hO]hP]hR]uhFjx@h@]r@j)r@}r@(hEX:class:`Types.OptionList`r@hFj|@hGj;hIjhK}r@(UreftypeXclassjjXTypes.OptionListU refdomainXpyr@hP]hO]U refexplicithM]hN]hR]jjjNjj;uhTKQh@]r@j)r@}r@(hEj@hK}r@(hM]hN]r@(jj@Xpy-classr@ehO]hP]hR]uhFj@h@]r@h^XTypes.OptionListr@r@}r@(hEUhFj@ubahIjubaubahIhfubahIhubehIh}ubhz)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj?h@]r@(h)r@}r@(hEXRaiseshFj@hGj?hIhhK}r@(hM]hN]hO]hP]hR]uhTKh@]r@h^XRaisesr@r@}r@(hEUhFj@ubaubh)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@j)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@(j)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@hb)r@}r@(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2840)hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@(j)r@}r@(hEUhK}r@(UreftypejjU reftargetXExceptions.InvalidTokenr@U refdomainj?hP]hO]U refexplicithM]hN]hR]uhFj@h@]r@j)r@}r@(hEj@hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^XExceptions.InvalidTokenr@r@}r@(hEUhFj@ubahIjubahIjubh^X -- r@r@}r@(hEUhFj@ubj)r@}r@(hEX$``(errorCode=401, detailCode=2840)``hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^X (errorCode=401, detailCode=2840)r@r@}r@(hEUhFj@ubahIjubehIhfubahIjubj)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@hb)r@}r@(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2841)hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@(j)r@}r@(hEUhK}r@(UreftypejjU reftargetXExceptions.ServiceFailurer@U refdomainj?hP]hO]U refexplicithM]hN]hR]uhFj@h@]r@j)r@}r@(hEj@hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^XExceptions.ServiceFailurer@r@}r@(hEUhFj@ubahIjubahIjubh^X -- r@r@}r@(hEUhFj@ubj)r@}r@(hEX$``(errorCode=500, detailCode=2841)``hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^X (errorCode=500, detailCode=2841)r@r@}r@(hEUhFj@ubahIjubehIhfubahIjubj)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@hb)r@}r@(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2842)hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@(j)r@}r@(hEUhK}r@(UreftypejjU reftargetXExceptions.NotAuthorizedr@U refdomainj?hP]hO]U refexplicithM]hN]hR]uhFj@h@]r@j)r@}r@(hEj@hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^XExceptions.NotAuthorizedr@r@}r@(hEUhFj@ubahIjubahIjubh^X -- r@r@}r@(hEUhFj@ubj)r@}r@(hEX$``(errorCode=401, detailCode=2842)``hK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@h^X (errorCode=401, detailCode=2842)r@r@}r@(hEUhFj@ubahIjubehIhfubahIjubj)r@}r@(hEUhK}r@(hM]hN]hO]hP]hR]uhFj@h@]r@hb)rA}rA(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2843)hK}rA(hM]hN]hO]hP]hR]uhFj@h@]rA(j)rA}rA(hEUhK}rA(UreftypejjU reftargetXExceptions.InvalidRequestrAU refdomainj?hP]hO]U refexplicithM]hN]hR]uhFjAh@]rAj)r A}r A(hEjAhK}r A(hM]hN]hO]hP]hR]uhFjAh@]r Ah^XExceptions.InvalidRequestr ArA}rA(hEUhFj AubahIjubahIjubh^X -- rArA}rA(hEUhFjAubj)rA}rA(hEX$``(errorCode=400, detailCode=2843)``hK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAh^X (errorCode=400, detailCode=2843)rArA}rA(hEUhFjAubahIjubehIhfubahIjubj)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFj@h@]rAhb)rA}rA(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2844)hK}r A(hM]hN]hO]hP]hR]uhFjAh@]r!A(j)r"A}r#A(hEUhK}r$A(UreftypejjU reftargetXExceptions.NotImplementedr%AU refdomainj?hP]hO]U refexplicithM]hN]hR]uhFjAh@]r&Aj)r'A}r(A(hEj%AhK}r)A(hM]hN]hO]hP]hR]uhFj"Ah@]r*Ah^XExceptions.NotImplementedr+Ar,A}r-A(hEUhFj'AubahIjubahIjubh^X -- r.Ar/A}r0A(hEUhFjAubj)r1A}r2A(hEX$``(errorCode=501, detailCode=2844)``hK}r3A(hM]hN]hO]hP]hR]uhFjAh@]r4Ah^X (errorCode=501, detailCode=2844)r5Ar6A}r7A(hEUhFj1AubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubeubhB)r8A}r9A(hEUhFhChGhHhIhJhK}r:A(hM]hN]hO]hP]r;A(Xmodule-MNPackagerA(hW)r?A}r@A(hEX Package APIrAAhFj8AhGhHhIh[hK}rBA(hM]hN]hO]hP]hR]uhTKhUhh@]rCAh^X Package APIrDArEA}rFA(hEjAAhFj?Aubaubj)rGA}rHA(hEUhFj8AhGhHhIjhK}rIA(hP]hO]hM]hN]hR]Uentries]rJA(jXMNPackage (module)Xmodule-MNPackageUNtrKAauhTNhUhh@]ubhb)rLA}rMA(hEXThe *MNPackage* API is an optional API that may be implemented by Member Nodes that intend to support downloading all of the contents of a data package in a single API call. Without this service, a client application must individually retrieve each of the metadata and data components of a package as they are listed in the ORE document that describes the package. Using the MNPackage service, a caller can instead request a serialized form of all of the data in a package, which is returned in the format requested. All implementations must support the BagIt format specification, but may also support additional well-defined packaging standards and specifications.hFj8AhGhHhIhfhK}rNA(hM]hN]hO]hP]hR]uhTKhUhh@]rOA(h^XThe rPArQA}rRA(hEXThe hFjLAubj)rSA}rTA(hEX *MNPackage*hK}rUA(hM]hN]hO]hP]hR]uhFjLAh@]rVAh^X MNPackagerWArXA}rYA(hEUhFjSAubahIjubh^X API is an optional API that may be implemented by Member Nodes that intend to support downloading all of the contents of a data package in a single API call. Without this service, a client application must individually retrieve each of the metadata and data components of a package as they are listed in the ORE document that describes the package. Using the MNPackage service, a caller can instead request a serialized form of all of the data in a package, which is returned in the format requested. All implementations must support the BagIt format specification, but may also support additional well-defined packaging standards and specifications.rZAr[A}r\A(hEX API is an optional API that may be implemented by Member Nodes that intend to support downloading all of the contents of a data package in a single API call. Without this service, a client application must individually retrieve each of the metadata and data components of a package as they are listed in the ORE document that describes the package. Using the MNPackage service, a caller can instead request a serialized form of all of the data in a package, which is returned in the format requested. All implementations must support the BagIt format specification, but may also support additional well-defined packaging standards and specifications.hFjLAubeubh)r]A}r^A(hEXBWarning: this file is automatically generated. Edits will be losthFj8AhGjX-source/apis/generated/generated_MNPackage.txtr_Ar`A}raAbhIhhK}rbA(hhhP]hO]hM]hN]hR]uhTKhUhh@]rcAh^XBWarning: this file is automatically generated. Edits will be lostrdAreA}rfA(hEUhFj]Aubaubj)rgA}rhA(hEUhFj8AhGNhIjhK}riA(hM]hN]hO]hP]rjAUid6rkAahR]uhTNhUhh@]rlA(hW)rmA}rnA(hEX%Functions defined in :mod:`MNPackage`hK}roA(hM]hN]hO]hP]hR]uhFjgAh@]rpA(h^XFunctions defined in rqArrA}rsA(hEXFunctions defined in hFjmAubj)rtA}ruA(hEX:mod:`MNPackage`rvAhFjmAhGj`AhIjhK}rwA(UreftypeXmodjjX MNPackageU refdomainXpyrxAhP]hO]U refexplicithM]hN]hR]jjjNjX MNPackageryAuhTKh@]rzAj)r{A}r|A(hEjvAhK}r}A(hM]hN]r~A(jjxAXpy-modrAehO]hP]hR]uhFjtAh@]rAh^X MNPackagerArA}rA(hEUhFj{AubahIjubaubehIh[ubj)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolsKuhFjgAh@]rA(j#)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolwidthKuhFjAh@]hIj'ubj#)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolwidthKuhFjAh@]hIj'ubj#)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolwidthK uhFjAh@]hIj'ubj#)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolwidthK uhFjAh@]hIj'ubj#)rA}rA(hEUhK}rA(hP]hO]hM]hN]hR]UcolwidthKuhFjAh@]hIj'ubj4)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAj9)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rA(j>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEXTierrAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTK h@]rAh^XTierrArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEXVersionrAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTK h@]rAh^XVersionrArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEXRESTrAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTK h@]rAh^XRESTrArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEXFunctionrAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTK h@]rAh^XFunctionrArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEX ParametersrAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTK h@]rAh^X ParametersrArA}rA(hEjAhFjAubaubahIjKubehIj|ubahIj}ubj~)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAj9)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rA(j>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEXTier 1rAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTKh@]rAh^XTier 1rArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rA(hEX1.2rAhFjAhGj`AhIhfhK}rA(hM]hN]hO]hP]hR]uhTKh@]rAh^X1.2rArA}rA(hEjAhFjAubaubahIjKubj>)rA}rA(hEUhK}rA(hM]hN]hO]hP]hR]uhFjAh@]rAhb)rA}rB(hEX%``GET /packages/{packageType}/{pid}``rBhFjAhGj`AhIhfhK}rB(hM]hN]hO]hP]hR]uhTKh@]rBj)rB}rB(hEjBhK}rB(hM]hN]hO]hP]hR]uhFjAh@]rBh^X!GET /packages/{packageType}/{pid}rBr B}r B(hEUhFjBubahIjubaubahIjKubj>)r B}r B(hEUhK}r B(hM]hN]hO]hP]hR]uhFjAh@]rBhb)rB}rB(hEX:func:`getPackage`rBhFj BhGj`AhIhfhK}rB(hM]hN]hO]hP]hR]uhTKh@]rBj)rB}rB(hEjBhFjBhGj`AhIjhK}rB(UreftypeXfuncjjX getPackageU refdomainXpyrBhP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTKh@]rBj)rB}rB(hEjBhK}rB(hM]hN]rB(jjBXpy-funcrBehO]hP]hR]uhFjBh@]rBh^X getPackage()rBr B}r!B(hEUhFjBubahIjubaubaubahIjKubj>)r"B}r#B(hEUhK}r$B(hM]hN]hO]hP]hR]uhFjAh@]r%Bhb)r&B}r'B(hEX(:class:`session`, :class:`packageType`, :class:`id`) ``->`` :class:`Types.OctetStream`hFj"BhGj`AhIhfhK}r(B(hM]hN]hO]hP]hR]uhTKh@]r)B(h^X(r*B}r+B(hEX(hFj&Bubj)r,B}r-B(hEX:class:`session`r.BhFj&BhGj`AhIjhK}r/B(UreftypeXclassjjX Types.SessionU refdomainXpyr0BhP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTKh@]r1Bj)r2B}r3B(hEj.BhK}r4B(hM]hN]r5B(jj0BXpy-classr6BehO]hP]hR]uhFj,Bh@]r7Bh^Xsessionr8Br9B}r:B(hEUhFj2BubahIjubaubh^X, r;BrB}r?B(hEX2:class:`packageType`r@BhFj&BhGj`AhIjhK}rAB(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrBBhP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTKh@]rCBj)rDB}rEB(hEj@BhK}rFB(hM]hN]rGB(jjBBXpy-classrHBehO]hP]hR]uhFj>Bh@]rIBh^X packageTyperJBrKB}rLB(hEUhFjDBubahIjubaubh^X, rMBrNB}rOB(hEX, hFj&Bubj)rPB}rQB(hEX:class:`id`rRBhFj&BhGj`AhIjhK}rSB(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrTBhP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTKh@]rUBj)rVB}rWB(hEjRBhK}rXB(hM]hN]rYB(jjTBXpy-classrZBehO]hP]hR]uhFjPBh@]r[Bh^Xidr\Br]B}r^B(hEUhFjVBubahIjubaubh^X) r_Br`B}raB(hEX) hFj&Bubj)rbB}rcB(hEX``->``hK}rdB(hM]hN]hO]hP]hR]uhFj&Bh@]reBh^X->rfBrgB}rhB(hEUhFjbBubahIjubh^X riB}rjB(hEX hFj&Bubj)rkB}rlB(hEX:class:`Types.OctetStream`rmBhFj&BhGj`AhIjhK}rnB(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyroBhP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTKh@]rpBj)rqB}rrB(hEjmBhK}rsB(hM]hN]rtB(jjoBXpy-classruBehO]hP]hR]uhFjkBh@]rvBh^XTypes.OctetStreamrwBrxB}ryB(hEUhFjqBubahIjubaubeubahIjKubehIj|ubahIjubehIjubeubj)rzB}r{B(hEUhFj8AhGNhIjhK}r|B(hP]hO]hM]hN]hR]Uentries]r}B(jX"getPackage() (in module MNPackage)hUNtr~BauhTNhUhh@]ubj)rB}rB(hEUhFj8AhGNhIjhK}rB(jjXpyrBhP]hO]hM]hN]hR]jXfunctionrBjjBuhTNhUhh@]rB(j)rB}rB(hEX1getPackage(session,packageType,id) -> OctetStreamhFjBhGXDinternal padding after source/apis/generated/generated_MNPackage.txtrBhIjhK}rB(hP]rBhajjyAhO]hM]hN]hR]rBhajX getPackagerBjUjuhTKCr?C}r@C(hEUhFj8CubahIjubaubh^X)rAC}rBC(hEUhFj$Cubh^X -- rCCrDC}rEC(hEUhFj$Cubh^XSession 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 rFCrGC}rHC(hEXSession 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 hFj$Cubj)rIC}rJC(hEX:term:`public user`rKChFj$ChGj`AhIjhK}rLC(UreftypeXtermjjX public userU refdomainXstdrMChP]hO]U refexplicithM]hN]hR]jjuhTK!h@]rNCjr)rOC}rPC(hEjKChK}rQC(hM]hN]rRC(jjMCXstd-termrSCehO]hP]hR]uhFjICh@]rTCh^X public userrUCrVC}rWC(hEUhFjOCubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rXCrYC}rZC(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj$CubehIhfubahIjubj)r[C}r\C(hEUhK}r]C(hM]hN]hO]hP]hR]uhFjCh@]r^Chb)r_C}r`C(hEXDpackageType (Types.ObjectFormatIdentifier) -- Indicates which package format will be used to serialize the package. All implementations must support a default BagIt package serialization, but are free to implement additional package serialization formats. Transmitted as part of the URL path and must be escaped accordingly.hK}raC(hM]hN]hO]hP]hR]uhFj[Ch@]rbC(j)rcC}rdC(hEX packageTypehK}reC(hP]hO]jhM]hN]hR]uhFj_Ch@]rfCh^X packageTypergCrhC}riC(hEUhFjcCubahIjubh^X (rjCrkC}rlC(hEUhFj_Cubj)rmC}rnC(hEX%:class:`Types.ObjectFormatIdentifier`roChFj_ChGj`AhIjhK}rpC(UreftypeXclassjjXTypes.ObjectFormatIdentifierU refdomainXpyrqChP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTK%h@]rrCj)rsC}rtC(hEjoChK}ruC(hM]hN]rvC(jjqCXpy-classrwCehO]hP]hR]uhFjmCh@]rxCh^XTypes.ObjectFormatIdentifierryCrzC}r{C(hEUhFjsCubahIjubaubh^X)r|C}r}C(hEUhFj_Cubh^X -- r~CrC}rC(hEUhFj_Cubh^XIndicates which package format will be used to serialize the package. All implementations must support a default BagIt package serialization, but are free to implement additional package serialization formats. Transmitted as part of the URL path and must be escaped accordingly.rCrC}rC(hEXIndicates which package format will be used to serialize the package. All implementations must support a default BagIt package serialization, but are free to implement additional package serialization formats. Transmitted as part of the URL path and must be escaped accordingly.hFj_CubehIhfubahIjubj)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rChb)rC}rC(hEXid (Types.Identifier) -- The identifier of the package or object in a package to be returned as a serialized package. Transmitted as part of the URL path and must be escaped accordingly.hK}rC(hM]hN]hO]hP]hR]uhFjCh@]rC(j)rC}rC(hEXidhK}rC(hP]hO]jhM]hN]hR]uhFjCh@]rCh^XidrCrC}rC(hEUhFjCubahIjubh^X (rCrC}rC(hEUhFjCubj)rC}rC(hEX:class:`Types.Identifier`rChFjChGj`AhIjhK}rC(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrChP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTK(h@]rCj)rC}rC(hEjChK}rC(hM]hN]rC(jjCXpy-classrCehO]hP]hR]uhFjCh@]rCh^XTypes.IdentifierrCrC}rC(hEUhFjCubahIjubaubh^X)rC}rC(hEUhFjCubh^X -- rCrC}rC(hEUhFjCubh^XThe identifier of the package or object in a package to be returned as a serialized package. Transmitted as part of the URL path and must be escaped accordingly.rCrC}rC(hEXThe identifier of the package or object in a package to be returned as a serialized package. Transmitted as part of the URL path and must be escaped accordingly.hFjCubehIhfubahIjubehIjmubahIhubehIh}ubhz)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjBh@]rC(h)rC}rC(hEXReturnshFjChGjBhIhhK}rC(hM]hN]hO]hP]hR]uhTKh@]rCh^XReturnsrCrC}rC(hEUhFjCubaubh)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rChb)rC}rC(hEXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested packageType.hK}rC(hM]hN]hO]hP]hR]uhFjCh@]rCh^XAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested packageType.rCrC}rC(hEXAny return type is allowed, including application/octet-stream, but the format of the response should be specialized by the requested packageType.hFjCubahIhfubahIhubehIh}ubhz)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjBh@]rC(h)rC}rC(hEX Return typehFjChGjBhIhhK}rC(hM]hN]hO]hP]hR]uhTKh@]rCh^X Return typerCrC}rC(hEUhFjCubaubh)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rChb)rC}rC(hEXTypes.OctetStreamhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rCj)rC}rC(hEX:class:`Types.OctetStream`rChFjChGj`AhIjhK}rC(UreftypeXclassjjXTypes.OctetStreamU refdomainXpyrChP]hO]U refexplicithM]hN]hR]jjjNjjyAuhTK+h@]rCj)rC}rC(hEjChK}rC(hM]hN]rC(jjCXpy-classrCehO]hP]hR]uhFjCh@]rCh^XTypes.OctetStreamrCrC}rC(hEUhFjCubahIjubaubahIhfubahIhubehIh}ubhz)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjBh@]rC(h)rC}rC(hEXRaiseshFjChGjBhIhhK}rC(hM]hN]hO]hP]hR]uhTKh@]rCh^XRaisesrCrC}rC(hEUhFjCubaubh)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rCj)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rC(j)rC}rC(hEUhK}rC(hM]hN]hO]hP]hR]uhFjCh@]rChb)rC}rC(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2870)hK}rC(hM]hN]hO]hP]hR]uhFjCh@]rC(j)rD}rD(hEUhK}rD(UreftypejjU reftargetXExceptions.InvalidTokenrDU refdomainjBhP]hO]U refexplicithM]hN]hR]uhFjCh@]rDj)rD}rD(hEjDhK}rD(hM]hN]hO]hP]hR]uhFjDh@]rDh^XExceptions.InvalidTokenr Dr D}r D(hEUhFjDubahIjubahIjubh^X -- r Dr D}rD(hEUhFjCubj)rD}rD(hEX$``(errorCode=401, detailCode=2870)``hK}rD(hM]hN]hO]hP]hR]uhFjCh@]rDh^X (errorCode=401, detailCode=2870)rDrD}rD(hEUhFjDubahIjubehIhfubahIjubj)rD}rD(hEUhK}rD(hM]hN]hO]hP]hR]uhFjCh@]rDhb)rD}rD(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2871)hK}rD(hM]hN]hO]hP]hR]uhFjDh@]rD(j)rD}rD(hEUhK}r D(UreftypejjU reftargetXExceptions.ServiceFailurer!DU refdomainjBhP]hO]U refexplicithM]hN]hR]uhFjDh@]r"Dj)r#D}r$D(hEj!DhK}r%D(hM]hN]hO]hP]hR]uhFjDh@]r&Dh^XExceptions.ServiceFailurer'Dr(D}r)D(hEUhFj#DubahIjubahIjubh^X -- r*Dr+D}r,D(hEUhFjDubj)r-D}r.D(hEX$``(errorCode=500, detailCode=2871)``hK}r/D(hM]hN]hO]hP]hR]uhFjDh@]r0Dh^X (errorCode=500, detailCode=2871)r1Dr2D}r3D(hEUhFj-DubahIjubehIhfubahIjubj)r4D}r5D(hEUhK}r6D(hM]hN]hO]hP]hR]uhFjCh@]r7Dhb)r8D}r9D(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2872)hK}r:D(hM]hN]hO]hP]hR]uhFj4Dh@]r;D(j)rD(UreftypejjU reftargetXExceptions.NotAuthorizedr?DU refdomainjBhP]hO]U refexplicithM]hN]hR]uhFj8Dh@]r@Dj)rAD}rBD(hEj?DhK}rCD(hM]hN]hO]hP]hR]uhFj)r9E}r:E(hEUhK}r;E(hM]hN]hO]hP]hR]uhFj5Eh@]rE(hEXTierr?EhFj9EhGjDhIhfhK}r@E(hM]hN]hO]hP]hR]uhTK h@]rAEh^XTierrBErCE}rDE(hEj?EhFj=EubaubahIjKubj>)rEE}rFE(hEUhK}rGE(hM]hN]hO]hP]hR]uhFj5Eh@]rHEhb)rIE}rJE(hEXVersionrKEhFjEEhGjDhIhfhK}rLE(hM]hN]hO]hP]hR]uhTK h@]rMEh^XVersionrNErOE}rPE(hEjKEhFjIEubaubahIjKubj>)rQE}rRE(hEUhK}rSE(hM]hN]hO]hP]hR]uhFj5Eh@]rTEhb)rUE}rVE(hEXRESTrWEhFjQEhGjDhIhfhK}rXE(hM]hN]hO]hP]hR]uhTK h@]rYEh^XRESTrZEr[E}r\E(hEjWEhFjUEubaubahIjKubj>)r]E}r^E(hEUhK}r_E(hM]hN]hO]hP]hR]uhFj5Eh@]r`Ehb)raE}rbE(hEXFunctionrcEhFj]EhGjDhIhfhK}rdE(hM]hN]hO]hP]hR]uhTK h@]reEh^XFunctionrfErgE}rhE(hEjcEhFjaEubaubahIjKubj>)riE}rjE(hEUhK}rkE(hM]hN]hO]hP]hR]uhFj5Eh@]rlEhb)rmE}rnE(hEX ParametersroEhFjiEhGjDhIhfhK}rpE(hM]hN]hO]hP]hR]uhTK h@]rqEh^X ParametersrrErsE}rtE(hEjoEhFjmEubaubahIjKubehIj|ubahIj}ubj~)ruE}rvE(hEUhK}rwE(hM]hN]hO]hP]hR]uhFjEh@]rxEj9)ryE}rzE(hEUhK}r{E(hM]hN]hO]hP]hR]uhFjuEh@]r|E(j>)r}E}r~E(hEUhK}rE(hM]hN]hO]hP]hR]uhFjyEh@]rEhb)rE}rE(hEXTier 2rEhFj}EhGjDhIhfhK}rE(hM]hN]hO]hP]hR]uhTKh@]rEh^XTier 2rErE}rE(hEjEhFjEubaubahIjKubj>)rE}rE(hEUhK}rE(hM]hN]hO]hP]hR]uhFjyEh@]rEhb)rE}rE(hEX1.0rEhFjEhGjDhIhfhK}rE(hM]hN]hO]hP]hR]uhTKh@]rEh^X1.0rErE}rE(hEjEhFjEubaubahIjKubj>)rE}rE(hEUhK}rE(hM]hN]hO]hP]hR]uhFjyEh@]rEhb)rE}rE(hEX*``GET /isAuthorized/{id}?action={action}``rEhFjEhGjDhIhfhK}rE(hM]hN]hO]hP]hR]uhTKh@]rEj)rE}rE(hEjEhK}rE(hM]hN]hO]hP]hR]uhFjEh@]rEh^X&GET /isAuthorized/{id}?action={action}rErE}rE(hEUhFjEubahIjubaubahIjKubj>)rE}rE(hEUhK}rE(hM]hN]hO]hP]hR]uhFjyEh@]rEhb)rE}rE(hEX:func:`isAuthorized`rEhFjEhGjDhIhfhK}rE(hM]hN]hO]hP]hR]uhTKh@]rEj)rE}rE(hEjEhFjEhGjDhIjhK}rE(UreftypeXfuncjjX isAuthorizedU refdomainXpyrEhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTKh@]rEj)rE}rE(hEjEhK}rE(hM]hN]rE(jjEXpy-funcrEehO]hP]hR]uhFjEh@]rEh^XisAuthorized()rErE}rE(hEUhFjEubahIjubaubaubahIjKubj>)rE}rE(hEUhK}rE(hM]hN]hO]hP]hR]uhFjyEh@]rEhb)rE}rE(hEXr(:class:`session`, :class:`id`, :class:`action`) ``->`` booleanrEhFjEhGjDhIhfhK}rE(hM]hN]hO]hP]hR]uhTKh@]rE(h^X(rE}rE(hEX(hFjEubj)rE}rE(hEX:class:`session`rEhFjEhGjDhIjhK}rE(UreftypeXclassjjX Types.SessionU refdomainXpyrEhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTKh@]rEj)rE}rE(hEjEhK}rE(hM]hN]rE(jjEXpy-classrEehO]hP]hR]uhFjEh@]rEh^XsessionrErE}rE(hEUhFjEubahIjubaubh^X, rErE}rE(hEX, hFjEubj)rE}rE(hEX:class:`id`rEhFjEhGjDhIjhK}rE(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrEhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTKh@]rEj)rE}rE(hEjEhK}rE(hM]hN]rE(jjEXpy-classrEehO]hP]hR]uhFjEh@]rEh^XidrErE}rE(hEUhFjEubahIjubaubh^X, rErE}rE(hEX, hFjEubj)rE}rE(hEX!:class:`action`rEhFjEhGjDhIjhK}rE(UreftypeXclassjjXTypes.PermissionU refdomainXpyrEhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTKh@]rEj)rE}rE(hEjEhK}rE(hM]hN]rE(jjEXpy-classrEehO]hP]hR]uhFjEh@]rEh^XactionrErE}rE(hEUhFjEubahIjubaubh^X) rErE}rE(hEX) hFjEubj)rE}rE(hEX``->``hK}rE(hM]hN]hO]hP]hR]uhFjEh@]rFh^X->rFrF}rF(hEUhFjEubahIjubh^X booleanrFrF}rF(hEX booleanhFjEubeubahIjKubehIj|ubahIjubehIjubeubj)rF}rF(hEUhFjDhGNhIjhK}r F(hP]hO]hM]hN]hR]Uentries]r F(jX*isAuthorized() (in module MNAuthorization)h UNtr FauhTNhUhh@]ubj)r F}r F(hEUhFjDhGNhIjhK}rF(jjXpyrFhP]hO]hM]hN]hR]jXfunctionrFjjFuhTNhUhh@]rF(j)rF}rF(hEX*isAuthorized(session,id,action) -> booleanhFj FhGXJinternal padding after source/apis/generated/generated_MNAuthorization.txtrFhIjhK}rF(hP]rFh ajjEhO]hM]hN]hR]rFh ajX isAuthorizedrFjUjuhTKDhUhh@]rF(j)rF}rF(hEXMNAuthorization.hFjFhGjFhIjhK}rF(hM]hN]hO]hP]hR]uhTKDhUhh@]rFh^XMNAuthorization.rFrF}r F(hEUhFjFubaubj)r!F}r"F(hEjFhFjFhGjFhIjhK}r#F(hM]hN]hO]hP]hR]uhTKDhUhh@]r$Fh^X isAuthorizedr%Fr&F}r'F(hEUhFj!Fubaubj)r(F}r)F(hEXsession, id, actionhFjFhGjFhIjhK}r*F(hM]hN]hO]hP]hR]uhTKDhUhh@]r+F(j)r,F}r-F(hEXsessionhK}r.F(hM]hN]hO]hP]hR]uhFj(Fh@]r/Fh^Xsessionr0Fr1F}r2F(hEUhFj,FubahIjubj)r3F}r4F(hEXidhK}r5F(hM]hN]hO]hP]hR]uhFj(Fh@]r6Fh^Xidr7Fr8F}r9F(hEUhFj3FubahIjubj)r:F}r;F(hEXactionhK}rFr?F}r@F(hEUhFj:FubahIjubeubj)rAF}rBF(hEXbooleanhFjFhGjFhIjhK}rCF(hM]hN]hO]hP]hR]uhTKDhUhh@]rDFh^XbooleanrEFrFF}rGF(hEUhFjAFubaubeubj)rHF}rIF(hEUhFj FhGjFhIj hK}rJF(hM]hN]hO]hP]hR]uhTKDhUhh@]rKF(hb)rLF}rMF(hEXlTest if the user identified by the provided session has authorization for operation on the specified object.rNFhFjHFhGjDhIhfhK}rOF(hM]hN]hO]hP]hR]uhTKhUhh@]rPFh^XlTest if the user identified by the provided session has authorization for operation on the specified object.rQFrRF}rSF(hEjNFhFjLFubaubhb)rTF}rUF(hEXCA successful operation is indicated by a return HTTP status of 200.rVFhFjHFhGjDhIhfhK}rWF(hM]hN]hO]hP]hR]uhTKhUhh@]rXFh^XCA successful operation is indicated by a return HTTP status of 200.rYFrZF}r[F(hEjVFhFjTFubaubhb)r\F}r]F(hEXQFailure is indicated by an exception such as :exc:`NotAuthorized` being returned.hFjHFhGjDhIhfhK}r^F(hM]hN]hO]hP]hR]uhTKhUhh@]r_F(h^X-Failure is indicated by an exception such as r`FraF}rbF(hEX-Failure is indicated by an exception such as hFj\Fubj)rcF}rdF(hEX:exc:`NotAuthorized`reFhFj\FhGjDhIjhK}rfF(UreftypeXexcjjX NotAuthorizedU refdomainXpyrgFhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTKh@]rhFj)riF}rjF(hEjeFhK}rkF(hM]hN]rlF(jjgFXpy-excrmFehO]hP]hR]uhFjcFh@]rnFh^X NotAuthorizedroFrpF}rqF(hEUhFjiFubahIjubaubh^X being returned.rrFrsF}rtF(hEX being returned.hFj\Fubeubhb)ruF}rvF(hEXJThe body of the response is arbitrary and SHOULD be ignored by the caller.rwFhFjHFhGjDhIhfhK}rxF(hM]hN]hO]hP]hR]uhTKhUhh@]ryFh^XJThe body of the response is arbitrary and SHOULD be ignored by the caller.rzFr{F}r|F(hEjwFhFjuFubaubhb)r}F}r~F(hEXVIf the action is not authorized, then a :exc:`NotAuthorized` exception MUST be raised.hFjHFhGjDhIhfhK}rF(hM]hN]hO]hP]hR]uhTK!hUhh@]rF(h^X(If the action is not authorized, then a rFrF}rF(hEX(If the action is not authorized, then a hFj}Fubj)rF}rF(hEX:exc:`NotAuthorized`rFhFj}FhGjDhIjhK}rF(UreftypeXexcjjX NotAuthorizedU refdomainXpyrFhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTK!h@]rFj)rF}rF(hEjFhK}rF(hM]hN]rF(jjFXpy-excrFehO]hP]hR]uhFjFh@]rFh^X NotAuthorizedrFrF}rF(hEUhFjFubahIjubaubh^X exception MUST be raised.rFrF}rF(hEX exception MUST be raised.hFj}Fubeubcdocutils.nodes note rF)rF}rF(hEXShould perhaps add convenience methods for "canRead()" and "canWrite()" to verify that a user is able to read / write an object.rFhFjHFhGjDhIUnoterFhK}rF(hM]hN]hO]hP]hR]uhTNhUhh@]rFhb)rF}rF(hEjFhFjFhGjDhIhfhK}rF(hM]hN]hO]hP]hR]uhTK#h@]rFh^XShould perhaps add convenience methods for "canRead()" and "canWrite()" to verify that a user is able to read / write an object.rFrF}rF(hEjFhFjFubaubaubht)rF}rF(hEUhFjHFhGNhIhwhK}rF(hM]hN]hO]hP]hR]uhTNhUhh@]rF(hz)rF}rF(hEUhFjFhGjDhIh}hK}rF(hM]hN]hO]hP]hR]uhTK%hUhh@]rF(h)rF}rF(hEXVersionhFjFhGjDhIhhK}rF(hM]hN]hO]hP]hR]uhTKh@]rFh^XVersionrFrF}rF(hEUhFjFubaubh)rF}rF(hEX1.0rFhK}rF(hM]hN]hO]hP]hR]uhFjFh@]rFhb)rF}rF(hEjFhFjFhGjDhIhfhK}rF(hM]hN]hO]hP]hR]uhTK%h@]rFh^X1.0rFrF}rF(hEjFhFjFubaubahIhubeubhz)rF}rF(hEUhFjFhGjDhIh}hK}rF(hM]hN]hO]hP]hR]uhTK&hUhh@]rF(h)rF}rF(hEX Use CaseshFjFhGjDhIhhK}rF(hM]hN]hO]hP]hR]uhTKh@]rFh^X Use CasesrFrF}rF(hEUhFjFubaubh)rF}rF(hEXJ:doc:`UC01 `, :doc:`UC37 `rFhK}rF(hM]hN]hO]hP]hR]uhFjFh@]rFhb)rF}rF(hEjFhFjFhGjDhIhfhK}rF(hM]hN]hO]hP]hR]uhTK'h@]rF(j)rF}rF(hEX$:doc:`UC01 `rFhFjFhGjDhIjhK}rF(UreftypeXdocrFjjX/design/UseCases/01_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK'h@]rFjr)rF}rF(hEjFhK}rF(hM]hN]rF(jjFehO]hP]hR]uhFjFh@]rFh^XUC01rFrF}rF(hEUhFjFubahIj{ubaubh^X, rFrF}rF(hEX, hFjFubj)rF}rF(hEX$:doc:`UC37 `rFhFjFhGjDhIjhK}rF(UreftypeXdocrFjjX/design/UseCases/37_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK'h@]rFjr)rF}rF(hEjFhK}rF(hM]hN]rF(jjFehO]hP]hR]uhFjFh@]rFh^XUC37rFrF}rF(hEUhFjFubahIj{ubaubeubahIhubeubhz)rF}rF(hEUhFjFhGjDhIh}hK}rF(hM]hN]hO]hP]hR]uhTK(hUhh@]rF(h)rF}rF(hEXREST URLhFjFhGjDhIhhK}rF(hM]hN]hO]hP]hR]uhTKh@]rFh^XREST URLrFrF}rF(hEUhFjFubaubh)rF}rF(hEX*``GET /isAuthorized/{id}?action={action}``rFhK}rG(hM]hN]hO]hP]hR]uhFjFh@]rGhb)rG}rG(hEjFhFjFhGjDhIhfhK}rG(hM]hN]hO]hP]hR]uhTK(h@]rGj)rG}rG(hEjFhK}rG(hM]hN]hO]hP]hR]uhFjGh@]r Gh^X&GET /isAuthorized/{id}?action={action}r Gr G}r G(hEUhFjGubahIjubaubahIhubeubhz)r G}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjFh@]rG(h)rG}rG(hEX ParametershFj GhGjFhIhhK}rG(hM]hN]hO]hP]hR]uhTKh@]rGh^X ParametersrGrG}rG(hEUhFjGubaubh)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFj Gh@]rGj)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rG(j)r G}r!G(hEUhK}r"G(hM]hN]hO]hP]hR]uhFjGh@]r#Ghb)r$G}r%G(hEXTsession (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.hK}r&G(hM]hN]hO]hP]hR]uhFj Gh@]r'G(j)r(G}r)G(hEXsessionhK}r*G(hP]hO]jhM]hN]hR]uhFj$Gh@]r+Gh^Xsessionr,Gr-G}r.G(hEUhFj(GubahIjubh^X (r/Gr0G}r1G(hEUhFj$Gubj)r2G}r3G(hEX:class:`Types.Session`r4GhFj$GhGjDhIjhK}r5G(UreftypeXclassjjX Types.SessionU refdomainXpyr6GhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTK*h@]r7Gj)r8G}r9G(hEj4GhK}r:G(hM]hN]r;G(jj6GXpy-classrGr?G}r@G(hEUhFj8GubahIjubaubh^X)rAG}rBG(hEUhFj$Gubh^X -- rCGrDG}rEG(hEUhFj$Gubh^XSession 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 rFGrGG}rHG(hEXSession 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 hFj$Gubj)rIG}rJG(hEX:term:`public user`rKGhFj$GhGjDhIjhK}rLG(UreftypeXtermjjX public userU refdomainXstdrMGhP]hO]U refexplicithM]hN]hR]jjuhTK)h@]rNGjr)rOG}rPG(hEjKGhK}rQG(hM]hN]rRG(jjMGXstd-termrSGehO]hP]hR]uhFjIGh@]rTGh^X public userrUGrVG}rWG(hEUhFjOGubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rXGrYG}rZG(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj$GubehIhfubahIjubj)r[G}r\G(hEUhK}r]G(hM]hN]hO]hP]hR]uhFjGh@]r^Ghb)r_G}r`G(hEXid (Types.Identifier) -- The identifer of the resource for which access is being checked. May be either a PID or a SID. Will use the HEAD PID when given a SID value. Transmitted as part of the URL path and must be escaped accordingly.hK}raG(hM]hN]hO]hP]hR]uhFj[Gh@]rbG(j)rcG}rdG(hEXidhK}reG(hP]hO]jhM]hN]hR]uhFj_Gh@]rfGh^XidrgGrhG}riG(hEUhFjcGubahIjubh^X (rjGrkG}rlG(hEUhFj_Gubj)rmG}rnG(hEX:class:`Types.Identifier`roGhFj_GhGjDhIjhK}rpG(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrqGhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTK-h@]rrGj)rsG}rtG(hEjoGhK}ruG(hM]hN]rvG(jjqGXpy-classrwGehO]hP]hR]uhFjmGh@]rxGh^XTypes.IdentifierryGrzG}r{G(hEUhFjsGubahIjubaubh^X)r|G}r}G(hEUhFj_Gubh^X -- r~GrG}rG(hEUhFj_Gubh^XThe identifer of the resource for which access is being checked. May be either a PID or a SID. Will use the HEAD PID when given a SID value. Transmitted as part of the URL path and must be escaped accordingly.rGrG}rG(hEXThe identifer of the resource for which access is being checked. May be either a PID or a SID. Will use the HEAD PID when given a SID value. Transmitted as part of the URL path and must be escaped accordingly.rGhFj_GubehIhfubahIjubj)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGhb)rG}rG(hEXaction (Types.Permission) -- The type of operation which is being requested for the given pid. Transmitted as a URL query parameter, and so must be escaped accordingly.hK}rG(hM]hN]hO]hP]hR]uhFjGh@]rG(j)rG}rG(hEXactionhK}rG(hP]hO]jhM]hN]hR]uhFjGh@]rGh^XactionrGrG}rG(hEUhFjGubahIjubh^X (rGrG}rG(hEUhFjGubj)rG}rG(hEX:class:`Types.Permission`rGhFjGhGjDhIjhK}rG(UreftypeXclassjjXTypes.PermissionU refdomainXpyrGhP]hO]U refexplicithM]hN]hR]jjjNjjEuhTK0h@]rGj)rG}rG(hEjGhK}rG(hM]hN]rG(jjGXpy-classrGehO]hP]hR]uhFjGh@]rGh^XTypes.PermissionrGrG}rG(hEUhFjGubahIjubaubh^X)rG}rG(hEUhFjGubh^X -- rGrG}rG(hEUhFjGubh^XThe type of operation which is being requested for the given pid. Transmitted as a URL query parameter, and so must be escaped accordingly.rGrG}rG(hEXThe type of operation which is being requested for the given pid. Transmitted as a URL query parameter, and so must be escaped accordingly.rGhFjGubehIhfubahIjubehIjmubahIhubehIh}ubhz)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjFh@]rG(h)rG}rG(hEXReturnshFjGhGjFhIhhK}rG(hM]hN]hO]hP]hR]uhTKh@]rGh^XReturnsrGrG}rG(hEUhFjGubaubh)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGhb)rG}rG(hEX True if the operation is allowedhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGh^X True if the operation is allowedrGrG}rG(hEX True if the operation is allowedrGhFjGubahIhfubahIhubehIh}ubhz)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjFh@]rG(h)rG}rG(hEX Return typehFjGhGjFhIhhK}rG(hM]hN]hO]hP]hR]uhTKh@]rGh^X Return typerGrG}rG(hEUhFjGubaubh)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGhb)rG}rG(hEXbooleanhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGj)rG}rG(hEUhK}rG(UreftypejjU reftargetXbooleanU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjGh@]rGh^XbooleanrGrG}rG(hEUhFjGubahIjubahIhfubahIhubehIh}ubhz)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjFh@]rG(h)rG}rG(hEXRaiseshFjGhGjFhIhhK}rG(hM]hN]hO]hP]hR]uhTKh@]rGh^XRaisesrGrG}rG(hEUhFjGubaubh)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGj)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rG(j)rG}rG(hEUhK}rG(hM]hN]hO]hP]hR]uhFjGh@]rGhb)rG}rG(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=1760)hK}rG(hM]hN]hO]hP]hR]uhFjGh@]rG(j)rG}rG(hEUhK}rG(UreftypejjU reftargetXExceptions.ServiceFailurerGU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjGh@]rGj)rH}rH(hEjGhK}rH(hM]hN]hO]hP]hR]uhFjGh@]rHh^XExceptions.ServiceFailurerHrH}rH(hEUhFjHubahIjubahIjubh^X -- rHrH}r H(hEUhFjGubj)r H}r H(hEX$``(errorCode=500, detailCode=1760)``r HhK}r H(hM]hN]hO]hP]hR]uhFjGh@]rHh^X (errorCode=500, detailCode=1760)rHrH}rH(hEUhFj HubahIjubehIhfubahIjubj)rH}rH(hEUhK}rH(hM]hN]hO]hP]hR]uhFjGh@]rHhb)rH}rH(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1780)hK}rH(hM]hN]hO]hP]hR]uhFjHh@]rH(j)rH}rH(hEUhK}rH(UreftypejjU reftargetXExceptions.NotImplementedrHU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjHh@]rHj)rH}r H(hEjHhK}r!H(hM]hN]hO]hP]hR]uhFjHh@]r"Hh^XExceptions.NotImplementedr#Hr$H}r%H(hEUhFjHubahIjubahIjubh^X -- r&Hr'H}r(H(hEUhFjHubj)r)H}r*H(hEX$``(errorCode=501, detailCode=1780)``r+HhK}r,H(hM]hN]hO]hP]hR]uhFjHh@]r-Hh^X (errorCode=501, detailCode=1780)r.Hr/H}r0H(hEUhFj)HubahIjubehIhfubahIjubj)r1H}r2H(hEUhK}r3H(hM]hN]hO]hP]hR]uhFjGh@]r4Hhb)r5H}r6H(hEX7Exceptions.NotFound -- (errorCode=404, detailCode=1800)hK}r7H(hM]hN]hO]hP]hR]uhFj1Hh@]r8H(j)r9H}r:H(hEUhK}r;H(UreftypejjU reftargetXExceptions.NotFoundrH}r?H(hEjHubahIjubahIjubh^X -- rEHrFH}rGH(hEUhFj5Hubj)rHH}rIH(hEX$``(errorCode=404, detailCode=1800)``rJHhK}rKH(hM]hN]hO]hP]hR]uhFj5Hh@]rLHh^X (errorCode=404, detailCode=1800)rMHrNH}rOH(hEUhFjHHubahIjubehIhfubahIjubj)rPH}rQH(hEUhK}rRH(hM]hN]hO]hP]hR]uhFjGh@]rSHhb)rTH}rUH(hEXExceptions.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)hK}rVH(hM]hN]hO]hP]hR]uhFjPHh@]rWH(j)rXH}rYH(hEUhK}rZH(UreftypejjU reftargetXExceptions.NotAuthorizedr[HU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjTHh@]r\Hj)r]H}r^H(hEj[HhK}r_H(hM]hN]hO]hP]hR]uhFjXHh@]r`Hh^XExceptions.NotAuthorizedraHrbH}rcH(hEUhFj]HubahIjubahIjubh^X -- rdHreH}rfH(hEUhFjTHubhb)rgH}rhH(hEX$``(errorCode=401, detailCode=1820)``riHhFjTHhGjDhIhfhK}rjH(hM]hN]hO]hP]hR]uhTK;h@]rkHj)rlH}rmH(hEjiHhK}rnH(hM]hN]hO]hP]hR]uhFjgHh@]roHh^X (errorCode=401, detailCode=1820)rpHrqH}rrH(hEUhFjlHubahIjubaubhb)rsH}rtH(hEXThis 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)ruHhFjTHhGjDhIhfhK}rvH(hM]hN]hO]hP]hR]uhTK=h@]rwHh^XThis 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)rxHryH}rzH(hEjuHhFjsHubaubehIhfubahIjubj)r{H}r|H(hEUhK}r}H(hM]hN]hO]hP]hR]uhFjGh@]r~Hhb)rH}rH(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=1840)hK}rH(hM]hN]hO]hP]hR]uhFj{Hh@]rH(j)rH}rH(hEUhK}rH(UreftypejjU reftargetXExceptions.InvalidTokenrHU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjHh@]rHj)rH}rH(hEjHhK}rH(hM]hN]hO]hP]hR]uhFjHh@]rHh^XExceptions.InvalidTokenrHrH}rH(hEUhFjHubahIjubahIjubh^X -- rHrH}rH(hEUhFjHubj)rH}rH(hEX$``(errorCode=401, detailCode=1840)``rHhK}rH(hM]hN]hO]hP]hR]uhFjHh@]rHh^X (errorCode=401, detailCode=1840)rHrH}rH(hEUhFjHubahIjubehIhfubahIjubj)rH}rH(hEUhK}rH(hM]hN]hO]hP]hR]uhFjGh@]rHhb)rH}rH(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1761)hK}rH(hM]hN]hO]hP]hR]uhFjHh@]rH(j)rH}rH(hEUhK}rH(UreftypejjU reftargetXExceptions.InvalidRequestrHU refdomainjFhP]hO]U refexplicithM]hN]hR]uhFjHh@]rHj)rH}rH(hEjHhK}rH(hM]hN]hO]hP]hR]uhFjHh@]rHh^XExceptions.InvalidRequestrHrH}rH(hEUhFjHubahIjubahIjubh^X -- rHrH}rH(hEUhFjHubj)rH}rH(hEX$``(errorCode=400, detailCode=1761)``rHhK}rH(hM]hN]hO]hP]hR]uhFjHh@]rHh^X (errorCode=400, detailCode=1761)rHrH}rH(hEUhFjHubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubeubhB)rH}rH(hEUhFhChGhHhIhJhK}rH(hM]hN]hO]hP]rH(Xmodule-MNStoragerHh4ehR]rHhauhTKhUhh@]rH(hW)rH}rH(hEX Storage APIrHhFjHhGhHhIh[hK}rH(hM]hN]hO]hP]hR]uhTKhUhh@]rHh^X Storage APIrHrH}rH(hEjHhFjHubaubj)rH}rH(hEUhFjHhGhHhIjhK}rH(hP]hO]hM]hN]hR]Uentries]rH(jXMNStorage (module)Xmodule-MNStorageUNtrHauhTNhUhh@]ubh)rH}rH(hEXBWarning: this file is automatically generated. Edits will be losthFjHhGjX-source/apis/generated/generated_MNStorage.txtrHrH}rHbhIhhK}rH(hhhP]hO]hM]hN]hR]uhTKhUhh@]rHh^XBWarning: this file is automatically generated. Edits will be lostrHrH}rH(hEUhFjHubaubj)rH}rH(hEUhFjHhGNhIjhK}rH(hM]hN]hO]hP]rHUid8rHahR]uhTNhUhh@]rH(hW)rH}rH(hEX%Functions defined in :mod:`MNStorage`hK}rH(hM]hN]hO]hP]hR]uhFjHh@]rH(h^XFunctions defined in rHrH}rH(hEXFunctions defined in hFjHubj)rH}rH(hEX:mod:`MNStorage`rHhFjHhGjHhIjhK}rH(UreftypeXmodjjX MNStorageU refdomainXpyrHhP]hO]U refexplicithM]hN]hR]jjjNjX MNStoragerHuhTKh@]rHj)rH}rH(hEjHhK}rH(hM]hN]rH(jjHXpy-modrHehO]hP]hR]uhFjHh@]rHh^X MNStoragerHrH}rH(hEUhFjHubahIjubaubehIh[ubj)rH}rH(hEUhK}rH(hP]hO]hM]hN]hR]UcolsKuhFjHh@]rH(j#)rH}rH(hEUhK}rH(hP]hO]hM]hN]hR]UcolwidthKuhFjHh@]hIj'ubj#)rH}rH(hEUhK}rH(hP]hO]hM]hN]hR]UcolwidthKuhFjHh@]hIj'ubj#)rH}rH(hEUhK}rI(hP]hO]hM]hN]hR]UcolwidthK uhFjHh@]hIj'ubj#)rI}rI(hEUhK}rI(hP]hO]hM]hN]hR]UcolwidthK uhFjHh@]hIj'ubj#)rI}rI(hEUhK}rI(hP]hO]hM]hN]hR]UcolwidthKuhFjHh@]hIj'ubj4)rI}rI(hEUhK}r I(hM]hN]hO]hP]hR]uhFjHh@]r Ij9)r I}r I(hEUhK}r I(hM]hN]hO]hP]hR]uhFjIh@]rI(j>)rI}rI(hEUhK}rI(hM]hN]hO]hP]hR]uhFj Ih@]rIhb)rI}rI(hEXTierrIhFjIhGjHhIhfhK}rI(hM]hN]hO]hP]hR]uhTK h@]rIh^XTierrIrI}rI(hEjIhFjIubaubahIjKubj>)rI}rI(hEUhK}rI(hM]hN]hO]hP]hR]uhFj Ih@]rIhb)rI}r I(hEXVersionr!IhFjIhGjHhIhfhK}r"I(hM]hN]hO]hP]hR]uhTK h@]r#Ih^XVersionr$Ir%I}r&I(hEj!IhFjIubaubahIjKubj>)r'I}r(I(hEUhK}r)I(hM]hN]hO]hP]hR]uhFj Ih@]r*Ihb)r+I}r,I(hEXRESTr-IhFj'IhGjHhIhfhK}r.I(hM]hN]hO]hP]hR]uhTK h@]r/Ih^XRESTr0Ir1I}r2I(hEj-IhFj+IubaubahIjKubj>)r3I}r4I(hEUhK}r5I(hM]hN]hO]hP]hR]uhFj Ih@]r6Ihb)r7I}r8I(hEXFunctionr9IhFj3IhGjHhIhfhK}r:I(hM]hN]hO]hP]hR]uhTK h@]r;Ih^XFunctionrI(hEj9IhFj7IubaubahIjKubj>)r?I}r@I(hEUhK}rAI(hM]hN]hO]hP]hR]uhFj Ih@]rBIhb)rCI}rDI(hEX ParametersrEIhFj?IhGjHhIhfhK}rFI(hM]hN]hO]hP]hR]uhTK h@]rGIh^X ParametersrHIrII}rJI(hEjEIhFjCIubaubahIjKubehIj|ubahIj}ubj~)rKI}rLI(hEUhK}rMI(hM]hN]hO]hP]hR]uhFjHh@]rNI(j9)rOI}rPI(hEUhK}rQI(hM]hN]hO]hP]hR]uhFjKIh@]rRI(j>)rSI}rTI(hEUhK}rUI(hM]hN]hO]hP]hR]uhFjOIh@]rVIhb)rWI}rXI(hEXTier 3rYIhFjSIhGjHhIhfhK}rZI(hM]hN]hO]hP]hR]uhTKh@]r[Ih^XTier 3r\Ir]I}r^I(hEjYIhFjWIubaubahIjKubj>)r_I}r`I(hEUhK}raI(hM]hN]hO]hP]hR]uhFjOIh@]rbIhb)rcI}rdI(hEX1.0reIhFj_IhGjHhIhfhK}rfI(hM]hN]hO]hP]hR]uhTKh@]rgIh^X1.0rhIriI}rjI(hEjeIhFjcIubaubahIjKubj>)rkI}rlI(hEUhK}rmI(hM]hN]hO]hP]hR]uhFjOIh@]rnIhb)roI}rpI(hEX``POST /object``rqIhFjkIhGjHhIhfhK}rrI(hM]hN]hO]hP]hR]uhTKh@]rsIj)rtI}ruI(hEjqIhK}rvI(hM]hN]hO]hP]hR]uhFjoIh@]rwIh^X POST /objectrxIryI}rzI(hEUhFjtIubahIjubaubahIjKubj>)r{I}r|I(hEUhK}r}I(hM]hN]hO]hP]hR]uhFjOIh@]r~Ihb)rI}rI(hEX:func:`create`rIhFj{IhGjHhIhfhK}rI(hM]hN]hO]hP]hR]uhTKh@]rIj)rI}rI(hEjIhFjIhGjHhIjhK}rI(UreftypeXfuncjjXcreateU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rIj)rI}rI(hEjIhK}rI(hM]hN]rI(jjIXpy-funcrIehO]hP]hR]uhFjIh@]rIh^Xcreate()rIrI}rI(hEUhFjIubahIjubaubaubahIjKubj>)rI}rI(hEUhK}rI(hM]hN]hO]hP]hR]uhFjOIh@]rIhb)rI}rI(hEX(:class:`session`, :class:`pid`, ``object``, :class:`sysmeta`) ``->`` :class:`Types.Identifier`rIhFjIhGjHhIhfhK}rI(hM]hN]hO]hP]hR]uhTKh@]rI(h^X(rI}rI(hEX(hFjIubj)rI}rI(hEX:class:`session`rIhFjIhGjHhIjhK}rI(UreftypeXclassjjX Types.SessionU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rIj)rI}rI(hEjIhK}rI(hM]hN]rI(jjIXpy-classrIehO]hP]hR]uhFjIh@]rIh^XsessionrIrI}rI(hEUhFjIubahIjubaubh^X, rIrI}rI(hEX, hFjIubj)rI}rI(hEX:class:`pid`rIhFjIhGjHhIjhK}rI(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rIj)rI}rI(hEjIhK}rI(hM]hN]rI(jjIXpy-classrIehO]hP]hR]uhFjIh@]rIh^XpidrIrI}rI(hEUhFjIubahIjubaubh^X, rIrI}rI(hEX, hFjIubj)rI}rI(hEX ``object``hK}rI(hM]hN]hO]hP]hR]uhFjIh@]rIh^XobjectrIrI}rI(hEUhFjIubahIjubh^X, rIrI}rI(hEX, hFjIubj)rI}rI(hEX&:class:`sysmeta`rIhFjIhGjHhIjhK}rI(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rIj)rI}rI(hEjIhK}rI(hM]hN]rI(jjIXpy-classrIehO]hP]hR]uhFjIh@]rIh^XsysmetarIrI}rI(hEUhFjIubahIjubaubh^X) rIrI}rI(hEX) hFjIubj)rI}rI(hEX``->``hK}rI(hM]hN]hO]hP]hR]uhFjIh@]rIh^X->rIrI}rI(hEUhFjIubahIjubh^X rI}rI(hEX hFjIubj)rI}rI(hEX:class:`Types.Identifier`rIhFjIhGjHhIjhK}rI(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrIhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rIj)rI}rI(hEjIhK}rI(hM]hN]rI(jjIXpy-classrIehO]hP]hR]uhFjIh@]rIh^XTypes.IdentifierrIrI}rI(hEUhFjIubahIjubaubeubahIjKubehIj|ubj9)rI}rI(hEUhK}rI(hM]hN]hO]hP]hR]uhFjKIh@]rI(j>)rI}rI(hEUhK}rI(hM]hN]hO]hP]hR]uhFjIh@]rIhb)rI}rI(hEXTier 3rIhFjIhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJh^XTier 3rJrJ}rJ(hEjIhFjIubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjIh@]rJhb)r J}r J(hEX1.0r JhFjJhGjHhIhfhK}r J(hM]hN]hO]hP]hR]uhTKh@]r Jh^X1.0rJrJ}rJ(hEj JhFj JubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjIh@]rJhb)rJ}rJ(hEX``PUT /object/{pid}``rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJj)rJ}rJ(hEjJhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJh^XPUT /object/{pid}rJrJ}r J(hEUhFjJubahIjubaubahIjKubj>)r!J}r"J(hEUhK}r#J(hM]hN]hO]hP]hR]uhFjIh@]r$Jhb)r%J}r&J(hEX:func:`update`r'JhFj!JhGjHhIhfhK}r(J(hM]hN]hO]hP]hR]uhTKh@]r)Jj)r*J}r+J(hEj'JhFj%JhGjHhIjhK}r,J(UreftypeXfuncjjXupdateU refdomainXpyr-JhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]r.Jj)r/J}r0J(hEj'JhK}r1J(hM]hN]r2J(jj-JXpy-funcr3JehO]hP]hR]uhFj*Jh@]r4Jh^Xupdate()r5Jr6J}r7J(hEUhFj/JubahIjubaubaubahIjKubj>)r8J}r9J(hEUhK}r:J(hM]hN]hO]hP]hR]uhFjIh@]r;Jhb)r`, :class:`pid`, ``object``, :class:`newPid`, :class:`sysmeta`) ``->`` :class:`Types.Identifier`r>JhFj8JhGjHhIhfhK}r?J(hM]hN]hO]hP]hR]uhTKh@]r@J(h^X(rAJ}rBJ(hEX(hFj`rEJhFj`rWJhFj`rsJhFj`rJhFj``hK}rJ(hM]hN]hO]hP]hR]uhFjrJrJ}rJ(hEUhFjJubahIjubh^X rJ}rJ(hEX hFj)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJhb)rJ}rJ(hEXTier 3rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJh^XTier 3rJrJ}rJ(hEjJhFjJubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJhb)rJ}rJ(hEX1.0rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJh^X1.0rJrJ}rJ(hEjJhFjJubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJhb)rJ}rJ(hEX``POST /generate``rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJj)rJ}rJ(hEjJhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJh^XPOST /generaterJrJ}rJ(hEUhFjJubahIjubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJhb)rJ}rJ(hEX:func:`generateIdentifier`rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJj)rJ}rJ(hEjJhFjJhGjHhIjhK}rJ(UreftypeXfuncjjXgenerateIdentifierU refdomainXpyrJhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rJj)rJ}rJ(hEjJhK}rJ(hM]hN]rJ(jjJXpy-funcrJehO]hP]hR]uhFjJh@]rJh^XgenerateIdentifier()rJrJ}rJ(hEUhFjJubahIjubaubaubahIjKubj>)rJ}rJ(hEUhK}rJ(hM]hN]hO]hP]hR]uhFjJh@]rJhb)rJ}rJ(hEX^(:class:`session`, ``scheme``, ``[fragment]``) ``->`` :class:`Types.Identifier`rJhFjJhGjHhIhfhK}rJ(hM]hN]hO]hP]hR]uhTKh@]rJ(h^X(rJ}rJ(hEX(hFjJubj)rJ}rJ(hEX:class:`session`rJhFjJhGjHhIjhK}rJ(UreftypeXclassjjX Types.SessionU refdomainXpyrJhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rKj)rK}rK(hEjJhK}rK(hM]hN]rK(jjJXpy-classrKehO]hP]hR]uhFjJh@]rKh^XsessionrKrK}r K(hEUhFjKubahIjubaubh^X, r Kr K}r K(hEX, hFjJubj)r K}rK(hEX ``scheme``hK}rK(hM]hN]hO]hP]hR]uhFjJh@]rKh^XschemerKrK}rK(hEUhFj KubahIjubh^X, rKrK}rK(hEX, hFjJubj)rK}rK(hEX``[fragment]``hK}rK(hM]hN]hO]hP]hR]uhFjJh@]rKh^X [fragment]rKrK}rK(hEUhFjKubahIjubh^X) rKrK}r K(hEX) hFjJubj)r!K}r"K(hEX``->``hK}r#K(hM]hN]hO]hP]hR]uhFjJh@]r$Kh^X->r%Kr&K}r'K(hEUhFj!KubahIjubh^X r(K}r)K(hEX hFjJubj)r*K}r+K(hEX:class:`Types.Identifier`r,KhFjJhGjHhIjhK}r-K(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr.KhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]r/Kj)r0K}r1K(hEj,KhK}r2K(hM]hN]r3K(jj.KXpy-classr4KehO]hP]hR]uhFj*Kh@]r5Kh^XTypes.Identifierr6Kr7K}r8K(hEUhFj0KubahIjubaubeubahIjKubehIj|ubj9)r9K}r:K(hEUhK}r;K(hM]hN]hO]hP]hR]uhFjKIh@]r)r=K}r>K(hEUhK}r?K(hM]hN]hO]hP]hR]uhFj9Kh@]r@Khb)rAK}rBK(hEXTier 3rCKhFj=KhGjHhIhfhK}rDK(hM]hN]hO]hP]hR]uhTKh@]rEKh^XTier 3rFKrGK}rHK(hEjCKhFjAKubaubahIjKubj>)rIK}rJK(hEUhK}rKK(hM]hN]hO]hP]hR]uhFj9Kh@]rLKhb)rMK}rNK(hEX1.0rOKhFjIKhGjHhIhfhK}rPK(hM]hN]hO]hP]hR]uhTKh@]rQKh^X1.0rRKrSK}rTK(hEjOKhFjMKubaubahIjKubj>)rUK}rVK(hEUhK}rWK(hM]hN]hO]hP]hR]uhFj9Kh@]rXKhb)rYK}rZK(hEX``DELETE /object/{id}``r[KhFjUKhGjHhIhfhK}r\K(hM]hN]hO]hP]hR]uhTKh@]r]Kj)r^K}r_K(hEj[KhK}r`K(hM]hN]hO]hP]hR]uhFjYKh@]raKh^XDELETE /object/{id}rbKrcK}rdK(hEUhFj^KubahIjubaubahIjKubj>)reK}rfK(hEUhK}rgK(hM]hN]hO]hP]hR]uhFj9Kh@]rhKhb)riK}rjK(hEX:func:`delete`rkKhFjeKhGjHhIhfhK}rlK(hM]hN]hO]hP]hR]uhTK h@]rmKj)rnK}roK(hEjkKhFjiKhGjHhIjhK}rpK(UreftypeXfuncjjXdeleteU refdomainXpyrqKhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK h@]rrKj)rsK}rtK(hEjkKhK}ruK(hM]hN]rvK(jjqKXpy-funcrwKehO]hP]hR]uhFjnKh@]rxKh^Xdelete()ryKrzK}r{K(hEUhFjsKubahIjubaubaubahIjKubj>)r|K}r}K(hEUhK}r~K(hM]hN]hO]hP]hR]uhFj9Kh@]rKhb)rK}rK(hEXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`rKhFj|KhGjHhIhfhK}rK(hM]hN]hO]hP]hR]uhTK!h@]rK(h^X(rK}rK(hEX(hFjKubj)rK}rK(hEX:class:`session`rKhFjKhGjHhIjhK}rK(UreftypeXclassjjX Types.SessionU refdomainXpyrKhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK!h@]rKj)rK}rK(hEjKhK}rK(hM]hN]rK(jjKXpy-classrKehO]hP]hR]uhFjKh@]rKh^XsessionrKrK}rK(hEUhFjKubahIjubaubh^X, rKrK}rK(hEX, hFjKubj)rK}rK(hEX:class:`id`rKhFjKhGjHhIjhK}rK(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrKhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK!h@]rKj)rK}rK(hEjKhK}rK(hM]hN]rK(jjKXpy-classrKehO]hP]hR]uhFjKh@]rKh^XidrKrK}rK(hEUhFjKubahIjubaubh^X) rKrK}rK(hEX) hFjKubj)rK}rK(hEX``->``hK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKh^X->rKrK}rK(hEUhFjKubahIjubh^X rK}rK(hEX hFjKubj)rK}rK(hEX:class:`Types.Identifier`rKhFjKhGjHhIjhK}rK(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrKhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK!h@]rKj)rK}rK(hEjKhK}rK(hM]hN]rK(jjKXpy-classrKehO]hP]hR]uhFjKh@]rKh^XTypes.IdentifierrKrK}rK(hEUhFjKubahIjubaubeubahIjKubehIj|ubj9)rK}rK(hEUhK}rK(hM]hN]hO]hP]hR]uhFjKIh@]rK(j>)rK}rK(hEUhK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKhb)rK}rK(hEXTier 3rKhFjKhGjHhIhfhK}rK(hM]hN]hO]hP]hR]uhTK"h@]rKh^XTier 3rKrK}rK(hEjKhFjKubaubahIjKubj>)rK}rK(hEUhK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKhb)rK}rK(hEX1.0rKhFjKhGjHhIhfhK}rK(hM]hN]hO]hP]hR]uhTK#h@]rKh^X1.0rKrK}rK(hEjKhFjKubaubahIjKubj>)rK}rK(hEUhK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKhb)rK}rK(hEX``PUT /archive/{id}``rKhFjKhGjHhIhfhK}rK(hM]hN]hO]hP]hR]uhTK$h@]rKj)rK}rK(hEjKhK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKh^XPUT /archive/{id}rKrK}rK(hEUhFjKubahIjubaubahIjKubj>)rK}rK(hEUhK}rK(hM]hN]hO]hP]hR]uhFjKh@]rKhb)rK}rK(hEX:func:`archive`rKhFjKhGjHhIhfhK}rK(hM]hN]hO]hP]hR]uhTK%h@]rKj)rK}rK(hEjKhFjKhGjHhIjhK}rK(UreftypeXfuncjjXarchiveU refdomainXpyrKhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK%h@]rKj)rK}rK(hEjKhK}rK(hM]hN]rL(jjKXpy-funcrLehO]hP]hR]uhFjKh@]rLh^X archive()rLrL}rL(hEUhFjKubahIjubaubaubahIjKubj>)rL}rL(hEUhK}rL(hM]hN]hO]hP]hR]uhFjKh@]r Lhb)r L}r L(hEXa(:class:`session`, :class:`id`) ``->`` :class:`Types.Identifier`r LhFjLhGjHhIhfhK}r L(hM]hN]hO]hP]hR]uhTK&h@]rL(h^X(rL}rL(hEX(hFj Lubj)rL}rL(hEX:class:`session`rLhFj LhGjHhIjhK}rL(UreftypeXclassjjX Types.SessionU refdomainXpyrLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK&h@]rLj)rL}rL(hEjLhK}rL(hM]hN]rL(jjLXpy-classrLehO]hP]hR]uhFjLh@]rLh^XsessionrLrL}rL(hEUhFjLubahIjubaubh^X, r Lr!L}r"L(hEX, hFj Lubj)r#L}r$L(hEX:class:`id`r%LhFj LhGjHhIjhK}r&L(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr'LhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK&h@]r(Lj)r)L}r*L(hEj%LhK}r+L(hM]hN]r,L(jj'LXpy-classr-LehO]hP]hR]uhFj#Lh@]r.Lh^Xidr/Lr0L}r1L(hEUhFj)LubahIjubaubh^X) r2Lr3L}r4L(hEX) hFj Lubj)r5L}r6L(hEX``->``hK}r7L(hM]hN]hO]hP]hR]uhFj Lh@]r8Lh^X->r9Lr:L}r;L(hEUhFj5LubahIjubh^X rL}r?L(hEX:class:`Types.Identifier`r@LhFj LhGjHhIjhK}rAL(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrBLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK&h@]rCLj)rDL}rEL(hEj@LhK}rFL(hM]hN]rGL(jjBLXpy-classrHLehO]hP]hR]uhFj>Lh@]rILh^XTypes.IdentifierrJLrKL}rLL(hEUhFjDLubahIjubaubeubahIjKubehIj|ubj9)rML}rNL(hEUhK}rOL(hM]hN]hO]hP]hR]uhFjKIh@]rPL(j>)rQL}rRL(hEUhK}rSL(hM]hN]hO]hP]hR]uhFjMLh@]rTLhb)rUL}rVL(hEXTier 1rWLhFjQLhGjHhIhfhK}rXL(hM]hN]hO]hP]hR]uhTK'h@]rYLh^XTier 1rZLr[L}r\L(hEjWLhFjULubaubahIjKubj>)r]L}r^L(hEUhK}r_L(hM]hN]hO]hP]hR]uhFjMLh@]r`Lhb)raL}rbL(hEX2.0rcLhFj]LhGjHhIhfhK}rdL(hM]hN]hO]hP]hR]uhTK(h@]reLh^X2.0rfLrgL}rhL(hEjcLhFjaLubaubahIjKubj>)riL}rjL(hEUhK}rkL(hM]hN]hO]hP]hR]uhFjMLh@]rlLhb)rmL}rnL(hEX ``PUT /meta``roLhFjiLhGjHhIhfhK}rpL(hM]hN]hO]hP]hR]uhTK)h@]rqLj)rrL}rsL(hEjoLhK}rtL(hM]hN]hO]hP]hR]uhFjmLh@]ruLh^X PUT /metarvLrwL}rxL(hEUhFjrLubahIjubaubahIjKubj>)ryL}rzL(hEUhK}r{L(hM]hN]hO]hP]hR]uhFjMLh@]r|Lhb)r}L}r~L(hEX:func:`updateSystemMetadata`rLhFjyLhGjHhIhfhK}rL(hM]hN]hO]hP]hR]uhTK*h@]rLj)rL}rL(hEjLhFj}LhGjHhIjhK}rL(UreftypeXfuncjjXupdateSystemMetadataU refdomainXpyrLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK*h@]rLj)rL}rL(hEjLhK}rL(hM]hN]rL(jjLXpy-funcrLehO]hP]hR]uhFjLh@]rLh^XupdateSystemMetadata()rLrL}rL(hEUhFjLubahIjubaubaubahIjKubj>)rL}rL(hEUhK}rL(hM]hN]hO]hP]hR]uhFjMLh@]rLhb)rL}rL(hEXx(:class:`session`, :class:`pid`, :class:`sysmeta`) ``->`` booleanrLhFjLhGjHhIhfhK}rL(hM]hN]hO]hP]hR]uhTK+h@]rL(h^X(rL}rL(hEX(hFjLubj)rL}rL(hEX:class:`session`rLhFjLhGjHhIjhK}rL(UreftypeXclassjjX Types.SessionU refdomainXpyrLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK+h@]rLj)rL}rL(hEjLhK}rL(hM]hN]rL(jjLXpy-classrLehO]hP]hR]uhFjLh@]rLh^XsessionrLrL}rL(hEUhFjLubahIjubaubh^X, rLrL}rL(hEX, hFjLubj)rL}rL(hEX:class:`pid`rLhFjLhGjHhIjhK}rL(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK+h@]rLj)rL}rL(hEjLhK}rL(hM]hN]rL(jjLXpy-classrLehO]hP]hR]uhFjLh@]rLh^XpidrLrL}rL(hEUhFjLubahIjubaubh^X, rLrL}rL(hEX, hFjLubj)rL}rL(hEX&:class:`sysmeta`rLhFjLhGjHhIjhK}rL(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrLhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK+h@]rLj)rL}rL(hEjLhK}rL(hM]hN]rL(jjLXpy-classrLehO]hP]hR]uhFjLh@]rLh^XsysmetarLrL}rL(hEUhFjLubahIjubaubh^X) rLrL}rL(hEX) hFjLubj)rL}rL(hEX``->``hK}rL(hM]hN]hO]hP]hR]uhFjLh@]rLh^X->rLrL}rL(hEUhFjLubahIjubh^X booleanrLrL}rL(hEX booleanhFjLubeubahIjKubehIj|ubehIjubehIjubeubj)rL}rL(hEUhFjHhGNhIjhK}rL(hP]hO]hM]hN]hR]Uentries]rL(jXcreate() (in module MNStorage)h!UNtrLauhTNhUhh@]ubj)rL}rL(hEUhFjHhGNhIjhK}rL(jjXpyrLhP]hO]hM]hN]hR]jXfunctionrLjjLuhTNhUhh@]rL(j)rL}rL(hEX0create(session,pid,object,sysmeta) -> IdentifierhFjLhGjHhIjhK}rL(hP]rLh!ajjHhO]hM]hN]hR]rLh!ajXcreaterLjUjuhTKghUhh@]rL(j)rL}rL(hEX MNStorage.hFjLhGjHhIjhK}rL(hM]hN]hO]hP]hR]uhTKghUhh@]rLh^X MNStorage.rLrL}rL(hEUhFjLubaubj)rL}rL(hEjLhFjLhGjHhIjhK}rL(hM]hN]hO]hP]hR]uhTKghUhh@]rLh^XcreaterLrL}rL(hEUhFjLubaubj)rL}rL(hEXsession, pid, object, sysmetahFjLhGjHhIjhK}rL(hM]hN]hO]hP]hR]uhTKghUhh@]rL(j)rL}rM(hEXsessionhK}rM(hM]hN]hO]hP]hR]uhFjLh@]rMh^XsessionrMrM}rM(hEUhFjLubahIjubj)rM}rM(hEXpidhK}rM(hM]hN]hO]hP]hR]uhFjLh@]r Mh^Xpidr Mr M}r M(hEUhFjMubahIjubj)r M}rM(hEXobjecthK}rM(hM]hN]hO]hP]hR]uhFjLh@]rMh^XobjectrMrM}rM(hEUhFj MubahIjubj)rM}rM(hEXsysmetahK}rM(hM]hN]hO]hP]hR]uhFjLh@]rMh^XsysmetarMrM}rM(hEUhFjMubahIjubeubj)rM}rM(hEX IdentifierhFjLhGjHhIjhK}rM(hM]hN]hO]hP]hR]uhTKghUhh@]rMh^X IdentifierrMr M}r!M(hEUhFjMubaubeubj)r"M}r#M(hEUhFjLhGjHhIj hK}r$M(hM]hN]hO]hP]hR]uhTKghUhh@]r%M(hb)r&M}r'M(hEX;Called by a client to adds a new object to the Member Node.r(MhFj"MhGjHhIhfhK}r)M(hM]hN]hO]hP]hR]uhTK2hUhh@]r*Mh^X;Called by a client to adds a new object to the Member Node.r+Mr,M}r-M(hEj(MhFj&Mubaubhb)r.M}r/M(hEXThe *pid* must not exist in the DataONE system or should have been previously reserved using :func:`CNCore.reserveIdentifier`. A new, unique :attr:`Types.SystemMetadata.seriesId` may be included.hFj"MhGjHhIhfhK}r0M(hM]hN]hO]hP]hR]uhTK4hUhh@]r1M(h^XThe r2Mr3M}r4M(hEXThe hFj.Mubj)r5M}r6M(hEX*pid*hK}r7M(hM]hN]hO]hP]hR]uhFj.Mh@]r8Mh^Xpidr9Mr:M}r;M(hEUhFj5MubahIjubh^XU must not exist in the DataONE system or should have been previously reserved using rM(hEXU must not exist in the DataONE system or should have been previously reserved using hFj.Mubj)r?M}r@M(hEX :func:`CNCore.reserveIdentifier`rAMhFj.MhGjHhIjhK}rBM(UreftypeXfuncjjXCNCore.reserveIdentifierU refdomainXpyrCMhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK4h@]rDMj)rEM}rFM(hEjAMhK}rGM(hM]hN]rHM(jjCMXpy-funcrIMehO]hP]hR]uhFj?Mh@]rJMh^XCNCore.reserveIdentifier()rKMrLM}rMM(hEUhFjEMubahIjubaubh^X. A new, unique rNMrOM}rPM(hEX. A new, unique hFj.Mubj)rQM}rRM(hEX%:attr:`Types.SystemMetadata.seriesId`rSMhFj.MhGjHhIjhK}rTM(UreftypeXattrjjXTypes.SystemMetadata.seriesIdU refdomainXpyrUMhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK4h@]rVMj)rWM}rXM(hEjSMhK}rYM(hM]hN]rZM(jjUMXpy-attrr[MehO]hP]hR]uhFjQMh@]r\Mh^XTypes.SystemMetadata.seriesIdr]Mr^M}r_M(hEUhFjWMubahIjubaubh^X may be included.r`MraM}rbM(hEX may be included.hFj.Mubeubhb)rcM}rdM(hEXQThe caller MUST have authorization to write or create content on the Member Node.reMhFj"MhGjHhIhfhK}rfM(hM]hN]hO]hP]hR]uhTK6hUhh@]rgMh^XQThe caller MUST have authorization to write or create content on the Member Node.rhMriM}rjM(hEjeMhFjcMubaubht)rkM}rlM(hEUhFj"MhGNhIhwhK}rmM(hM]hN]hO]hP]hR]uhTNhUhh@]rnM(hz)roM}rpM(hEUhFjkMhGjHhIh}hK}rqM(hM]hN]hO]hP]hR]uhTK8hUhh@]rrM(h)rsM}rtM(hEXVersionhFjoMhGjHhIhhK}ruM(hM]hN]hO]hP]hR]uhTKh@]rvMh^XVersionrwMrxM}ryM(hEUhFjsMubaubh)rzM}r{M(hEX1.0r|MhK}r}M(hM]hN]hO]hP]hR]uhFjoMh@]r~Mhb)rM}rM(hEj|MhFjzMhGjHhIhfhK}rM(hM]hN]hO]hP]hR]uhTK8h@]rMh^X1.0rMrM}rM(hEj|MhFjMubaubahIhubeubhz)rM}rM(hEUhFjkMhGjHhIh}hK}rM(hM]hN]hO]hP]hR]uhTK9hUhh@]rM(h)rM}rM(hEX Use CaseshFjMhGjHhIhhK}rM(hM]hN]hO]hP]hR]uhTKh@]rMh^X Use CasesrMrM}rM(hEUhFjMubaubh)rM}rM(hEXp:doc:`UC04 `, :doc:`UC09 `, :doc:`UC16 `rMhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rMhb)rM}rM(hEjMhFjMhGjHhIhfhK}rM(hM]hN]hO]hP]hR]uhTK:h@]rM(j)rM}rM(hEX$:doc:`UC04 `rMhFjMhGjHhIjhK}rM(UreftypeXdocrMjjX/design/UseCases/04_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK:h@]rMjr)rM}rM(hEjMhK}rM(hM]hN]rM(jjMehO]hP]hR]uhFjMh@]rMh^XUC04rMrM}rM(hEUhFjMubahIj{ubaubh^X, rMrM}rM(hEX, hFjMubj)rM}rM(hEX$:doc:`UC09 `rMhFjMhGjHhIjhK}rM(UreftypeXdocrMjjX/design/UseCases/09_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK:h@]rMjr)rM}rM(hEjMhK}rM(hM]hN]rM(jjMehO]hP]hR]uhFjMh@]rMh^XUC09rMrM}rM(hEUhFjMubahIj{ubaubh^X, rMrM}rM(hEX, hFjMubj)rM}rM(hEX$:doc:`UC16 `rMhFjMhGjHhIjhK}rM(UreftypeXdocrMjjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK:h@]rMjr)rM}rM(hEjMhK}rM(hM]hN]rM(jjMehO]hP]hR]uhFjMh@]rMh^XUC16rMrM}rM(hEUhFjMubahIj{ubaubeubahIhubeubhz)rM}rM(hEUhFjkMhGjHhIh}hK}rM(hM]hN]hO]hP]hR]uhTK;hUhh@]rM(h)rM}rM(hEXREST URLhFjMhGjHhIhhK}rM(hM]hN]hO]hP]hR]uhTKh@]rMh^XREST URLrMrM}rM(hEUhFjMubaubh)rM}rM(hEX``POST /object``rMhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rMhb)rM}rM(hEjMhFjMhGjHhIhfhK}rM(hM]hN]hO]hP]hR]uhTK;h@]rMj)rM}rM(hEjMhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rMh^X POST /objectrMrM}rM(hEUhFjMubahIjubaubahIhubeubhz)rM}rM(hEUhK}rM(hM]hN]hO]hP]hR]uhFjkMh@]rM(h)rM}rM(hEX ParametershFjMhGjHhIhhK}rM(hM]hN]hO]hP]hR]uhTKh@]rMh^X ParametersrMrM}rM(hEUhFjMubaubh)rM}rM(hEUhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rMj)rM}rM(hEUhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rM(j)rM}rM(hEUhK}rM(hM]hN]hO]hP]hR]uhFjMh@]rMhb)rM}rM(hEXTsession (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.hK}rM(hM]hN]hO]hP]hR]uhFjMh@]rM(j)rN}rN(hEXsessionhK}rN(hP]hO]jhM]hN]hR]uhFjMh@]rNh^XsessionrNrN}rN(hEUhFjNubahIjubh^X (rNrN}r N(hEUhFjMubj)r N}r N(hEX:class:`Types.Session`r NhFjMhGjHhIjhK}r N(UreftypeXclassjjX Types.SessionU refdomainXpyrNhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK=h@]rNj)rN}rN(hEj NhK}rN(hM]hN]rN(jjNXpy-classrNehO]hP]hR]uhFj Nh@]rNh^X Types.SessionrNrN}rN(hEUhFjNubahIjubaubh^X)rN}rN(hEUhFjMubh^X -- rNrN}rN(hEUhFjMubh^XSession 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}r N(hEXSession 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 hFjMubj)r!N}r"N(hEX:term:`public user`r#NhFjMhGjHhIjhK}r$N(UreftypeXtermjjX public userU refdomainXstdr%NhP]hO]U refexplicithM]hN]hR]jjuhTKNh^Xpidr?Nr@N}rAN(hEUhFj;NubahIjubh^X (rBNrCN}rDN(hEUhFj7Nubj)rEN}rFN(hEX:class:`Types.Identifier`rGNhFj7NhGjHhIjhK}rHN(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrINhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK@h@]rJNj)rKN}rLN(hEjGNhK}rMN(hM]hN]rNN(jjINXpy-classrONehO]hP]hR]uhFjENh@]rPNh^XTypes.IdentifierrQNrRN}rSN(hEUhFjKNubahIjubaubh^X)rTN}rUN(hEUhFj7Nubh^X -- rVNrWN}rXN(hEUhFj7Nubh^XThe 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 rYNrZN}r[N(hEXThe 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 hFj7Nubj)r\N}r]N(hEX:doc:`/design/PIDs`r^NhFj7NhGjHhIjhK}r_N(UreftypeXdocr`NjjX /design/PIDsU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK?h@]raNjr)rbN}rcN(hEj^NhK}rdN(hM]hN]reN(jj`NehO]hP]hR]uhFj\Nh@]rfNh^X /design/PIDsrgNrhN}riN(hEUhFjbNubahIj{ubaubh^X'. If the identifier is already in use, rjNrkN}rlN(hEX'. If the identifier is already in use, hFj7Nubj)rmN}rnN(hEX%:exc:`Exceptions.IdentifierNotUnique`roNhFj7NhGjHhIjhK}rpN(UreftypeXexcjjXExceptions.IdentifierNotUniqueU refdomainXpyrqNhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK?h@]rrNj)rsN}rtN(hEjoNhK}ruN(hM]hN]rvN(jjqNXpy-excrwNehO]hP]hR]uhFjmNh@]rxNh^XExceptions.IdentifierNotUniqueryNrzN}r{N(hEUhFjsNubahIjubaubh^Xy will be raised and the client SHOULD try again with a different, unique identifier. Transmitted as a UTF-8 String as a r|Nr}N}r~N(hEXy will be raised and the client SHOULD try again with a different, unique identifier. Transmitted as a UTF-8 String as a hFj7Nubj)rN}rN(hEX *Param part*hK}rN(hM]hN]hO]hP]hR]uhFj7Nh@]rNh^X Param partrNrN}rN(hEUhFjNubahIjubh^X% of the MIME multipart/mixed message.rNrN}rN(hEX% of the MIME multipart/mixed message.hFj7NubehIhfubahIjubj)rN}rN(hEUhK}rN(hM]hN]hO]hP]hR]uhFjMh@]rNhb)rN}rN(hEXIobject (bytes) -- The data bytes that are to be added to the Member Node.hK}rN(hM]hN]hO]hP]hR]uhFjNh@]rN(j)rN}rN(hEXobjecthK}rN(hP]hO]jhM]hN]hR]uhFjNh@]rNh^XobjectrNrN}rN(hEUhFjNubahIjubh^X (rNrN}rN(hEUhFjNubj)rN}rN(hEUhK}rN(UreftypejjU reftargetXbytesrNU refdomainjLhP]hO]U refexplicithM]hN]hR]uhFjNh@]rNj)rN}rN(hEjNhK}rN(hM]hN]hO]hP]hR]uhFjNh@]rNh^XbytesrNrN}rN(hEUhFjNubahIjubahIjubh^X)rN}rN(hEUhFjNubh^X -- rNrN}rN(hEUhFjNubh^X7The data bytes that are to be added to the Member Node.rNrN}rN(hEX7The data bytes that are to be added to the Member Node.rNhFjNubehIhfubahIjubj)rN}rN(hEUhK}rN(hM]hN]hO]hP]hR]uhFjMh@]rNhb)rN}rN(hEXcsysmeta (Types.SystemMetadata) -- The system metadata document that provides basic information about the object, including a reference to its identifier, access control information, etc. Attributes of the sysmeta that are the responsibility of the client MUST be set. Note that the obsoletes and obsoletedBy elements MUST not be set. It is the role of the update() method to ensure these are properly updated to ensure object lineage is as expected. 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.hK}rN(hM]hN]hO]hP]hR]uhFjNh@]rN(j)rN}rN(hEXsysmetahK}rN(hP]hO]jhM]hN]hR]uhFjNh@]rNh^XsysmetarNrN}rN(hEUhFjNubahIjubh^X (rNrN}rN(hEUhFjNubj)rN}rN(hEX:class:`Types.SystemMetadata`rNhFjNhGjHhIjhK}rN(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrNhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKFh@]rNj)rN}rN(hEjNhK}rN(hM]hN]rN(jjNXpy-classrNehO]hP]hR]uhFjNh@]rNh^XTypes.SystemMetadatarNrN}rN(hEUhFjNubahIjubaubh^X)rN}rN(hEUhFjNubh^X -- rNrN}rN(hEUhFjNubh^XThe system metadata document that provides basic information about the object, including a reference to its identifier, access control information, etc. Attributes of the sysmeta that are the responsibility of the client MUST be set. Note that the obsoletes and obsoletedBy elements MUST not be set. It is the role of the update() method to ensure these are properly updated to ensure object lineage is as expected. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rNrN}rN(hEXThe system metadata document that provides basic information about the object, including a reference to its identifier, access control information, etc. Attributes of the sysmeta that are the responsibility of the client MUST be set. Note that the obsoletes and obsoletedBy elements MUST not be set. It is the role of the update() method to ensure these are properly updated to ensure object lineage is as expected. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hFjNubj)rN}rN(hEX *File part*hK}rN(hM]hN]hO]hP]hR]uhFjNh@]rNh^X File partrNrN}rN(hEUhFjNubahIjubh^X% of the MIME multipart/mixed message.rNrN}rN(hEX% of the MIME multipart/mixed message.hFjNubehIhfubahIjubehIjmubahIhubehIh}ubhz)rN}rN(hEUhK}rN(hM]hN]hO]hP]hR]uhFjkMh@]rN(h)rN}rN(hEXReturnshFjNhGjHhIhhK}rN(hM]hN]hO]hP]hR]uhTKh@]rNh^XReturnsrNrN}rN(hEUhFjNubaubh)rN}rN(hEUhK}rN(hM]hN]hO]hP]hR]uhFjNh@]rNhb)rN}rN(hEXDThe identifier that was used to insert the document into the system.hK}rN(hM]hN]hO]hP]hR]uhFjNh@]rNh^XDThe identifier that was used to insert the document into the system.rNrN}rN(hEXDThe identifier that was used to insert the document into the system.rNhFjNubahIhfubahIhubehIh}ubhz)rN}rN(hEUhK}rN(hM]hN]hO]hP]hR]uhFjkMh@]rN(h)rN}rN(hEX Return typehFjNhGjHhIhhK}rO(hM]hN]hO]hP]hR]uhTKh@]rOh^X Return typerOrO}rO(hEUhFjNubaubh)rO}rO(hEUhK}rO(hM]hN]hO]hP]hR]uhFjNh@]rOhb)r O}r O(hEXTypes.IdentifierhK}r O(hM]hN]hO]hP]hR]uhFjOh@]r Oj)r O}rO(hEX:class:`Types.Identifier`rOhFj OhGjHhIjhK}rO(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrOhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKIh@]rOj)rO}rO(hEjOhK}rO(hM]hN]rO(jjOXpy-classrOehO]hP]hR]uhFj Oh@]rOh^XTypes.IdentifierrOrO}rO(hEUhFjOubahIjubaubahIhfubahIhubehIh}ubhz)rO}rO(hEUhK}rO(hM]hN]hO]hP]hR]uhFjkMh@]rO(h)r O}r!O(hEXRaiseshFjOhGjHhIhhK}r"O(hM]hN]hO]hP]hR]uhTKh@]r#Oh^XRaisesr$Or%O}r&O(hEUhFj Oubaubh)r'O}r(O(hEUhK}r)O(hM]hN]hO]hP]hR]uhFjOh@]r*Oj)r+O}r,O(hEUhK}r-O(hM]hN]hO]hP]hR]uhFj'Oh@]r.O(j)r/O}r0O(hEUhK}r1O(hM]hN]hO]hP]hR]uhFj+Oh@]r2Ohb)r3O}r4O(hEXExceptions.NotAuthorized -- (errorCode=401, detailCode=1100)The provided identity does not have permission to WRITE to the Member Node.hK}r5O(hM]hN]hO]hP]hR]uhFj/Oh@]r6O(j)r7O}r8O(hEUhK}r9O(UreftypejjU reftargetXExceptions.NotAuthorizedr:OU refdomainjLhP]hO]U refexplicithM]hN]hR]uhFj3Oh@]r;Oj)rO(hM]hN]hO]hP]hR]uhFj7Oh@]r?Oh^XExceptions.NotAuthorizedr@OrAO}rBO(hEUhFjP}r?P(hEUhK}r@P(UreftypejjU reftargetXExceptions.InvalidTokenrAPU refdomainjLhP]hO]U refexplicithM]hN]hR]uhFj:Ph@]rBPj)rCP}rDP(hEjAPhK}rEP(hM]hN]hO]hP]hR]uhFj>Ph@]rFPh^XExceptions.InvalidTokenrGPrHP}rIP(hEUhFjCPubahIjubahIjubh^X -- rJPrKP}rLP(hEUhFj:Pubj)rMP}rNP(hEX$``(errorCode=401, detailCode=1110)``rOPhK}rPP(hM]hN]hO]hP]hR]uhFj:Ph@]rQPh^X (errorCode=401, detailCode=1110)rRPrSP}rTP(hEUhFjMPubahIjubehIhfubahIjubj)rUP}rVP(hEUhK}rWP(hM]hN]hO]hP]hR]uhFj+Oh@]rXPhb)rYP}rZP(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=1101)hK}r[P(hM]hN]hO]hP]hR]uhFjUPh@]r\P(j)r]P}r^P(hEUhK}r_P(UreftypejjU reftargetXExceptions.NotImplementedr`PU refdomainjLhP]hO]U refexplicithM]hN]hR]uhFjYPh@]raPj)rbP}rcP(hEj`PhK}rdP(hM]hN]hO]hP]hR]uhFj]Ph@]rePh^XExceptions.NotImplementedrfPrgP}rhP(hEUhFjbPubahIjubahIjubh^X -- riPrjP}rkP(hEUhFjYPubj)rlP}rmP(hEX$``(errorCode=501, detailCode=1101)``rnPhK}roP(hM]hN]hO]hP]hR]uhFjYPh@]rpPh^X (errorCode=501, detailCode=1101)rqPrrP}rsP(hEUhFjlPubahIjubehIhfubahIjubj)rtP}ruP(hEUhK}rvP(hM]hN]hO]hP]hR]uhFj+Oh@]rwPhb)rxP}ryP(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=1102)hK}rzP(hM]hN]hO]hP]hR]uhFjtPh@]r{P(j)r|P}r}P(hEUhK}r~P(UreftypejjU reftargetXExceptions.InvalidRequestrPU refdomainjLhP]hO]U refexplicithM]hN]hR]uhFjxPh@]rPj)rP}rP(hEjPhK}rP(hM]hN]hO]hP]hR]uhFj|Ph@]rPh^XExceptions.InvalidRequestrPrP}rP(hEUhFjPubahIjubahIjubh^X -- rPrP}rP(hEUhFjxPubj)rP}rP(hEX$``(errorCode=400, detailCode=1102)``rPhK}rP(hM]hN]hO]hP]hR]uhFjxPh@]rPh^X (errorCode=400, detailCode=1102)rPrP}rP(hEUhFjPubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubhb)rP}rP(hEX **Examples**rPhFjHhGjXsource/apis/examples/create.txtrPrP}rPbhIhfhK}rP(hM]hN]hO]hP]hR]uhTKhUhh@]rPj|)rP}rP(hEjPhK}rP(hM]hN]hO]hP]hR]uhFjPh@]rPh^XExamplesrPrP}rP(hEUhFjPubahIjubaubhb)rP}rP(hEXThe outgoing request body *must* be encoded as `MIME multipart/form-data`_ with the system metadata portion and the object as file attachments.hFjHhGjPhIhfhK}rP(hM]hN]hO]hP]hR]uhTKhUhh@]rP(h^XThe outgoing request body rPrP}rP(hEXThe outgoing request body hFjPubj)rP}rP(hEX*must*hK}rP(hM]hN]hO]hP]hR]uhFjPh@]rPh^XmustrPrP}rP(hEUhFjPubahIjubh^X be encoded as rPrP}rP(hEX be encoded as hFjPubj,)rP}rP(hEX`MIME multipart/form-data`_jYKhFjPhIj5hK}rP(UnameXMIME multipart/form-dataj\X#http://www.ietf.org/rfc/rfc2388.txtrPhP]hO]hM]hN]hR]uh@]rPh^XMIME multipart/form-datarPrP}rP(hEUhFjPubaubh^XE with the system metadata portion and the object as file attachments.rPrP}rP(hEXE with the system metadata portion and the object as file attachments.hFjPubeubhb)rP}rP(hEXA(POST) Create a new object with a given identifier (*XYZ33256*)::rPhFjHhGjPhIhfhK}rP(hM]hN]hO]hP]hR]uhTKhUhh@]rP(h^X4(POST) Create a new object with a given identifier (rPrP}rP(hEX4(POST) Create a new object with a given identifier (hFjPubj)rP}rP(hEX *XYZ33256*hK}rP(hM]hN]hO]hP]hR]uhFjPh@]rPh^XXYZ33256rPrP}rP(hEUhFjPubahIjubh^X):rPrP}rP(hEX):hFjPubeubj)rP}rP(hEX curl -E /tmp/x509up_u502 \ -F "pid=XYZ33256" \ -F "object=@sciencemetadata.xml" \ -F "sysmeta=@sysmeta.xml" \ https://m1.dataone.org/mn/v1/object HTTP/1.1 200 Success Content-Type: Date: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 355 XYZ33256hFjHhGjPhIjhK}rP(hhhP]hO]hM]hN]hR]uhTM6hUhh@]rPh^X curl -E /tmp/x509up_u502 \ -F "pid=XYZ33256" \ -F "object=@sciencemetadata.xml" \ -F "sysmeta=@sysmeta.xml" \ https://m1.dataone.org/mn/v1/object HTTP/1.1 200 Success Content-Type: Date: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 355 XYZ33256rPrP}rP(hEUhFjPubaubhb)rP}rP(hEXThe system metadata included with the create call must contain values for the elements required to be set by clients (see :doc:`/design/SystemMetadata`). The system metadata document can be crafted by hand or preferably with a tool such as *generate_sysmeta.py* which is available in the d1_instance_generator_ Python package. See documentation included with that package for more information on its operation.hFjHhGjPhIhfhK}rP(hM]hN]hO]hP]hR]uhTKhUhh@]rP(h^XzThe system metadata included with the create call must contain values for the elements required to be set by clients (see rPrP}rP(hEXzThe system metadata included with the create call must contain values for the elements required to be set by clients (see hFjPubj)rP}rP(hEX:doc:`/design/SystemMetadata`rPhFjPhGjPhIjhK}rP(UreftypeXdocrPjjX/design/SystemMetadataU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKh@]rPjr)rP}rP(hEjPhK}rP(hM]hN]rP(jjPehO]hP]hR]uhFjPh@]rPh^X/design/SystemMetadatarPrP}rP(hEUhFjPubahIj{ubaubh^XY). The system metadata document can be crafted by hand or preferably with a tool such as rPrP}rP(hEXY). The system metadata document can be crafted by hand or preferably with a tool such as hFjPubj)rP}rP(hEX*generate_sysmeta.py*hK}rP(hM]hN]hO]hP]hR]uhFjPh@]rPh^Xgenerate_sysmeta.pyrPrP}rP(hEUhFjPubahIjubh^X which is available in the rPrP}rP(hEX which is available in the hFjPubj,)rP}rP(hEXd1_instance_generator_jYKhFjPhIj5hK}rP(UnameXd1_instance_generatorrPj\XJhttps://repository.dataone.org/software/cicore/trunk/d1_instance_generatorrPhP]hO]hM]hN]hR]uh@]rPh^Xd1_instance_generatorrPrQ}rQ(hEUhFjPubaubh^Xd Python package. See documentation included with that package for more information on its operation.rQrQ}rQ(hEXd Python package. See documentation included with that package for more information on its operation.hFjPubeubhb)rQ}rQ(hEXnFor example, the system metadata document for the example above was generated using the sequence of commands::hFjHhGjPhIhfhK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQh^XmFor example, the system metadata document for the example above was generated using the sequence of commands:r Qr Q}r Q(hEXmFor example, the system metadata document for the example above was generated using the sequence of commands:hFjQubaubj)r Q}r Q(hEX<> MYSUBJECT=`python my_subject.py /tmp/x509up_u502` echo $MYSUBJECT CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org python generate_sysmeta.py -f sciencemetadata.xml \ -i "XYZ33256" \ -s "$MYSUBJECT" \ -t "eml://ecoinformatics.org/eml-2.0.1" \ > sysmeta.xmlhFjHhGjPhIjhK}rQ(hhhP]hO]hM]hN]hR]uhTMMhUhh@]rQh^X<> MYSUBJECT=`python my_subject.py /tmp/x509up_u502` echo $MYSUBJECT CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org python generate_sysmeta.py -f sciencemetadata.xml \ -i "XYZ33256" \ -s "$MYSUBJECT" \ -t "eml://ecoinformatics.org/eml-2.0.1" \ > sysmeta.xmlrQrQ}rQ(hEUhFj Qubaubhb)rQ}rQ(hEXSThe generated system metadata document contains default information that indicates:rQhFjHhGjPhIhfhK}rQ(hM]hN]hO]hP]hR]uhTK-hUhh@]rQh^XSThe generated system metadata document contains default information that indicates:rQrQ}rQ(hEjQhFjQubaubj)rQ}rQ(hEUhFjHhGjPhIjmhK}rQ(UbulletrQX-hP]hO]hM]hN]hR]uhTK/hUhh@]rQ(j)r Q}r!Q(hEXJThe submitter is ``CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org``r"QhFjQhGjPhIjhK}r#Q(hM]hN]hO]hP]hR]uhTNhUhh@]r$Qhb)r%Q}r&Q(hEj"QhFj QhGjPhIhfhK}r'Q(hM]hN]hO]hP]hR]uhTK/h@]r(Q(h^XThe submitter is r)Qr*Q}r+Q(hEXThe submitter is hFj%Qubj)r,Q}r-Q(hEX9``CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org``hK}r.Q(hM]hN]hO]hP]hR]uhFj%Qh@]r/Qh^X5CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=orgr0Qr1Q}r2Q(hEUhFj,QubahIjubeubaubj)r3Q}r4Q(hEX.The rights holder is the same as the submitterr5QhFjQhGjPhIjhK}r6Q(hM]hN]hO]hP]hR]uhTNhUhh@]r7Qhb)r8Q}r9Q(hEj5QhFj3QhGjPhIhfhK}r:Q(hM]hN]hO]hP]hR]uhTK0h@]r;Qh^X.The rights holder is the same as the submitterrQ(hEj5QhFj8Qubaubaubj)r?Q}r@Q(hEXCThe access policy indicates public read, and write by the submitterrAQhFjQhGjPhIjhK}rBQ(hM]hN]hO]hP]hR]uhTNhUhh@]rCQhb)rDQ}rEQ(hEjAQhFj?QhGjPhIhfhK}rFQ(hM]hN]hO]hP]hR]uhTK1h@]rGQh^XCThe access policy indicates public read, and write by the submitterrHQrIQ}rJQ(hEjAQhFjDQubaubaubj)rKQ}rLQ(hEXDThe replication policy indicates replication is allowed to any node hFjQhGjPhIjhK}rMQ(hM]hN]hO]hP]hR]uhTNhUhh@]rNQhb)rOQ}rPQ(hEXCThe replication policy indicates replication is allowed to any noderQQhFjKQhGjPhIhfhK}rRQ(hM]hN]hO]hP]hR]uhTK2h@]rSQh^XCThe replication policy indicates replication is allowed to any noderTQrUQ}rVQ(hEjQQhFjOQubaubaubeubhb)rWQ}rXQ(hEX;The generated system metadata document is presented below::rYQhFjHhGjPhIhfhK}rZQ(hM]hN]hO]hP]hR]uhTK4hUhh@]r[Qh^X:The generated system metadata document is presented below:r\Qr]Q}r^Q(hEX:The generated system metadata document is presented below:hFjWQubaubj)r_Q}r`Q(hEX XYZ33256 eml://ecoinformatics.org/eml-2.0.1 22936 2ec0084d1e11e0d5c9a46ba6a230aa85 CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org public read CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org changePermission 2012-02-20T20:39:19.664495 2012-02-20T20:39:19.70598 hFjHhGjPhIjhK}raQ(hhhP]hO]hM]hN]hR]uhTMdhUhh@]rbQh^X XYZ33256 eml://ecoinformatics.org/eml-2.0.1 22936 2ec0084d1e11e0d5c9a46ba6a230aa85 CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org public read CN=Dave Vieglais T799,O=Google,C=US,DC=cilogon,DC=org changePermission 2012-02-20T20:39:19.664495 2012-02-20T20:39:19.70598 rcQrdQ}reQ(hEUhFj_Qubaubje)rfQ}rgQ(hEXe.. _d1_instance_generator: https://repository.dataone.org/software/cicore/trunk/d1_instance_generatorjhKhFjHhGjPhIjihK}rhQ(j\jPhP]riQh6ahO]hM]hN]hR]rjQhauhTM|hUhh@]ubj)rkQ}rlQ(hEUhFjHhGNhIjhK}rmQ(hP]hO]hM]hN]hR]Uentries]rnQ(jXupdate() (in module MNStorage)h UNtroQauhTNhUhh@]ubj)rpQ}rqQ(hEUhFjHhGNhIjhK}rrQ(jjXpyrsQhP]hO]hM]hN]hR]jXfunctionrtQjjtQuhTNhUhh@]ruQ(j)rvQ}rwQ(hEX7update(session,pid,object,newPid,sysmeta) -> IdentifierhFjpQhGjHhIjhK}rxQ(hP]ryQh ajjHhO]hM]hN]hR]rzQh ajXupdater{QjUjuhTKhUhh@]r|Q(j)r}Q}r~Q(hEX MNStorage.hFjvQhGjHhIjhK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQh^X MNStorage.rQrQ}rQ(hEUhFj}Qubaubj)rQ}rQ(hEj{QhFjvQhGjHhIjhK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQh^XupdaterQrQ}rQ(hEUhFjQubaubj)rQ}rQ(hEX%session, pid, object, newPid, sysmetahFjvQhGjHhIjhK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQ(j)rQ}rQ(hEXsessionhK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XsessionrQrQ}rQ(hEUhFjQubahIjubj)rQ}rQ(hEXpidhK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XpidrQrQ}rQ(hEUhFjQubahIjubj)rQ}rQ(hEXobjecthK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XobjectrQrQ}rQ(hEUhFjQubahIjubj)rQ}rQ(hEXnewPidhK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XnewPidrQrQ}rQ(hEUhFjQubahIjubj)rQ}rQ(hEXsysmetahK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XsysmetarQrQ}rQ(hEUhFjQubahIjubeubj)rQ}rQ(hEX IdentifierhFjvQhGjHhIjhK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQh^X IdentifierrQrQ}rQ(hEUhFjQubaubeubj)rQ}rQ(hEUhFjpQhGjHhIj hK}rQ(hM]hN]hO]hP]hR]uhTKhUhh@]rQ(hb)rQ}rQ(hEXCThis method is called by clients to update objects on Member Nodes.rQhFjQhGjHhIhfhK}rQ(hM]hN]hO]hP]hR]uhTKohUhh@]rQh^XCThis method is called by clients to update objects on Member Nodes.rQrQ}rQ(hEjQhFjQubaubhb)rQ}rQ(hEXUpdates an existing object by creating a new object identified by *newPid* on the Member Node which explicitly obsoletes the object identified by *pid* through appropriate changes to the SystemMetadata of *pid* and *newPid*.hFjQhGjHhIhfhK}rQ(hM]hN]hO]hP]hR]uhTKqhUhh@]rQ(h^XBUpdates an existing object by creating a new object identified by rQrQ}rQ(hEXBUpdates an existing object by creating a new object identified by hFjQubj)rQ}rQ(hEX*newPid*hK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XnewPidrQrQ}rQ(hEUhFjQubahIjubh^XH on the Member Node which explicitly obsoletes the object identified by rQrQ}rQ(hEXH on the Member Node which explicitly obsoletes the object identified by hFjQubj)rQ}rQ(hEX*pid*hK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XpidrQrQ}rQ(hEUhFjQubahIjubh^X6 through appropriate changes to the SystemMetadata of rQrQ}rQ(hEX6 through appropriate changes to the SystemMetadata of hFjQubj)rQ}rQ(hEX*pid*hK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XpidrQrQ}rQ(hEUhFjQubahIjubh^X and rQrQ}rQ(hEX and hFjQubj)rQ}rQ(hEX*newPid*hK}rQ(hM]hN]hO]hP]hR]uhFjQh@]rQh^XnewPidrQrQ}rQ(hEUhFjQubahIjubh^X.rQ}rQ(hEX.hFjQubeubhb)rQ}rQ(hEXThe Member Node sets :attr:`Types.SystemMetadata.obsoletedBy` on the object being obsoleted to the *pid* of the new object. It then updates :attr:`Types.SystemMetadata.dateSysMetadataModified` on both the new and old objects. The modified system metadata entries then become available in :func:`MNRead.listObjects`. This ensures that a Coordinating Node will pick up the changes when filtering on :attr:`Types.SystemMetadata.dateSysMetadataModified`.hFjQhGjHhIhfhK}rQ(hM]hN]hO]hP]hR]uhTKshUhh@]rQ(h^XThe Member Node sets rQrQ}rQ(hEXThe Member Node sets hFjQubj)rQ}rQ(hEX(:attr:`Types.SystemMetadata.obsoletedBy`rQhFjQhGjHhIjhK}rQ(UreftypeXattrjjX Types.SystemMetadata.obsoletedByU refdomainXpyrQhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKsh@]rQj)rR}rR(hEjQhK}rR(hM]hN]rR(jjQXpy-attrrRehO]hP]hR]uhFjQh@]rRh^X Types.SystemMetadata.obsoletedByrRrR}rR(hEUhFjRubahIjubaubh^X& on the object being obsoleted to the r Rr R}r R(hEX& on the object being obsoleted to the hFjQubj)r R}r R(hEX*pid*hK}rR(hM]hN]hO]hP]hR]uhFjQh@]rRh^XpidrRrR}rR(hEUhFj RubahIjubh^X$ of the new object. It then updates rRrR}rR(hEX$ of the new object. It then updates hFjQubj)rR}rR(hEX4:attr:`Types.SystemMetadata.dateSysMetadataModified`rRhFjQhGjHhIjhK}rR(UreftypeXattrjjX,Types.SystemMetadata.dateSysMetadataModifiedU refdomainXpyrRhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKsh@]rRj)rR}rR(hEjRhK}rR(hM]hN]rR(jjRXpy-attrr RehO]hP]hR]uhFjRh@]r!Rh^X,Types.SystemMetadata.dateSysMetadataModifiedr"Rr#R}r$R(hEUhFjRubahIjubaubh^X` on both the new and old objects. The modified system metadata entries then become available in r%Rr&R}r'R(hEX` on both the new and old objects. The modified system metadata entries then become available in hFjQubj)r(R}r)R(hEX:func:`MNRead.listObjects`r*RhFjQhGjHhIjhK}r+R(UreftypeXfuncjjXMNRead.listObjectsU refdomainXpyr,RhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKsh@]r-Rj)r.R}r/R(hEj*RhK}r0R(hM]hN]r1R(jj,RXpy-funcr2RehO]hP]hR]uhFj(Rh@]r3Rh^XMNRead.listObjects()r4Rr5R}r6R(hEUhFj.RubahIjubaubh^XS. This ensures that a Coordinating Node will pick up the changes when filtering on r7Rr8R}r9R(hEXS. This ensures that a Coordinating Node will pick up the changes when filtering on hFjQubj)r:R}r;R(hEX4:attr:`Types.SystemMetadata.dateSysMetadataModified`rRhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKsh@]r?Rj)r@R}rAR(hEjRXpy-attrrDRehO]hP]hR]uhFj:Rh@]rERh^X,Types.SystemMetadata.dateSysMetadataModifiedrFRrGR}rHR(hEUhFj@RubahIjubaubh^X.rIR}rJR(hEX.hFjQubeubhb)rKR}rLR(hEXThe update operation MUST fail with :exc:`Exceptions.InvalidRequest` on objects that have the :attr:`Types.SystemMetadata.archived` property set to true.hFjQhGjHhIhfhK}rMR(hM]hN]hO]hP]hR]uhTKuhUhh@]rNR(h^X$The update operation MUST fail with rORrPR}rQR(hEX$The update operation MUST fail with hFjKRubj)rRR}rSR(hEX :exc:`Exceptions.InvalidRequest`rTRhFjKRhGjHhIjhK}rUR(UreftypeXexcjjXExceptions.InvalidRequestU refdomainXpyrVRhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKuh@]rWRj)rXR}rYR(hEjTRhK}rZR(hM]hN]r[R(jjVRXpy-excr\RehO]hP]hR]uhFjRRh@]r]Rh^XExceptions.InvalidRequestr^Rr_R}r`R(hEUhFjXRubahIjubaubh^X on objects that have the raRrbR}rcR(hEX on objects that have the hFjKRubj)rdR}reR(hEX%:attr:`Types.SystemMetadata.archived`rfRhFjKRhGjHhIjhK}rgR(UreftypeXattrjjXTypes.SystemMetadata.archivedU refdomainXpyrhRhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKuh@]riRj)rjR}rkR(hEjfRhK}rlR(hM]hN]rmR(jjhRXpy-attrrnRehO]hP]hR]uhFjdRh@]roRh^XTypes.SystemMetadata.archivedrpRrqR}rrR(hEUhFjjRubahIjubaubh^X property set to true.rsRrtR}ruR(hEX property set to true.hFjKRubeubhb)rvR}rwR(hEXA new, unique :attr:`Types.SystemMetadata.seriesId` may be included when beginning a series, or a series may be extended if the newPid obsoletes the existing pid.hFjQhGjHhIhfhK}rxR(hM]hN]hO]hP]hR]uhTKwhUhh@]ryR(h^XA new, unique rzRr{R}r|R(hEXA new, unique hFjvRubj)r}R}r~R(hEX%:attr:`Types.SystemMetadata.seriesId`rRhFjvRhGjHhIjhK}rR(UreftypeXattrjjXTypes.SystemMetadata.seriesIdU refdomainXpyrRhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKwh@]rRj)rR}rR(hEjRhK}rR(hM]hN]rR(jjRXpy-attrrRehO]hP]hR]uhFj}Rh@]rRh^XTypes.SystemMetadata.seriesIdrRrR}rR(hEUhFjRubahIjubaubh^Xo may be included when beginning a series, or a series may be extended if the newPid obsoletes the existing pid.rRrR}rR(hEXo may be included when beginning a series, or a series may be extended if the newPid obsoletes the existing pid.hFjvRubeubht)rR}rR(hEUhFjQhGNhIhwhK}rR(hM]hN]hO]hP]hR]uhTNhUhh@]rR(hz)rR}rR(hEUhFjRhGjHhIh}hK}rR(hM]hN]hO]hP]hR]uhTKyhUhh@]rR(h)rR}rR(hEXVersionhFjRhGjHhIhhK}rR(hM]hN]hO]hP]hR]uhTKh@]rRh^XVersionrRrR}rR(hEUhFjRubaubh)rR}rR(hEX1.0rRhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRhb)rR}rR(hEjRhFjRhGjHhIhfhK}rR(hM]hN]hO]hP]hR]uhTKyh@]rRh^X1.0rRrR}rR(hEjRhFjRubaubahIhubeubhz)rR}rR(hEUhFjRhGjHhIh}hK}rR(hM]hN]hO]hP]hR]uhTKzhUhh@]rR(h)rR}rR(hEX Use CaseshFjRhGjHhIhhK}rR(hM]hN]hO]hP]hR]uhTKh@]rRh^X Use CasesrRrR}rR(hEUhFjRubaubh)rR}rR(hEX$:doc:`UC16 `rRhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRhb)rR}rR(hEjRhFjRhGjHhIhfhK}rR(hM]hN]hO]hP]hR]uhTK{h@]rRj)rR}rR(hEjRhFjRhGjHhIjhK}rR(UreftypeXdocrRjjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK{h@]rRjr)rR}rR(hEjRhK}rR(hM]hN]rR(jjRehO]hP]hR]uhFjRh@]rRh^XUC16rRrR}rR(hEUhFjRubahIj{ubaubaubahIhubeubhz)rR}rR(hEUhFjRhGjHhIh}hK}rR(hM]hN]hO]hP]hR]uhTK|hUhh@]rR(h)rR}rR(hEXREST URLhFjRhGjHhIhhK}rR(hM]hN]hO]hP]hR]uhTKh@]rRh^XREST URLrRrR}rR(hEUhFjRubaubh)rR}rR(hEX``PUT /object/{pid}``rRhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRhb)rR}rR(hEjRhFjRhGjHhIhfhK}rR(hM]hN]hO]hP]hR]uhTK|h@]rRj)rR}rR(hEjRhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRh^XPUT /object/{pid}rRrR}rR(hEUhFjRubahIjubaubahIhubeubhz)rR}rR(hEUhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rR(h)rR}rR(hEX ParametershFjRhGjHhIhhK}rR(hM]hN]hO]hP]hR]uhTKh@]rRh^X ParametersrRrR}rR(hEUhFjRubaubh)rR}rR(hEUhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRj)rR}rR(hEUhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rR(j)rR}rR(hEUhK}rR(hM]hN]hO]hP]hR]uhFjRh@]rRhb)rR}rR(hEXTsession (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.hK}rR(hM]hN]hO]hP]hR]uhFjRh@]rS(j)rS}rS(hEXsessionhK}rS(hP]hO]jhM]hN]hR]uhFjRh@]rSh^XsessionrSrS}rS(hEUhFjSubahIjubh^X (rSr S}r S(hEUhFjRubj)r S}r S(hEX:class:`Types.Session`r ShFjRhGjHhIjhK}rS(UreftypeXclassjjX Types.SessionU refdomainXpyrShP]hO]U refexplicithM]hN]hR]jjjNjjHuhTK~h@]rSj)rS}rS(hEj ShK}rS(hM]hN]rS(jjSXpy-classrSehO]hP]hR]uhFj Sh@]rSh^X Types.SessionrSrS}rS(hEUhFjSubahIjubaubh^X)rS}rS(hEUhFjRubh^X -- rSrS}rS(hEUhFjRubh^XSession 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 rSr S}r!S(hEXSession 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 hFjRubj)r"S}r#S(hEX:term:`public user`r$ShFjRhGjHhIjhK}r%S(UreftypeXtermjjX public userU refdomainXstdr&ShP]hO]U refexplicithM]hN]hR]jjuhTK}h@]r'Sjr)r(S}r)S(hEj$ShK}r*S(hM]hN]r+S(jj&SXstd-termr,SehO]hP]hR]uhFj"Sh@]r-Sh^X public userr.Sr/S}r0S(hEUhFj(SubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r1Sr2S}r3S(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFjRubehIhfubahIjubj)r4S}r5S(hEUhK}r6S(hM]hN]hO]hP]hR]uhFjRh@]r7Shb)r8S}r9S(hEX&pid (Types.Identifier) -- The identifier of the object that is being updated. If this identifier does not exist in the system, an error is raised and the operation does not cause any changes to the objects or their metadata. Transmitted as part of the URL path and must be escaped accordingly.hK}r:S(hM]hN]hO]hP]hR]uhFj4Sh@]r;S(j)rS(hP]hO]jhM]hN]hR]uhFj8Sh@]r?Sh^Xpidr@SrAS}rBS(hEUhFjTj)r?T}r@T(hEX:class:`Types.Identifier`rAThFj;ThGjHhIjhK}rBT(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrCThP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rDTj)rET}rFT(hEjAThK}rGT(hM]hN]rHT(jjCTXpy-classrITehO]hP]hR]uhFj?Th@]rJTh^XTypes.IdentifierrKTrLT}rMT(hEUhFjETubahIjubaubahIhfubahIhubehIh}ubhz)rNT}rOT(hEUhK}rPT(hM]hN]hO]hP]hR]uhFjRh@]rQT(h)rRT}rST(hEXRaiseshFjNThGjHhIhhK}rTT(hM]hN]hO]hP]hR]uhTKh@]rUTh^XRaisesrVTrWT}rXT(hEUhFjRTubaubh)rYT}rZT(hEUhK}r[T(hM]hN]hO]hP]hR]uhFjNTh@]r\Tj)r]T}r^T(hEUhK}r_T(hM]hN]hO]hP]hR]uhFjYTh@]r`T(j)raT}rbT(hEUhK}rcT(hM]hN]hO]hP]hR]uhFj]Th@]rdThb)reT}rfT(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=1200)hK}rgT(hM]hN]hO]hP]hR]uhFjaTh@]rhT(j)riT}rjT(hEUhK}rkT(UreftypejjU reftargetXExceptions.NotAuthorizedrlTU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFjeTh@]rmTj)rnT}roT(hEjlThK}rpT(hM]hN]hO]hP]hR]uhFjiTh@]rqTh^XExceptions.NotAuthorizedrrTrsT}rtT(hEUhFjnTubahIjubahIjubh^X -- ruTrvT}rwT(hEUhFjeTubj)rxT}ryT(hEX$``(errorCode=401, detailCode=1200)``hK}rzT(hM]hN]hO]hP]hR]uhFjeTh@]r{Th^X (errorCode=401, detailCode=1200)r|Tr}T}r~T(hEUhFjxTubahIjubehIhfubahIjubj)rT}rT(hEUhK}rT(hM]hN]hO]hP]hR]uhFj]Th@]rThb)rT}rT(hEXExceptions.IdentifierNotUnique -- (errorCode=409, detailCode=1220)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.hK}rT(hM]hN]hO]hP]hR]uhFjTh@]rT(j)rT}rT(hEUhK}rT(UreftypejjU reftargetXExceptions.IdentifierNotUniquerTU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFjTh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^XExceptions.IdentifierNotUniquerTrT}rT(hEUhFjTubahIjubahIjubh^X -- rTrT}rT(hEUhFjTubhb)rT}rT(hEX$``(errorCode=409, detailCode=1220)``rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^X (errorCode=409, detailCode=1220)rTrT}rT(hEUhFjTubahIjubaubhb)rT}rT(hEXThe 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.rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTh^XThe 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.rTrT}rT(hEjThFjTubaubehIhfubahIjubj)rT}rT(hEUhK}rT(hM]hN]hO]hP]hR]uhFj]Th@]rThb)rT}rT(hEXkExceptions.UnsupportedType -- (errorCode=400, detailCode=1240)The MN can not deal with the object provided.hK}rT(hM]hN]hO]hP]hR]uhFjTh@]rT(j)rT}rT(hEUhK}rT(UreftypejjU reftargetXExceptions.UnsupportedTyperTU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFjTh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^XExceptions.UnsupportedTyperTrT}rT(hEUhFjTubahIjubahIjubh^X -- rTrT}rT(hEUhFjTubhb)rT}rT(hEX$``(errorCode=400, detailCode=1240)``rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^X (errorCode=400, detailCode=1240)rTrT}rT(hEUhFjTubahIjubaubhb)rT}rT(hEX-The MN can not deal with the object provided.rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTh^X-The MN can not deal with the object provided.rTrT}rT(hEjThFjTubaubehIhfubahIjubj)rT}rT(hEUhK}rT(hM]hN]hO]hP]hR]uhFj]Th@]rThb)rT}rT(hEXExceptions.InsufficientResources -- (errorCode=413, detailCode=1260)The MN is unable to execute the transfer because it does not have sufficient storage space for example.hK}rT(hM]hN]hO]hP]hR]uhFjTh@]rT(j)rT}rT(hEUhK}rT(UreftypejjU reftargetX Exceptions.InsufficientResourcesrTU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFjTh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^X Exceptions.InsufficientResourcesrTrT}rT(hEUhFjTubahIjubahIjubh^X -- rTrT}rT(hEUhFjTubhb)rT}rT(hEX$``(errorCode=413, detailCode=1260)``rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTj)rT}rT(hEjThK}rT(hM]hN]hO]hP]hR]uhFjTh@]rTh^X (errorCode=413, detailCode=1260)rTrT}rT(hEUhFjTubahIjubaubhb)rT}rT(hEXgThe MN is unable to execute the transfer because it does not have sufficient storage space for example.rThFjThGjHhIhfhK}rT(hM]hN]hO]hP]hR]uhTKh@]rTh^XgThe MN is unable to execute the transfer because it does not have sufficient storage space for example.rTrT}rT(hEjThFjTubaubehIhfubahIjubj)rU}rU(hEUhK}rU(hM]hN]hO]hP]hR]uhFj]Th@]rUhb)rU}rU(hEXExceptions.NotFound -- (errorCode=404, detailCode=1280)The update operation failed because the object which was supposed to be updated in the system (indicated via the obsoletedPid parameter) is not present in the DataONE system, so update is an illegal operation.hK}rU(hM]hN]hO]hP]hR]uhFjUh@]rU(j)rU}r U(hEUhK}r U(UreftypejjU reftargetXExceptions.NotFoundr UU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFjUh@]r Uj)r U}rU(hEj UhK}rU(hM]hN]hO]hP]hR]uhFjUh@]rUh^XExceptions.NotFoundrUrU}rU(hEUhFj UubahIjubahIjubh^X -- rUrU}rU(hEUhFjUubhb)rU}rU(hEX$``(errorCode=404, detailCode=1280)``rUhFjUhGjHhIhfhK}rU(hM]hN]hO]hP]hR]uhTKh@]rUj)rU}rU(hEjUhK}rU(hM]hN]hO]hP]hR]uhFjUh@]rUh^X (errorCode=404, detailCode=1280)r Ur!U}r"U(hEUhFjUubahIjubaubhb)r#U}r$U(hEXThe update operation failed because the object which was supposed to be updated in the system (indicated via the *obsoletedPid* parameter) is not present in the DataONE system, so update is an illegal operation.hFjUhGjHhIhfhK}r%U(hM]hN]hO]hP]hR]uhTKh@]r&U(h^XqThe update operation failed because the object which was supposed to be updated in the system (indicated via the r'Ur(U}r)U(hEXqThe update operation failed because the object which was supposed to be updated in the system (indicated via the hFj#Uubj)r*U}r+U(hEX*obsoletedPid*hK}r,U(hM]hN]hO]hP]hR]uhFj#Uh@]r-Uh^X obsoletedPidr.Ur/U}r0U(hEUhFj*UubahIjubh^XT parameter) is not present in the DataONE system, so update is an illegal operation.r1Ur2U}r3U(hEXT parameter) is not present in the DataONE system, so update is an illegal operation.hFj#UubeubehIhfubahIjubj)r4U}r5U(hEUhK}r6U(hM]hN]hO]hP]hR]uhFj]Th@]r7Uhb)r8U}r9U(hEX6Exceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=1300)One or more required fields are not set, the metadata document is malformed or the value of some field is not valid. SystemMetadata.obsoletes is set by the client and does not match the pid of the object being obsoleted. SystemMetadata.obsoletedBy is set on the SystemMetadata of the new object provided by the client (a new object cannot be created in an obsoleted state). SystemMetadata.obsoletedBy is already set on the object being obsoleted (no branching is allowed in the obsolescence chain).hK}r:U(hM]hN]hO]hP]hR]uhFj4Uh@]r;U(j)rU(UreftypejjU reftargetX Exceptions.InvalidSystemMetadatar?UU refdomainjsQhP]hO]U refexplicithM]hN]hR]uhFj8Uh@]r@Uj)rAU}rBU(hEj?UhK}rCU(hM]hN]hO]hP]hR]uhFj IdentifierhFj(VhGjHhIjhK}r0V(hP]r1Vh(ajjHhO]hM]hN]hR]r2Vh(ajXgenerateIdentifierr3VjUjuhTKhUhh@]r4V(j)r5V}r6V(hEX MNStorage.hFj.VhGjHhIjhK}r7V(hM]hN]hO]hP]hR]uhTKhUhh@]r8Vh^X MNStorage.r9Vr:V}r;V(hEUhFj5Vubaubj)rV(hM]hN]hO]hP]hR]uhTKhUhh@]r?Vh^XgenerateIdentifierr@VrAV}rBV(hEUhFjWr?W}r@W(hEUhFj3Wubj)rAW}rBW(hEUhK}rCW(UreftypejjU reftargetXstringrDWU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFj3Wh@]rEWj)rFW}rGW(hEjDWhK}rHW(hM]hN]hO]hP]hR]uhFjAWh@]rIWh^XstringrJWrKW}rLW(hEUhFjFWubahIjubahIjubh^X)rMW}rNW(hEUhFj3Wubh^X -- rOWrPW}rQW(hEUhFj3Wubh^XThe 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 rRWrSW}rTW(hEXThe 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 hFj3Wubj)rUW}rVW(hEX *Param part*hK}rWW(hM]hN]hO]hP]hR]uhFj3Wh@]rXWh^X Param partrYWrZW}r[W(hEUhFjUWubahIjubh^X% of the MIME multipart/mixed message.r\Wr]W}r^W(hEX% of the MIME multipart/mixed message.hFj3WubehIhfubahIjubehIjmubahIhubehIh}ubhz)r_W}r`W(hEUhK}raW(hM]hN]hO]hP]hR]uhFj{Vh@]rbW(h)rcW}rdW(hEXReturnshFj_WhGjHhIhhK}reW(hM]hN]hO]hP]hR]uhTKh@]rfWh^XReturnsrgWrhW}riW(hEUhFjcWubaubh)rjW}rkW(hEUhK}rlW(hM]hN]hO]hP]hR]uhFj_Wh@]rmWhb)rnW}roW(hEX!The identifier that was generatedhK}rpW(hM]hN]hO]hP]hR]uhFjjWh@]rqWh^X!The identifier that was generatedrrWrsW}rtW(hEX!The identifier that was generatedhFjnWubahIhfubahIhubehIh}ubhz)ruW}rvW(hEUhK}rwW(hM]hN]hO]hP]hR]uhFj{Vh@]rxW(h)ryW}rzW(hEX Return typehFjuWhGjHhIhhK}r{W(hM]hN]hO]hP]hR]uhTKh@]r|Wh^X Return typer}Wr~W}rW(hEUhFjyWubaubh)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjuWh@]rWhb)rW}rW(hEXTypes.IdentifierhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWj)rW}rW(hEX:class:`Types.Identifier`rWhFjWhGjHhIjhK}rW(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrWhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rWj)rW}rW(hEjWhK}rW(hM]hN]rW(jjWXpy-classrWehO]hP]hR]uhFjWh@]rWh^XTypes.IdentifierrWrW}rW(hEUhFjWubahIjubaubahIhfubahIhubehIh}ubhz)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFj{Vh@]rW(h)rW}rW(hEXRaiseshFjWhGjHhIhhK}rW(hM]hN]hO]hP]hR]uhTKh@]rWh^XRaisesrWrW}rW(hEUhFjWubaubh)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWj)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rW(j)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWhb)rW}rW(hEXExceptions.InvalidToken -- (errorCode=401, detailCode=2190)The supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.hK}rW(hM]hN]hO]hP]hR]uhFjWh@]rW(j)rW}rW(hEUhK}rW(UreftypejjU reftargetXExceptions.InvalidTokenrWU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFjWh@]rWj)rW}rW(hEjWhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWh^XExceptions.InvalidTokenrWrW}rW(hEUhFjWubahIjubahIjubh^X -- rWrW}rW(hEUhFjWubhb)rW}rW(hEX$``(errorCode=401, detailCode=2190)``rWhFjWhGjHhIhfhK}rW(hM]hN]hO]hP]hR]uhTKh@]rWj)rW}rW(hEjWhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWh^X (errorCode=401, detailCode=2190)rWrW}rW(hEUhFjWubahIjubaubhb)rW}rW(hEXwThe supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.rWhFjWhGjHhIhfhK}rW(hM]hN]hO]hP]hR]uhTKh@]rWh^XwThe supplied authentication token is not a proper certificate, or missing required fields, or otherwise proves invalid.rWrW}rW(hEjWhFjWubaubehIhfubahIjubj)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWhb)rW}rW(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2191)hK}rW(hM]hN]hO]hP]hR]uhFjWh@]rW(j)rW}rW(hEUhK}rW(UreftypejjU reftargetXExceptions.ServiceFailurerWU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFjWh@]rWj)rW}rW(hEjWhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWh^XExceptions.ServiceFailurerWrW}rW(hEUhFjWubahIjubahIjubh^X -- rWrW}rW(hEUhFjWubj)rW}rW(hEX$``(errorCode=500, detailCode=2191)``hK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWh^X (errorCode=500, detailCode=2191)rWrW}rW(hEUhFjWubahIjubehIhfubahIjubj)rW}rW(hEUhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rWhb)rW}rW(hEXoExceptions.NotAuthorized -- (errorCode=401, detailCode=2192)Supplied credentials does not have WRITE permissionhK}rW(hM]hN]hO]hP]hR]uhFjWh@]rW(j)rW}rW(hEUhK}rW(UreftypejjU reftargetXExceptions.NotAuthorizedrWU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFjWh@]rWj)rX}rX(hEjWhK}rX(hM]hN]hO]hP]hR]uhFjWh@]rXh^XExceptions.NotAuthorizedrXrX}rX(hEUhFjXubahIjubahIjubh^X -- rXrX}r X(hEUhFjWubhb)r X}r X(hEX$``(errorCode=401, detailCode=2192)``r XhFjWhGjHhIhfhK}r X(hM]hN]hO]hP]hR]uhTKh@]rXj)rX}rX(hEj XhK}rX(hM]hN]hO]hP]hR]uhFj Xh@]rXh^X (errorCode=401, detailCode=2192)rXrX}rX(hEUhFjXubahIjubaubhb)rX}rX(hEX3Supplied credentials does not have WRITE permissionrXhFjWhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKh@]rXh^X3Supplied credentials does not have WRITE permissionrXrX}rX(hEjXhFjXubaubehIhfubahIjubj)rX}rX(hEUhK}r X(hM]hN]hO]hP]hR]uhFjWh@]r!Xhb)r"X}r#X(hEXExceptions.InvalidRequest -- (errorCode=400, detailCode=2193)The scheme requested is not a valid scheme accepted by this servicehK}r$X(hM]hN]hO]hP]hR]uhFjXh@]r%X(j)r&X}r'X(hEUhK}r(X(UreftypejjU reftargetXExceptions.InvalidRequestr)XU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFj"Xh@]r*Xj)r+X}r,X(hEj)XhK}r-X(hM]hN]hO]hP]hR]uhFj&Xh@]r.Xh^XExceptions.InvalidRequestr/Xr0X}r1X(hEUhFj+XubahIjubahIjubh^X -- r2Xr3X}r4X(hEUhFj"Xubhb)r5X}r6X(hEX$``(errorCode=400, detailCode=2193)``r7XhFj"XhGjHhIhfhK}r8X(hM]hN]hO]hP]hR]uhTKh@]r9Xj)r:X}r;X(hEj7XhK}rXr?X}r@X(hEUhFj:XubahIjubaubhb)rAX}rBX(hEXCThe scheme requested is not a valid scheme accepted by this servicerCXhFj"XhGjHhIhfhK}rDX(hM]hN]hO]hP]hR]uhTKh@]rEXh^XCThe scheme requested is not a valid scheme accepted by this servicerFXrGX}rHX(hEjCXhFjAXubaubehIhfubahIjubj)rIX}rJX(hEUhK}rKX(hM]hN]hO]hP]hR]uhFjWh@]rLXhb)rMX}rNX(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2194)hK}rOX(hM]hN]hO]hP]hR]uhFjIXh@]rPX(j)rQX}rRX(hEUhK}rSX(UreftypejjU reftargetXExceptions.NotImplementedrTXU refdomainj+VhP]hO]U refexplicithM]hN]hR]uhFjMXh@]rUXj)rVX}rWX(hEjTXhK}rXX(hM]hN]hO]hP]hR]uhFjQXh@]rYXh^XExceptions.NotImplementedrZXr[X}r\X(hEUhFjVXubahIjubahIjubh^X -- r]Xr^X}r_X(hEUhFjMXubj)r`X}raX(hEX$``(errorCode=501, detailCode=2194)``hK}rbX(hM]hN]hO]hP]hR]uhFjMXh@]rcXh^X (errorCode=501, detailCode=2194)rdXreX}rfX(hEUhFj`XubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubje)rgX}rhX(hEUhFjHhGjHhIjihK}riX(hP]hO]hM]hN]hR]UrefidrjXUindex-0rkXuhTNhUhh@]ubcsphinx.ext.todo todo_node rlX)rmX}rnX(hEX9Need to provide a list of recommended identifier schemes.roXhFjHhGjHUexpect_referenced_by_namerpX}hIU todo_noderqXhK}rrX(hM]hN]rsXUadmonition-todortXahO]hP]ruXjkXahR]uhTKhUhUexpect_referenced_by_idrvX}rwXjkXjgXsh@]rxX(hW)ryX}rzX(hEXTodor{XhK}r|X(hM]hN]hO]hP]hR]uhFjmXh@]r}Xh^XTodor~XrX}rX(hEUhFjyXubahIh[ubhb)rX}rX(hEjoXhFjmXhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKh@]rXh^X9Need to provide a list of recommended identifier schemes.rXrX}rX(hEjoXhFjXubaubeubj)rX}rX(hEUhFjHhGNhIjhK}rX(hP]hO]hM]hN]hR]Uentries]rX(jXdelete() (in module MNStorage)h*UNtrXauhTNhUhh@]ubj)rX}rX(hEUhFjHhGNhIjhK}rX(jjXpyrXhP]hO]hM]hN]hR]jXfunctionrXjjXuhTNhUhh@]rX(j)rX}rX(hEX delete(session,id) -> IdentifierhFjXhGjHhIjhK}rX(hP]rXh*ajjHhO]hM]hN]hR]rXh*ajXdeleterXjUjuhTMhUhh@]rX(j)rX}rX(hEX MNStorage.hFjXhGjHhIjhK}rX(hM]hN]hO]hP]hR]uhTMhUhh@]rXh^X MNStorage.rXrX}rX(hEUhFjXubaubj)rX}rX(hEjXhFjXhGjHhIjhK}rX(hM]hN]hO]hP]hR]uhTMhUhh@]rXh^XdeleterXrX}rX(hEUhFjXubaubj)rX}rX(hEX session, idhFjXhGjHhIjhK}rX(hM]hN]hO]hP]hR]uhTMhUhh@]rX(j)rX}rX(hEXsessionhK}rX(hM]hN]hO]hP]hR]uhFjXh@]rXh^XsessionrXrX}rX(hEUhFjXubahIjubj)rX}rX(hEXidhK}rX(hM]hN]hO]hP]hR]uhFjXh@]rXh^XidrXrX}rX(hEUhFjXubahIjubeubj)rX}rX(hEX IdentifierhFjXhGjHhIjhK}rX(hM]hN]hO]hP]hR]uhTMhUhh@]rXh^X IdentifierrXrX}rX(hEUhFjXubaubeubj)rX}rX(hEUhFjXhGjHhIj hK}rX(hM]hN]hO]hP]hR]uhTMhUhh@]rX(hb)rX}rX(hEXDeletes an object managed by DataONE from the Member Node. Member Nodes MUST check that the caller (typically a Coordinating Node) is authorized to perform this function.rXhFjXhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKhUhh@]rXh^XDeletes an object managed by DataONE from the Member Node. Member Nodes MUST check that the caller (typically a Coordinating Node) is authorized to perform this function.rXrX}rX(hEjXhFjXubaubhb)rX}rX(hEXThe delete operation will be used primarily by Coordinating Nodes to help manage the number of replicas of an object that are present in the entire system.rXhFjXhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKhUhh@]rXh^XThe delete operation will be used primarily by Coordinating Nodes to help manage the number of replicas of an object that are present in the entire system.rXrX}rX(hEjXhFjXubaubhb)rX}rX(hEXDThe operation removes the object from further interaction with DataONE services. The implementation may delete the object bytes, and in general should do so since a delete operation may be in response to a problem with the object (e.g. it contains malicious content, is innappropriate, or is the subject of a legal request).rXhFjXhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKhUhh@]rXh^XDThe operation removes the object from further interaction with DataONE services. The implementation may delete the object bytes, and in general should do so since a delete operation may be in response to a problem with the object (e.g. it contains malicious content, is innappropriate, or is the subject of a legal request).rXrX}rX(hEjXhFjXubaubhb)rX}rX(hEXIf the object does not exist on the node servicing the request, then an :exc:`Exceptions.NotFound` exception is raised. The message body of the exception SHOULD contain a hint as to the location of the :func:`CNRead.resolve` method.hFjXhGjHhIhfhK}rX(hM]hN]hO]hP]hR]uhTKhUhh@]rX(h^XHIf the object does not exist on the node servicing the request, then an rXrX}rX(hEXHIf the object does not exist on the node servicing the request, then an hFjXubj)rX}rX(hEX:exc:`Exceptions.NotFound`rXhFjXhGjHhIjhK}rX(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyrXhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rXj)rX}rX(hEjXhK}rX(hM]hN]rX(jjXXpy-excrXehO]hP]hR]uhFjXh@]rXh^XExceptions.NotFoundrXrX}rX(hEUhFjXubahIjubaubh^Xh exception is raised. The message body of the exception SHOULD contain a hint as to the location of the rXrX}rX(hEXh exception is raised. The message body of the exception SHOULD contain a hint as to the location of the hFjXubj)rX}rX(hEX:func:`CNRead.resolve`rXhFjXhGjHhIjhK}rX(UreftypeXfuncjjXCNRead.resolveU refdomainXpyrXhP]hO]U refexplicithM]hN]hR]jjjNjjHuhTKh@]rXj)rX}rX(hEjXhK}rX(hM]hN]rX(jjXXpy-funcrYehO]hP]hR]uhFjXh@]rYh^XCNRead.resolve()rYrY}rY(hEUhFjXubahIjubaubh^X method.rYrY}rY(hEX method.hFjXubeubht)rY}r Y(hEUhFjXhGNhIhwhK}r Y(hM]hN]hO]hP]hR]uhTNhUhh@]r Y(hz)r Y}r Y(hEUhFjYhGjHhIh}hK}rY(hM]hN]hO]hP]hR]uhTKhUhh@]rY(h)rY}rY(hEXVersionhFj YhGjHhIhhK}rY(hM]hN]hO]hP]hR]uhTKh@]rYh^XVersionrYrY}rY(hEUhFjYubaubh)rY}rY(hEX1.0rYhK}rY(hM]hN]hO]hP]hR]uhFj Yh@]rYhb)rY}rY(hEjYhFjYhGjHhIhfhK}rY(hM]hN]hO]hP]hR]uhTKh@]rYh^X1.0r Yr!Y}r"Y(hEjYhFjYubaubahIhubeubhz)r#Y}r$Y(hEUhFjYhGjHhIh}hK}r%Y(hM]hN]hO]hP]hR]uhTKhUhh@]r&Y(h)r'Y}r(Y(hEX Use CaseshFj#YhGjHhIhhK}r)Y(hM]hN]hO]hP]hR]uhTKh@]r*Yh^X Use Casesr+Yr,Y}r-Y(hEUhFj'Yubaubh)r.Y}r/Y(hEX$:doc:`UC16 `r0YhK}r1Y(hM]hN]hO]hP]hR]uhFj#Yh@]r2Yhb)r3Y}r4Y(hEj0YhFj.YhGjHhIhfhK}r5Y(hM]hN]hO]hP]hR]uhTKh@]r6Yj)r7Y}r8Y(hEj0YhFj3YhGjHhIjhK}r9Y(UreftypeXdocr:YjjX/design/UseCases/16_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTKh@]r;Yjr)rY(hM]hN]r?Y(jj:YehO]hP]hR]uhFj7Yh@]r@Yh^XUC16rAYrBY}rCY(hEUhFjZ(hEUhFj8ZubahIjubehIhfubahIjubj)r?Z}r@Z(hEUhK}rAZ(hM]hN]hO]hP]hR]uhFjZh@]rBZhb)rCZ}rDZ(hEXExceptions.NotFound -- (errorCode=404, detailCode=2901)The delete operation failed because the object is not present on the node servicing the request.hK}rEZ(hM]hN]hO]hP]hR]uhFj?Zh@]rFZ(j)rGZ}rHZ(hEUhK}rIZ(UreftypejjU reftargetXExceptions.NotFoundrJZU refdomainjXhP]hO]U refexplicithM]hN]hR]uhFjCZh@]rKZj)rLZ}rMZ(hEjJZhK}rNZ(hM]hN]hO]hP]hR]uhFjGZh@]rOZh^XExceptions.NotFoundrPZrQZ}rRZ(hEUhFjLZubahIjubahIjubh^X -- rSZrTZ}rUZ(hEUhFjCZubhb)rVZ}rWZ(hEX$``(errorCode=404, detailCode=2901)``rXZhFjCZhGjHhIhfhK}rYZ(hM]hN]hO]hP]hR]uhTKh@]rZZj)r[Z}r\Z(hEjXZhK}r]Z(hM]hN]hO]hP]hR]uhFjVZh@]r^Zh^X (errorCode=404, detailCode=2901)r_Zr`Z}raZ(hEUhFj[ZubahIjubaubhb)rbZ}rcZ(hEX`The delete operation failed because the object is not present on the node servicing the request.rdZhFjCZhGjHhIhfhK}reZ(hM]hN]hO]hP]hR]uhTKh@]rfZh^X`The delete operation failed because the object is not present on the node servicing the request.rgZrhZ}riZ(hEjdZhFjbZubaubehIhfubahIjubj)rjZ}rkZ(hEUhK}rlZ(hM]hN]hO]hP]hR]uhFjZh@]rmZhb)rnZ}roZ(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2902)hK}rpZ(hM]hN]hO]hP]hR]uhFjjZh@]rqZ(j)rrZ}rsZ(hEUhK}rtZ(UreftypejjU reftargetXExceptions.ServiceFailureruZU refdomainjXhP]hO]U refexplicithM]hN]hR]uhFjnZh@]rvZj)rwZ}rxZ(hEjuZhK}ryZ(hM]hN]hO]hP]hR]uhFjrZh@]rzZh^XExceptions.ServiceFailurer{Zr|Z}r}Z(hEUhFjwZubahIjubahIjubh^X -- r~ZrZ}rZ(hEUhFjnZubj)rZ}rZ(hEX$``(errorCode=500, detailCode=2902)``hK}rZ(hM]hN]hO]hP]hR]uhFjnZh@]rZh^X (errorCode=500, detailCode=2902)rZrZ}rZ(hEUhFjZubahIjubehIhfubahIjubj)rZ}rZ(hEUhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZhb)rZ}rZ(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2903)hK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZ(j)rZ}rZ(hEUhK}rZ(UreftypejjU reftargetXExceptions.InvalidTokenrZU refdomainjXhP]hO]U refexplicithM]hN]hR]uhFjZh@]rZj)rZ}rZ(hEjZhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^XExceptions.InvalidTokenrZrZ}rZ(hEUhFjZubahIjubahIjubh^X -- rZrZ}rZ(hEUhFjZubj)rZ}rZ(hEX$``(errorCode=401, detailCode=2903)``hK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^X (errorCode=401, detailCode=2903)rZrZ}rZ(hEUhFjZubahIjubehIhfubahIjubj)rZ}rZ(hEUhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZhb)rZ}rZ(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2904)hK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZ(j)rZ}rZ(hEUhK}rZ(UreftypejjU reftargetXExceptions.NotImplementedrZU refdomainjXhP]hO]U refexplicithM]hN]hR]uhFjZh@]rZj)rZ}rZ(hEjZhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^XExceptions.NotImplementedrZrZ}rZ(hEUhFjZubahIjubahIjubh^X -- rZrZ}rZ(hEUhFjZubj)rZ}rZ(hEX$``(errorCode=501, detailCode=2904)``hK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^X (errorCode=501, detailCode=2904)rZrZ}rZ(hEUhFjZubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)rZ}rZ(hEUhFjHhGNhIjhK}rZ(hP]hO]hM]hN]hR]Uentries]rZ(jXarchive() (in module MNStorage)h UNtrZauhTNhUhh@]ubj)rZ}rZ(hEUhFjHhGNhIjhK}rZ(jjXpyrZhP]hO]hM]hN]hR]jXfunctionrZjjZuhTNhUhh@]rZ(j)rZ}rZ(hEX!archive(session,id) -> IdentifierhFjZhGjHhIjhK}rZ(hP]rZh ajjHhO]hM]hN]hR]rZh ajXarchiverZjUjuhTM(hUhh@]rZ(j)rZ}rZ(hEX MNStorage.hFjZhGjHhIjhK}rZ(hM]hN]hO]hP]hR]uhTM(hUhh@]rZh^X MNStorage.rZrZ}rZ(hEUhFjZubaubj)rZ}rZ(hEjZhFjZhGjHhIjhK}rZ(hM]hN]hO]hP]hR]uhTM(hUhh@]rZh^XarchiverZrZ}rZ(hEUhFjZubaubj)rZ}rZ(hEX session, idhFjZhGjHhIjhK}rZ(hM]hN]hO]hP]hR]uhTM(hUhh@]rZ(j)rZ}rZ(hEXsessionhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^XsessionrZrZ}rZ(hEUhFjZubahIjubj)rZ}rZ(hEXidhK}rZ(hM]hN]hO]hP]hR]uhFjZh@]rZh^XidrZrZ}rZ(hEUhFjZubahIjubeubj)rZ}rZ(hEX IdentifierhFjZhGjHhIjhK}rZ(hM]hN]hO]hP]hR]uhTM(hUhh@]rZh^X IdentifierrZrZ}rZ(hEUhFjZubaubeubj)rZ}rZ(hEUhFjZhGjHhIj hK}rZ(hM]hN]hO]hP]hR]uhTM(hUhh@]r[(hb)r[}r[(hEXyHides an object managed by DataONE from search operations, effectively preventing its discovery during normal operations.r[hFjZhGjHhIhfhK}r[(hM]hN]hO]hP]hR]uhTMhUhh@]r[h^XyHides an object managed by DataONE from search operations, effectively preventing its discovery during normal operations.r[r[}r[(hEj[hFj[ubaubhb)r [}r [(hEXThe 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.hFjZhGjHhIhfhK}r [(hM]hN]hO]hP]hR]uhTMhUhh@]r [(h^XEThe operation does not delete the object bytes, but instead sets the r [r[}r[(hEXEThe operation does not delete the object bytes, but instead sets the hFj [ubj)r[}r[(hEX%:attr:`Types.SystemMetadata.archived`r[hFj [hGjHhIjhK}r[(UreftypeXattrjjXTypes.SystemMetadata.archivedU refdomainXpyr[hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTMh@]r[j)r[}r[(hEj[hK}r[(hM]hN]r[(jj[Xpy-attrr[ehO]hP]hR]uhFj[h@]r^XTypes.SystemMetadata.archivedr[r[}r[(hEUhFj[ubahIjubaubh^X 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.r[r [}r![(hEX 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.hFj [ubeubhb)r"[}r#[(hEX\Objects that are archived can not be updated through the :func:`MNStorage.update` operation.hFjZhGjHhIhfhK}r$[(hM]hN]hO]hP]hR]uhTMhUhh@]r%[(h^X9Objects that are archived can not be updated through the r&[r'[}r([(hEX9Objects that are archived can not be updated through the hFj"[ubj)r)[}r*[(hEX:func:`MNStorage.update`r+[hFj"[hGjHhIjhK}r,[(UreftypeXfuncjjXMNStorage.updateU refdomainXpyr-[hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTMh@]r.[j)r/[}r0[(hEj+[hK}r1[(hM]hN]r2[(jj-[Xpy-funcr3[ehO]hP]hR]uhFj)[h@]r4[h^XMNStorage.update()r5[r6[}r7[(hEUhFj/[ubahIjubaubh^X operation.r8[r9[}r:[(hEX operation.hFj"[ubeubhb)r;[}r<[(hEXhArchived objects can not be un-archived. This behavior may change in future versions of the DataONE API.r=[hFjZhGjHhIhfhK}r>[(hM]hN]hO]hP]hR]uhTM hUhh@]r?[h^XhArchived objects can not be un-archived. This behavior may change in future versions of the DataONE API.r@[rA[}rB[(hEj=[hFj;[ubaubhb)rC[}rD[(hEXOMember Nodes MUST check that the caller is authorized to perform this function.rE[hFjZhGjHhIhfhK}rF[(hM]hN]hO]hP]hR]uhTM hUhh@]rG[h^XOMember Nodes MUST check that the caller is authorized to perform this function.rH[rI[}rJ[(hEjE[hFjC[ubaubhb)rK[}rL[(hEXIf the object does not exist on the node servicing the request, then an :exc:`Exceptions.NotFound` exception is raised. The message body of the exception SHOULD contain a hint as to the location of the :func:`CNRead.resolve` method.hFjZhGjHhIhfhK}rM[(hM]hN]hO]hP]hR]uhTM hUhh@]rN[(h^XHIf the object does not exist on the node servicing the request, then an rO[rP[}rQ[(hEXHIf the object does not exist on the node servicing the request, then an hFjK[ubj)rR[}rS[(hEX:exc:`Exceptions.NotFound`rT[hFjK[hGjHhIjhK}rU[(UreftypeXexcjjXExceptions.NotFoundU refdomainXpyrV[hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTM h@]rW[j)rX[}rY[(hEjT[hK}rZ[(hM]hN]r[[(jjV[Xpy-excr\[ehO]hP]hR]uhFjR[h@]r][h^XExceptions.NotFoundr^[r_[}r`[(hEUhFjX[ubahIjubaubh^Xh exception is raised. The message body of the exception SHOULD contain a hint as to the location of the ra[rb[}rc[(hEXh exception is raised. The message body of the exception SHOULD contain a hint as to the location of the hFjK[ubj)rd[}re[(hEX:func:`CNRead.resolve`rf[hFjK[hGjHhIjhK}rg[(UreftypeXfuncjjXCNRead.resolveU refdomainXpyrh[hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTM h@]ri[j)rj[}rk[(hEjf[hK}rl[(hM]hN]rm[(jjh[Xpy-funcrn[ehO]hP]hR]uhFjd[h@]ro[h^XCNRead.resolve()rp[rq[}rr[(hEUhFjj[ubahIjubaubh^X method.rs[rt[}ru[(hEX method.hFjK[ubeubht)rv[}rw[(hEUhFjZhGNhIhwhK}rx[(hM]hN]hO]hP]hR]uhTNhUhh@]ry[(hz)rz[}r{[(hEUhFjv[hGjHhIh}hK}r|[(hM]hN]hO]hP]hR]uhTMhUhh@]r}[(h)r~[}r[(hEXVersionhFjz[hGjHhIhhK}r[(hM]hN]hO]hP]hR]uhTKh@]r[h^XVersionr[r[}r[(hEUhFj~[ubaubh)r[}r[(hEX1.0r[hK}r[(hM]hN]hO]hP]hR]uhFjz[h@]r[hb)r[}r[(hEj[hFj[hGjHhIhfhK}r[(hM]hN]hO]hP]hR]uhTMh@]r[h^X1.0r[r[}r[(hEj[hFj[ubaubahIhubeubhz)r[}r[(hEUhFjv[hGjHhIh}hK}r[(hM]hN]hO]hP]hR]uhTMhUhh@]r[(h)r[}r[(hEXREST URLhFj[hGjHhIhhK}r[(hM]hN]hO]hP]hR]uhTKh@]r[h^XREST URLr[r[}r[(hEUhFj[ubaubh)r[}r[(hEX``PUT /archive/{id}``r[hK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[hb)r[}r[(hEj[hFj[hGjHhIhfhK}r[(hM]hN]hO]hP]hR]uhTMh@]r[j)r[}r[(hEj[hK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[h^XPUT /archive/{id}r[r[}r[(hEUhFj[ubahIjubaubahIhubeubhz)r[}r[(hEUhK}r[(hM]hN]hO]hP]hR]uhFjv[h@]r[(h)r[}r[(hEX ParametershFj[hGjHhIhhK}r[(hM]hN]hO]hP]hR]uhTKh@]r[h^X Parametersr[r[}r[(hEUhFj[ubaubh)r[}r[(hEUhK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[j)r[}r[(hEUhK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[(j)r[}r[(hEUhK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[hb)r[}r[(hEXTsession (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.hK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[(j)r[}r[(hEXsessionhK}r[(hP]hO]jhM]hN]hR]uhFj[h@]r[h^Xsessionr[r[}r[(hEUhFj[ubahIjubh^X (r[r[}r[(hEUhFj[ubj)r[}r[(hEX:class:`Types.Session`r[hFj[hGjHhIjhK}r[(UreftypeXclassjjX Types.SessionU refdomainXpyr[hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTMh@]r[j)r[}r[(hEj[hK}r[(hM]hN]r[(jj[Xpy-classr[ehO]hP]hR]uhFj[h@]r[h^X Types.Sessionr[r[}r[(hEUhFj[ubahIjubaubh^X)r[}r[(hEUhFj[ubh^X -- r[r[}r[(hEUhFj[ubh^XSession 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[(hEXSession 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 hFj[ubj)r[}r[(hEX:term:`public user`r[hFj[hGjHhIjhK}r[(UreftypeXtermjjX public userU refdomainXstdr[hP]hO]U refexplicithM]hN]hR]jjuhTMh@]r[jr)r[}r[(hEj[hK}r[(hM]hN]r[(jj[Xstd-termr[ehO]hP]hR]uhFj[h@]r[h^X public userr[r[}r[(hEUhFj[ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r[r[}r[(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj[ubehIhfubahIjubj)r[}r[(hEUhK}r[(hM]hN]hO]hP]hR]uhFj[h@]r[hb)r[}r[(hEXid (Types.Identifier) -- The identifier of the object to be archived. May be either a PID or a SID. Will archive the HEAD PID when called with a SID. Transmitted as part of the URL path and must be escaped accordingly.hK}r\(hM]hN]hO]hP]hR]uhFj[h@]r\(j)r\}r\(hEXidhK}r\(hP]hO]jhM]hN]hR]uhFj[h@]r\h^Xidr\r\}r\(hEUhFj\ubahIjubh^X (r \r \}r \(hEUhFj[ubj)r \}r \(hEX:class:`Types.Identifier`r\hFj[hGjHhIjhK}r\(UreftypeXclassjjXTypes.IdentifierU refdomainXpyr\hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTMh@]r\j)r\}r\(hEj\hK}r\(hM]hN]r\(jj\Xpy-classr\ehO]hP]hR]uhFj \h@]r\h^XTypes.Identifierr\r\}r\(hEUhFj\ubahIjubaubh^X)r\}r\(hEUhFj[ubh^X -- r\r\}r\(hEUhFj[ubh^XThe identifier of the object to be archived. May be either a PID or a SID. Will archive the HEAD PID when called with a SID. Transmitted as part of the URL path and must be escaped accordingly.r \r!\}r"\(hEXThe identifier of the object to be archived. May be either a PID or a SID. Will archive the HEAD PID when called with a SID. Transmitted as part of the URL path and must be escaped accordingly.hFj[ubehIhfubahIjubehIjmubahIhubehIh}ubhz)r#\}r$\(hEUhK}r%\(hM]hN]hO]hP]hR]uhFjv[h@]r&\(h)r'\}r(\(hEXReturnshFj#\hGjHhIhhK}r)\(hM]hN]hO]hP]hR]uhTKh@]r*\h^XReturnsr+\r,\}r-\(hEUhFj'\ubaubh)r.\}r/\(hEUhK}r0\(hM]hN]hO]hP]hR]uhFj#\h@]r1\hb)r2\}r3\(hEX/The identifier of the object that was archived.hK}r4\(hM]hN]hO]hP]hR]uhFj.\h@]r5\h^X/The identifier of the object that was archived.r6\r7\}r8\(hEX/The identifier of the object that was archived.hFj2\ubahIhfubahIhubehIh}ubhz)r9\}r:\(hEUhK}r;\(hM]hN]hO]hP]hR]uhFjv[h@]r<\(h)r=\}r>\(hEX Return typehFj9\hGjHhIhhK}r?\(hM]hN]hO]hP]hR]uhTKh@]r@\h^X Return typerA\rB\}rC\(hEUhFj=\ubaubh)rD\}rE\(hEUhK}rF\(hM]hN]hO]hP]hR]uhFj9\h@]rG\hb)rH\}rI\(hEXTypes.IdentifierhK}rJ\(hM]hN]hO]hP]hR]uhFjD\h@]rK\j)rL\}rM\(hEX:class:`Types.Identifier`rN\hFjH\hGjHhIjhK}rO\(UreftypeXclassjjXTypes.IdentifierU refdomainXpyrP\hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTMh@]rQ\j)rR\}rS\(hEjN\hK}rT\(hM]hN]rU\(jjP\Xpy-classrV\ehO]hP]hR]uhFjL\h@]rW\h^XTypes.IdentifierrX\rY\}rZ\(hEUhFjR\ubahIjubaubahIhfubahIhubehIh}ubhz)r[\}r\\(hEUhK}r]\(hM]hN]hO]hP]hR]uhFjv[h@]r^\(h)r_\}r`\(hEXRaiseshFj[\hGjHhIhhK}ra\(hM]hN]hO]hP]hR]uhTKh@]rb\h^XRaisesrc\rd\}re\(hEUhFj_\ubaubh)rf\}rg\(hEUhK}rh\(hM]hN]hO]hP]hR]uhFj[\h@]ri\j)rj\}rk\(hEUhK}rl\(hM]hN]hO]hP]hR]uhFjf\h@]rm\(j)rn\}ro\(hEUhK}rp\(hM]hN]hO]hP]hR]uhFjj\h@]rq\hb)rr\}rs\(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2910)hK}rt\(hM]hN]hO]hP]hR]uhFjn\h@]ru\(j)rv\}rw\(hEUhK}rx\(UreftypejjU reftargetXExceptions.NotAuthorizedry\U refdomainjZhP]hO]U refexplicithM]hN]hR]uhFjr\h@]rz\j)r{\}r|\(hEjy\hK}r}\(hM]hN]hO]hP]hR]uhFjv\h@]r~\h^XExceptions.NotAuthorizedr\r\}r\(hEUhFj{\ubahIjubahIjubh^X -- r\r\}r\(hEUhFjr\ubj)r\}r\(hEX$``(errorCode=401, detailCode=2910)``hK}r\(hM]hN]hO]hP]hR]uhFjr\h@]r\h^X (errorCode=401, detailCode=2910)r\r\}r\(hEUhFj\ubahIjubehIhfubahIjubj)r\}r\(hEUhK}r\(hM]hN]hO]hP]hR]uhFjj\h@]r\hb)r\}r\(hEXExceptions.NotFound -- (errorCode=404, detailCode=2911)The archive operation failed because the object is not present on the node servicing the request.hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\(j)r\}r\(hEUhK}r\(UreftypejjU reftargetXExceptions.NotFoundr\U refdomainjZhP]hO]U refexplicithM]hN]hR]uhFj\h@]r\j)r\}r\(hEj\hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^XExceptions.NotFoundr\r\}r\(hEUhFj\ubahIjubahIjubh^X -- r\r\}r\(hEUhFj\ubhb)r\}r\(hEX$``(errorCode=404, detailCode=2911)``r\hFj\hGjHhIhfhK}r\(hM]hN]hO]hP]hR]uhTMh@]r\j)r\}r\(hEj\hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^X (errorCode=404, detailCode=2911)r\r\}r\(hEUhFj\ubahIjubaubhb)r\}r\(hEXaThe archive operation failed because the object is not present on the node servicing the request.r\hFj\hGjHhIhfhK}r\(hM]hN]hO]hP]hR]uhTMh@]r\h^XaThe archive operation failed because the object is not present on the node servicing the request.r\r\}r\(hEj\hFj\ubaubehIhfubahIjubj)r\}r\(hEUhK}r\(hM]hN]hO]hP]hR]uhFjj\h@]r\hb)r\}r\(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2912)hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\(j)r\}r\(hEUhK}r\(UreftypejjU reftargetXExceptions.ServiceFailurer\U refdomainjZhP]hO]U refexplicithM]hN]hR]uhFj\h@]r\j)r\}r\(hEj\hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^XExceptions.ServiceFailurer\r\}r\(hEUhFj\ubahIjubahIjubh^X -- r\r\}r\(hEUhFj\ubj)r\}r\(hEX$``(errorCode=500, detailCode=2912)``hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^X (errorCode=500, detailCode=2912)r\r\}r\(hEUhFj\ubahIjubehIhfubahIjubj)r\}r\(hEUhK}r\(hM]hN]hO]hP]hR]uhFjj\h@]r\hb)r\}r\(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2913)hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\(j)r\}r\(hEUhK}r\(UreftypejjU reftargetXExceptions.InvalidTokenr\U refdomainjZhP]hO]U refexplicithM]hN]hR]uhFj\h@]r\j)r\}r\(hEj\hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^XExceptions.InvalidTokenr\r\}r\(hEUhFj\ubahIjubahIjubh^X -- r\r\}r\(hEUhFj\ubj)r\}r\(hEX$``(errorCode=401, detailCode=2913)``hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\h^X (errorCode=401, detailCode=2913)r\r\}r\(hEUhFj\ubahIjubehIhfubahIjubj)r\}r\(hEUhK}r\(hM]hN]hO]hP]hR]uhFjj\h@]r\hb)r\}r\(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2914)hK}r\(hM]hN]hO]hP]hR]uhFj\h@]r\(j)r\}r\(hEUhK}r\(UreftypejjU reftargetXExceptions.NotImplementedr\U refdomainjZhP]hO]U refexplicithM]hN]hR]uhFj\h@]r\j)r]}r](hEj\hK}r](hM]hN]hO]hP]hR]uhFj\h@]r]h^XExceptions.NotImplementedr]r]}r](hEUhFj]ubahIjubahIjubh^X -- r]r]}r ](hEUhFj\ubj)r ]}r ](hEX$``(errorCode=501, detailCode=2914)``hK}r ](hM]hN]hO]hP]hR]uhFj\h@]r ]h^X (errorCode=501, detailCode=2914)r]r]}r](hEUhFj ]ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubj)r]}r](hEUhFjHhGNhIjhK}r](hP]hO]hM]hN]hR]Uentries]r](jX,updateSystemMetadata() (in module MNStorage)hUNtr]auhTNhUhh@]ubj)r]}r](hEUhFjHhGNhIjhK}r](jjXpyr]hP]hO]hM]hN]hR]jXfunctionr]jj]uhTNhUhh@]r](j)r]}r](hEX4updateSystemMetadata(session,pid,sysmeta) -> booleanhFj]hGXDinternal padding after source/apis/generated/generated_MNStorage.txtr]hIjhK}r](hP]r ]hajjHhO]hM]hN]hR]r!]hajXupdateSystemMetadatar"]jUjuhTMJhUhh@]r#](j)r$]}r%](hEX MNStorage.hFj]hGj]hIjhK}r&](hM]hN]hO]hP]hR]uhTMJhUhh@]r']h^X MNStorage.r(]r)]}r*](hEUhFj$]ubaubj)r+]}r,](hEj"]hFj]hGj]hIjhK}r-](hM]hN]hO]hP]hR]uhTMJhUhh@]r.]h^XupdateSystemMetadatar/]r0]}r1](hEUhFj+]ubaubj)r2]}r3](hEXsession, pid, sysmetahFj]hGj]hIjhK}r4](hM]hN]hO]hP]hR]uhTMJhUhh@]r5](j)r6]}r7](hEXsessionhK}r8](hM]hN]hO]hP]hR]uhFj2]h@]r9]h^Xsessionr:]r;]}r<](hEUhFj6]ubahIjubj)r=]}r>](hEXpidhK}r?](hM]hN]hO]hP]hR]uhFj2]h@]r@]h^XpidrA]rB]}rC](hEUhFj=]ubahIjubj)rD]}rE](hEXsysmetahK}rF](hM]hN]hO]hP]hR]uhFj2]h@]rG]h^XsysmetarH]rI]}rJ](hEUhFjD]ubahIjubeubj)rK]}rL](hEXbooleanhFj]hGj]hIjhK}rM](hM]hN]hO]hP]hR]uhTMJhUhh@]rN]h^XbooleanrO]rP]}rQ](hEUhFjK]ubaubeubj)rR]}rS](hEUhFj]hGj]hIj hK}rT](hM]hN]hO]hP]hR]uhTMJhUhh@]rU](hb)rV]}rW](hEXProvides a mechanism for updating system metadata for any objects held on the Member Node where that Member Node is the authoritative Member Node. Coordinating Node can call this method on the non-authoritative Member Node. However, this is not a normal operation and is for the special case - the authoritative Member Node doesn't exist any more. Coordinating Node calling the method on the non-authoriative Memember Node in the normal operation can cause an unexpected consequence.rX]hFjR]hGjHhIhfhK}rY](hM]hN]hO]hP]hR]uhTM+hUhh@]rZ]h^XProvides a mechanism for updating system metadata for any objects held on the Member Node where that Member Node is the authoritative Member Node. Coordinating Node can call this method on the non-authoritative Member Node. However, this is not a normal operation and is for the special case - the authoritative Member Node doesn't exist any more. Coordinating Node calling the method on the non-authoriative Memember Node in the normal operation can cause an unexpected consequence.r[]r\]}r]](hEjX]hFjV]ubaubhb)r^]}r_](hEXqThis method is typically used by Authoritative Member Node or rights holder[s] to ensure system metadata quality.r`]hFjR]hGjHhIhfhK}ra](hM]hN]hO]hP]hR]uhTM-hUhh@]rb]h^XqThis method is typically used by Authoritative Member Node or rights holder[s] to ensure system metadata quality.rc]rd]}re](hEj`]hFj^]ubaubht)rf]}rg](hEUhFjR]hGNhIhwhK}rh](hM]hN]hO]hP]hR]uhTNhUhh@]ri](hz)rj]}rk](hEUhFjf]hGjHhIh}hK}rl](hM]hN]hO]hP]hR]uhTM/hUhh@]rm](h)rn]}ro](hEXVersionhFjj]hGjHhIhhK}rp](hM]hN]hO]hP]hR]uhTKh@]rq]h^XVersionrr]rs]}rt](hEUhFjn]ubaubh)ru]}rv](hEX2.0rw]hK}rx](hM]hN]hO]hP]hR]uhFjj]h@]ry]hb)rz]}r{](hEjw]hFju]hGjHhIhfhK}r|](hM]hN]hO]hP]hR]uhTM/h@]r}]h^X2.0r~]r]}r](hEjw]hFjz]ubaubahIhubeubhz)r]}r](hEUhFjf]hGjHhIh}hK}r](hM]hN]hO]hP]hR]uhTM0hUhh@]r](h)r]}r](hEXREST URLhFj]hGjHhIhhK}r](hM]hN]hO]hP]hR]uhTKh@]r]h^XREST URLr]r]}r](hEUhFj]ubaubh)r]}r](hEX ``PUT /meta``r]hK}r](hM]hN]hO]hP]hR]uhFj]h@]r]hb)r]}r](hEj]hFj]hGjHhIhfhK}r](hM]hN]hO]hP]hR]uhTM0h@]r]j)r]}r](hEj]hK}r](hM]hN]hO]hP]hR]uhFj]h@]r]h^X PUT /metar]r]}r](hEUhFj]ubahIjubaubahIhubeubhz)r]}r](hEUhK}r](hM]hN]hO]hP]hR]uhFjf]h@]r](h)r]}r](hEX ParametershFj]hGj]hIhhK}r](hM]hN]hO]hP]hR]uhTKh@]r]h^X Parametersr]r]}r](hEUhFj]ubaubh)r]}r](hEUhK}r](hM]hN]hO]hP]hR]uhFj]h@]r]j)r]}r](hEUhK}r](hM]hN]hO]hP]hR]uhFj]h@]r](j)r]}r](hEUhK}r](hM]hN]hO]hP]hR]uhFj]h@]r]hb)r]}r](hEXTsession (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.hK}r](hM]hN]hO]hP]hR]uhFj]h@]r](j)r]}r](hEXsessionhK}r](hP]hO]jhM]hN]hR]uhFj]h@]r]h^Xsessionr]r]}r](hEUhFj]ubahIjubh^X (r]r]}r](hEUhFj]ubj)r]}r](hEX:class:`Types.Session`r]hFj]hGjHhIjhK}r](UreftypeXclassjjX Types.SessionU refdomainXpyr]hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTM2h@]r]j)r]}r](hEj]hK}r](hM]hN]r](jj]Xpy-classr]ehO]hP]hR]uhFj]h@]r]h^X Types.Sessionr]r]}r](hEUhFj]ubahIjubaubh^X)r]}r](hEUhFj]ubh^X -- r]r]}r](hEUhFj]ubh^XSession 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](hEXSession 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 hFj]ubj)r]}r](hEX:term:`public user`r]hFj]hGjHhIjhK}r](UreftypeXtermjjX public userU refdomainXstdr]hP]hO]U refexplicithM]hN]hR]jjuhTM1h@]r]jr)r]}r](hEj]hK}r](hM]hN]r](jj]Xstd-termr]ehO]hP]hR]uhFj]h@]r]h^X public userr]r]}r](hEUhFj]ubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.r]r]}r](hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFj]ubehIhfubahIjubj)r]}r](hEUhK}r](hM]hN]hO]hP]hR]uhFj]h@]r]hb)r]}r](hEXlpid (Types.Identifier) -- Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hK}r](hM]hN]hO]hP]hR]uhFj]h@]r](j)r]}r](hEXpidhK}r](hP]hO]jhM]hN]hR]uhFj]h@]r]h^Xpidr]r]}r](hEUhFj]ubahIjubh^X (r]r]}r](hEUhFj]ubj)r]}r](hEX:class:`Types.Identifier`r]hFj]hGjHhIjhK}r](UreftypeXclassjjXTypes.IdentifierU refdomainXpyr^hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTM5h@]r^j)r^}r^(hEj]hK}r^(hM]hN]r^(jj^Xpy-classr^ehO]hP]hR]uhFj]h@]r^h^XTypes.Identifierr^r ^}r ^(hEUhFj^ubahIjubaubh^X)r ^}r ^(hEUhFj]ubh^X -- r ^r^}r^(hEUhFj]ubh^X#Transmitted as a UTF-8 String as a r^r^}r^(hEX#Transmitted as a UTF-8 String as a hFj]ubj)r^}r^(hEX *Param part*hK}r^(hM]hN]hO]hP]hR]uhFj]h@]r^h^X Param partr^r^}r^(hEUhFj^ubahIjubh^X% of the MIME multipart/mixed message.r^r^}r^(hEX% of the MIME multipart/mixed message.hFj]ubehIhfubahIjubj)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj]h@]r ^hb)r!^}r"^(hEXsysmeta (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.hK}r#^(hM]hN]hO]hP]hR]uhFj^h@]r$^(j)r%^}r&^(hEXsysmetahK}r'^(hP]hO]jhM]hN]hR]uhFj!^h@]r(^h^Xsysmetar)^r*^}r+^(hEUhFj%^ubahIjubh^X (r,^r-^}r.^(hEUhFj!^ubj)r/^}r0^(hEX:class:`Types.SystemMetadata`r1^hFj!^hGjHhIjhK}r2^(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyr3^hP]hO]U refexplicithM]hN]hR]jjjNjjHuhTM8h@]r4^j)r5^}r6^(hEj1^hK}r7^(hM]hN]r8^(jj3^Xpy-classr9^ehO]hP]hR]uhFj/^h@]r:^h^XTypes.SystemMetadatar;^r<^}r=^(hEUhFj5^ubahIjubaubh^X)r>^}r?^(hEUhFj!^ubh^X -- r@^rA^}rB^(hEUhFj!^ubh^XsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rC^rD^}rE^(hEXsTransmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hFj!^ubj)rF^}rG^(hEX *File part*hK}rH^(hM]hN]hO]hP]hR]uhFj!^h@]rI^h^X File partrJ^rK^}rL^(hEUhFjF^ubahIjubh^X% of the MIME multipart/mixed message.rM^rN^}rO^(hEX% of the MIME multipart/mixed message.hFj!^ubehIhfubahIjubehIjmubahIhubehIh}ubhz)rP^}rQ^(hEUhK}rR^(hM]hN]hO]hP]hR]uhFjf]h@]rS^(h)rT^}rU^(hEXReturnshFjP^hGj]hIhhK}rV^(hM]hN]hO]hP]hR]uhTKh@]rW^h^XReturnsrX^rY^}rZ^(hEUhFjT^ubaubh)r[^}r\^(hEUhK}r]^(hM]hN]hO]hP]hR]uhFjP^h@]r^^hb)r_^}r`^(hEX"True if the update was successful.hK}ra^(hM]hN]hO]hP]hR]uhFj[^h@]rb^h^X"True if the update was successful.rc^rd^}re^(hEX"True if the update was successful.rf^hFj_^ubahIhfubahIhubehIh}ubhz)rg^}rh^(hEUhK}ri^(hM]hN]hO]hP]hR]uhFjf]h@]rj^(h)rk^}rl^(hEX Return typehFjg^hGj]hIhhK}rm^(hM]hN]hO]hP]hR]uhTKh@]rn^h^X Return typero^rp^}rq^(hEUhFjk^ubaubh)rr^}rs^(hEUhK}rt^(hM]hN]hO]hP]hR]uhFjg^h@]ru^hb)rv^}rw^(hEXbooleanhK}rx^(hM]hN]hO]hP]hR]uhFjr^h@]ry^j)rz^}r{^(hEUhK}r|^(UreftypejjU reftargetXbooleanU refdomainj]hP]hO]U refexplicithM]hN]hR]uhFjv^h@]r}^h^Xbooleanr~^r^}r^(hEUhFjz^ubahIjubahIhfubahIhubehIh}ubhz)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFjf]h@]r^(h)r^}r^(hEXRaiseshFj^hGj]hIhhK}r^(hM]hN]hO]hP]hR]uhTKh@]r^h^XRaisesr^r^}r^(hEUhFj^ubaubh)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^j)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^(j)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^hb)r^}r^(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=4866)hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^(j)r^}r^(hEUhK}r^(UreftypejjU reftargetXExceptions.NotImplementedr^U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj^h@]r^j)r^}r^(hEj^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^XExceptions.NotImplementedr^r^}r^(hEUhFj^ubahIjubahIjubh^X -- r^r^}r^(hEUhFj^ubj)r^}r^(hEX$``(errorCode=501, detailCode=4866)``r^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^X (errorCode=501, detailCode=4866)r^r^}r^(hEUhFj^ubahIjubehIhfubahIjubj)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^hb)r^}r^(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=4867)hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^(j)r^}r^(hEUhK}r^(UreftypejjU reftargetXExceptions.NotAuthorizedr^U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj^h@]r^j)r^}r^(hEj^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^XExceptions.NotAuthorizedr^r^}r^(hEUhFj^ubahIjubahIjubh^X -- r^r^}r^(hEUhFj^ubj)r^}r^(hEX$``(errorCode=401, detailCode=4867)``r^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^X (errorCode=401, detailCode=4867)r^r^}r^(hEUhFj^ubahIjubehIhfubahIjubj)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^hb)r^}r^(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=4868)hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^(j)r^}r^(hEUhK}r^(UreftypejjU reftargetXExceptions.ServiceFailurer^U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj^h@]r^j)r^}r^(hEj^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^XExceptions.ServiceFailurer^r^}r^(hEUhFj^ubahIjubahIjubh^X -- r^r^}r^(hEUhFj^ubj)r^}r^(hEX$``(errorCode=500, detailCode=4868)``r^hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^h^X (errorCode=500, detailCode=4868)r^r^}r^(hEUhFj^ubahIjubehIhfubahIjubj)r^}r^(hEUhK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^hb)r^}r^(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=4869)hK}r^(hM]hN]hO]hP]hR]uhFj^h@]r^(j)r^}r^(hEUhK}r^(UreftypejjU reftargetXExceptions.InvalidRequestr^U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj^h@]r^j)r^}r^(hEj^hK}r_(hM]hN]hO]hP]hR]uhFj^h@]r_h^XExceptions.InvalidRequestr_r_}r_(hEUhFj^ubahIjubahIjubh^X -- r_r_}r_(hEUhFj^ubj)r_}r _(hEX$``(errorCode=400, detailCode=4869)``r _hK}r _(hM]hN]hO]hP]hR]uhFj^h@]r _h^X (errorCode=400, detailCode=4869)r _r_}r_(hEUhFj_ubahIjubehIhfubahIjubj)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj^h@]r_hb)r_}r_(hEXDExceptions.InvalidSystemMetadata -- (errorCode=400, detailCode=4956)hK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_(j)r_}r_(hEUhK}r_(UreftypejjU reftargetX Exceptions.InvalidSystemMetadatar_U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj_h@]r_j)r_}r_(hEj_hK}r_(hM]hN]hO]hP]hR]uhFj_h@]r _h^X Exceptions.InvalidSystemMetadatar!_r"_}r#_(hEUhFj_ubahIjubahIjubh^X -- r$_r%_}r&_(hEUhFj_ubj)r'_}r(_(hEX$``(errorCode=400, detailCode=4956)``r)_hK}r*_(hM]hN]hO]hP]hR]uhFj_h@]r+_h^X (errorCode=400, detailCode=4956)r,_r-_}r._(hEUhFj'_ubahIjubehIhfubahIjubj)r/_}r0_(hEUhK}r1_(hM]hN]hO]hP]hR]uhFj^h@]r2_hb)r3_}r4_(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=4957)hK}r5_(hM]hN]hO]hP]hR]uhFj/_h@]r6_(j)r7_}r8_(hEUhK}r9_(UreftypejjU reftargetXExceptions.InvalidTokenr:_U refdomainj]hP]hO]U refexplicithM]hN]hR]uhFj3_h@]r;_j)r<_}r=_(hEj:_hK}r>_(hM]hN]hO]hP]hR]uhFj7_h@]r?_h^XExceptions.InvalidTokenr@_rA_}rB_(hEUhFj<_ubahIjubahIjubh^X -- rC_rD_}rE_(hEUhFj3_ubj)rF_}rG_(hEX$``(errorCode=401, detailCode=4957)``rH_hK}rI_(hM]hN]hO]hP]hR]uhFj3_h@]rJ_h^X (errorCode=401, detailCode=4957)rK_rL_}rM_(hEUhFjF_ubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubeubhB)rN_}rO_(hEUhFhChGhHhIhJhK}rP_(hM]hN]hO]hP]rQ_h=ahR]rR_h auhTKhUhh@]rS_(hW)rT_}rU_(hEXReplication APIrV_hFjN_hGhHhIh[hK}rW_(hM]hN]hO]hP]hR]uhTKhUhh@]rX_h^XReplication APIrY_rZ_}r[_(hEjV_hFjT_ubaubhb)r\_}r]_(hEX_The Replication API provides methods to support CN-directed replication of content between MNs.r^_hFjN_hGhHhIhfhK}r__(hM]hN]hO]hP]hR]uhTKhUhh@]r`_h^X_The Replication API provides methods to support CN-directed replication of content between MNs.ra_rb_}rc_(hEj^_hFj\_ubaubje)rd_}re_(hEUhFjN_hGhHhIjihK}rf_(hM]hP]rg_Xmodule-MNReplicationrh_ahO]UismodhN]hR]uhTNhUhh@]ubj)ri_}rj_(hEUhFjN_hGhHhIjhK}rk_(hP]hO]hM]hN]hR]Uentries]rl_(jXMNReplication (module)Xmodule-MNReplicationUNtrm_auhTNhUhh@]ubh)rn_}ro_(hEXBWarning: this file is automatically generated. Edits will be losthFjN_hGjX1source/apis/generated/generated_MNReplication.txtrp_rq_}rr_bhIhhK}rs_(hhhP]hO]hM]hN]hR]uhTKhUhh@]rt_h^XBWarning: this file is automatically generated. Edits will be lostru_rv_}rw_(hEUhFjn_ubaubj)rx_}ry_(hEUhFjN_hGNhIjhK}rz_(hM]hN]hO]hP]r{_Uid9r|_ahR]uhTNhUhh@]r}_(hW)r~_}r_(hEX)Functions defined in :mod:`MNReplication`hK}r_(hM]hN]hO]hP]hR]uhFjx_h@]r_(h^XFunctions defined in r_r_}r_(hEXFunctions defined in hFj~_ubj)r_}r_(hEX:mod:`MNReplication`r_hFj~_hGjq_hIjhK}r_(UreftypeXmodjjX MNReplicationU refdomainXpyr_hP]hO]U refexplicithM]hN]hR]jjjNjX MNReplicationr_uhTKh@]r_j)r_}r_(hEj_hK}r_(hM]hN]r_(jj_Xpy-modr_ehO]hP]hR]uhFj_h@]r_h^X MNReplicationr_r_}r_(hEUhFj_ubahIjubaubehIh[ubj)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolsKuhFjx_h@]r_(j#)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolwidthKuhFj_h@]hIj'ubj#)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolwidthKuhFj_h@]hIj'ubj#)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolwidthK uhFj_h@]hIj'ubj#)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolwidthK uhFj_h@]hIj'ubj#)r_}r_(hEUhK}r_(hP]hO]hM]hN]hR]UcolwidthKuhFj_h@]hIj'ubj4)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_j9)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_(j>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEXTierr_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r_h^XTierr_r_}r_(hEj_hFj_ubaubahIjKubj>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEXVersionr_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r_h^XVersionr_r_}r_(hEj_hFj_ubaubahIjKubj>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEXRESTr_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r_h^XRESTr_r_}r_(hEj_hFj_ubaubahIjKubj>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEXFunctionr_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r_h^XFunctionr_r_}r_(hEj_hFj_ubaubahIjKubj>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEX Parametersr_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTK h@]r_h^X Parametersr_r_}r_(hEj_hFj_ubaubahIjKubehIj|ubahIj}ubj~)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_j9)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_(j>)r_}r_(hEUhK}r_(hM]hN]hO]hP]hR]uhFj_h@]r_hb)r_}r_(hEXTier 4r_hFj_hGjq_hIhfhK}r_(hM]hN]hO]hP]hR]uhTKh@]r_h^XTier 4r_r_}r_(hEj_hFj_ubaubahIjKubj>)r`}r`(hEUhK}r`(hM]hN]hO]hP]hR]uhFj_h@]r`hb)r`}r`(hEX1.0r`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKh@]r`h^X1.0r `r `}r `(hEj`hFj`ubaubahIjKubj>)r `}r `(hEUhK}r`(hM]hN]hO]hP]hR]uhFj_h@]r`hb)r`}r`(hEX``POST /replicate``r`hFj `hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKh@]r`j)r`}r`(hEj`hK}r`(hM]hN]hO]hP]hR]uhFj`h@]r`h^XPOST /replicater`r`}r`(hEUhFj`ubahIjubaubahIjKubj>)r`}r`(hEUhK}r`(hM]hN]hO]hP]hR]uhFj_h@]r`hb)r `}r!`(hEX:func:`replicate`r"`hFj`hGjq_hIhfhK}r#`(hM]hN]hO]hP]hR]uhTKh@]r$`j)r%`}r&`(hEj"`hFj `hGjq_hIjhK}r'`(UreftypeXfuncjjX replicateU refdomainXpyr(`hP]hO]U refexplicithM]hN]hR]jjjNjj_uhTKh@]r)`j)r*`}r+`(hEj"`hK}r,`(hM]hN]r-`(jj(`Xpy-funcr.`ehO]hP]hR]uhFj%`h@]r/`h^X replicate()r0`r1`}r2`(hEUhFj*`ubahIjubaubaubahIjKubj>)r3`}r4`(hEUhK}r5`(hM]hN]hO]hP]hR]uhFj_h@]r6`hb)r7`}r8`(hEX(:class:`session`, :class:`sysmeta`, :class:`sourceNode`) ``->`` booleanr9`hFj3`hGjq_hIhfhK}r:`(hM]hN]hO]hP]hR]uhTKh@]r;`(h^X(r<`}r=`(hEX(hFj7`ubj)r>`}r?`(hEX:class:`session`r@`hFj7`hGjq_hIjhK}rA`(UreftypeXclassjjX Types.SessionU refdomainXpyrB`hP]hO]U refexplicithM]hN]hR]jjjNjj_uhTKh@]rC`j)rD`}rE`(hEj@`hK}rF`(hM]hN]rG`(jjB`Xpy-classrH`ehO]hP]hR]uhFj>`h@]rI`h^XsessionrJ`rK`}rL`(hEUhFjD`ubahIjubaubh^X, rM`rN`}rO`(hEX, hFj7`ubj)rP`}rQ`(hEX&:class:`sysmeta`rR`hFj7`hGjq_hIjhK}rS`(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrT`hP]hO]U refexplicithM]hN]hR]jjjNjj_uhTKh@]rU`j)rV`}rW`(hEjR`hK}rX`(hM]hN]rY`(jjT`Xpy-classrZ`ehO]hP]hR]uhFjP`h@]r[`h^Xsysmetar\`r]`}r^`(hEUhFjV`ubahIjubaubh^X, r_`r``}ra`(hEX, hFj7`ubj)rb`}rc`(hEX(:class:`sourceNode`rd`hFj7`hGjq_hIjhK}re`(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrf`hP]hO]U refexplicithM]hN]hR]jjjNjj_uhTKh@]rg`j)rh`}ri`(hEjd`hK}rj`(hM]hN]rk`(jjf`Xpy-classrl`ehO]hP]hR]uhFjb`h@]rm`h^X sourceNodern`ro`}rp`(hEUhFjh`ubahIjubaubh^X) rq`rr`}rs`(hEX) hFj7`ubj)rt`}ru`(hEX``->``hK}rv`(hM]hN]hO]hP]hR]uhFj7`h@]rw`h^X->rx`ry`}rz`(hEUhFjt`ubahIjubh^X booleanr{`r|`}r}`(hEX booleanhFj7`ubeubahIjKubehIj|ubahIjubehIjubeubj)r~`}r`(hEUhFjN_hGNhIjhK}r`(hP]hO]hM]hN]hR]Uentries]r`(jX%replicate() (in module MNReplication)hUNtr`auhTNhUhh@]ubj)r`}r`(hEUhFjN_hGNhIjhK}r`(jjXpyr`hP]hO]hM]hN]hR]jXfunctionr`jj`uhTNhUhh@]r`(j)r`}r`(hEX0replicate(session,sysmeta,sourceNode) -> booleanhFj`hGjq_hIjhK}r`(hP]r`hajj_hO]hM]hN]hR]r`hajX replicater`jUjuhTK?hUhh@]r`(j)r`}r`(hEXMNReplication.hFj`hGjq_hIjhK}r`(hM]hN]hO]hP]hR]uhTK?hUhh@]r`h^XMNReplication.r`r`}r`(hEUhFj`ubaubj)r`}r`(hEj`hFj`hGjq_hIjhK}r`(hM]hN]hO]hP]hR]uhTK?hUhh@]r`h^X replicater`r`}r`(hEUhFj`ubaubj)r`}r`(hEXsession, sysmeta, sourceNodehFj`hGjq_hIjhK}r`(hM]hN]hO]hP]hR]uhTK?hUhh@]r`(j)r`}r`(hEXsessionhK}r`(hM]hN]hO]hP]hR]uhFj`h@]r`h^Xsessionr`r`}r`(hEUhFj`ubahIjubj)r`}r`(hEXsysmetahK}r`(hM]hN]hO]hP]hR]uhFj`h@]r`h^Xsysmetar`r`}r`(hEUhFj`ubahIjubj)r`}r`(hEX sourceNodehK}r`(hM]hN]hO]hP]hR]uhFj`h@]r`h^X sourceNoder`r`}r`(hEUhFj`ubahIjubeubj)r`}r`(hEXbooleanhFj`hGjq_hIjhK}r`(hM]hN]hO]hP]hR]uhTK?hUhh@]r`h^Xbooleanr`r`}r`(hEUhFj`ubaubeubj)r`}r`(hEUhFj`hGjq_hIj hK}r`(hM]hN]hO]hP]hR]uhTK?hUhh@]r`(hb)r`}r`(hEXCalled by a Coordinating Node to request that the Member Node create a copy of the specified object by retrieving it from another Member Nodeode and storing it locally so that it can be made accessible to the DataONE system.r`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKhUhh@]r`h^XCalled by a Coordinating Node to request that the Member Node create a copy of the specified object by retrieving it from another Member Nodeode and storing it locally so that it can be made accessible to the DataONE system.r`r`}r`(hEj`hFj`ubaubhb)r`}r`(hEXLA successful operation is indicated by a HTTP status of 200 on the response.r`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKhUhh@]r`h^XLA successful operation is indicated by a HTTP status of 200 on the response.r`r`}r`(hEj`hFj`ubaubhb)r`}r`(hEXQFailure of the operation MUST be indicated by returning an appropriate exception.r`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKhUhh@]r`h^XQFailure of the operation MUST be indicated by returning an appropriate exception.r`r`}r`(hEj`hFj`ubaubhb)r`}r`(hEXYAccess control for this method MUST be configured to allow calling by Coordinating Nodes.r`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTKhUhh@]r`h^XYAccess control for this method MUST be configured to allow calling by Coordinating Nodes.r`r`}r`(hEj`hFj`ubaubht)r`}r`(hEUhFj`hGNhIhwhK}r`(hM]hN]hO]hP]hR]uhTNhUhh@]r`(hz)r`}r`(hEUhFj`hGjq_hIh}hK}r`(hM]hN]hO]hP]hR]uhTK!hUhh@]r`(h)r`}r`(hEXVersionhFj`hGjq_hIhhK}r`(hM]hN]hO]hP]hR]uhTKh@]r`h^XVersionr`r`}r`(hEUhFj`ubaubh)r`}r`(hEX1.0r`hK}r`(hM]hN]hO]hP]hR]uhFj`h@]r`hb)r`}r`(hEj`hFj`hGjq_hIhfhK}r`(hM]hN]hO]hP]hR]uhTK!h@]r`h^X1.0r`r`}r`(hEj`hFj`ubaubahIhubeubhz)r`}r`(hEUhFj`hGjq_hIh}hK}r`(hM]hN]hO]hP]hR]uhTK"hUhh@]ra(h)ra}ra(hEX Use CaseshFj`hGjq_hIhhK}ra(hM]hN]hO]hP]hR]uhTKh@]rah^X Use Casesrara}ra(hEUhFjaubaubh)ra}r a(hEX$:doc:`UC09 `r ahK}r a(hM]hN]hO]hP]hR]uhFj`h@]r ahb)r a}ra(hEj ahFjahGjq_hIhfhK}ra(hM]hN]hO]hP]hR]uhTK#h@]raj)ra}ra(hEj ahFj ahGjq_hIjhK}ra(UreftypeXdocrajjX/design/UseCases/09_ucU refdomainUhP]hO]U refexplicithM]hN]hR]jjuhTK#h@]rajr)ra}ra(hEj ahK}ra(hM]hN]ra(jjaehO]hP]hR]uhFjah@]rah^XUC09rara}ra(hEUhFjaubahIj{ubaubaubahIhubeubhz)ra}ra(hEUhFj`hGjq_hIh}hK}r a(hM]hN]hO]hP]hR]uhTK$hUhh@]r!a(h)r"a}r#a(hEXREST URLhFjahGjq_hIhhK}r$a(hM]hN]hO]hP]hR]uhTKh@]r%ah^XREST URLr&ar'a}r(a(hEUhFj"aubaubh)r)a}r*a(hEX``POST /replicate``r+ahK}r,a(hM]hN]hO]hP]hR]uhFjah@]r-ahb)r.a}r/a(hEj+ahFj)ahGjq_hIhfhK}r0a(hM]hN]hO]hP]hR]uhTK$h@]r1aj)r2a}r3a(hEj+ahK}r4a(hM]hN]hO]hP]hR]uhFj.ah@]r5ah^XPOST /replicater6ar7a}r8a(hEUhFj2aubahIjubaubahIhubeubhz)r9a}r:a(hEUhK}r;a(hM]hN]hO]hP]hR]uhFj`h@]ra(hEX ParametershFj9ahGjq_hIhhK}r?a(hM]hN]hO]hP]hR]uhTKh@]r@ah^X ParametersrAarBa}rCa(hEUhFj=aubaubh)rDa}rEa(hEUhK}rFa(hM]hN]hO]hP]hR]uhFj9ah@]rGaj)rHa}rIa(hEUhK}rJa(hM]hN]hO]hP]hR]uhFjDah@]rKa(j)rLa}rMa(hEUhK}rNa(hM]hN]hO]hP]hR]uhFjHah@]rOahb)rPa}rQa(hEXTsession (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.hK}rRa(hM]hN]hO]hP]hR]uhFjLah@]rSa(j)rTa}rUa(hEXsessionhK}rVa(hP]hO]jhM]hN]hR]uhFjPah@]rWah^XsessionrXarYa}rZa(hEUhFjTaubahIjubh^X (r[ar\a}r]a(hEUhFjPaubj)r^a}r_a(hEX:class:`Types.Session`r`ahFjPahGjq_hIjhK}raa(UreftypeXclassjjX Types.SessionU refdomainXpyrbahP]hO]U refexplicithM]hN]hR]jjjNjj_uhTK&h@]rcaj)rda}rea(hEj`ahK}rfa(hM]hN]rga(jjbaXpy-classrhaehO]hP]hR]uhFj^ah@]riah^X Types.Sessionrjarka}rla(hEUhFjdaubahIjubaubh^X)rma}rna(hEUhFjPaubh^X -- roarpa}rqa(hEUhFjPaubh^XSession 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 rrarsa}rta(hEXSession 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 hFjPaubj)rua}rva(hEX:term:`public user`rwahFjPahGjq_hIjhK}rxa(UreftypeXtermjjX public userU refdomainXstdryahP]hO]U refexplicithM]hN]hR]jjuhTK%h@]rzajr)r{a}r|a(hEjwahK}r}a(hM]hN]r~a(jjyaXstd-termraehO]hP]hR]uhFjuah@]rah^X public userrara}ra(hEUhFj{aubahIj{ubaubh^Xh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.rara}ra(hEXh if the certificate was not provided with the request. Transmitted as part of the SSL handshake process.hFjPaubehIhfubahIjubj)ra}ra(hEUhK}ra(hM]hN]hO]hP]hR]uhFjHah@]rahb)ra}ra(hEXsysmeta (Types.SystemMetadata) -- Copy of the CN held system metadata for 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.hK}ra(hM]hN]hO]hP]hR]uhFjah@]ra(j)ra}ra(hEXsysmetahK}ra(hP]hO]jhM]hN]hR]uhFjah@]rah^Xsysmetarara}ra(hEUhFjaubahIjubh^X (rara}ra(hEUhFjaubj)ra}ra(hEX:class:`Types.SystemMetadata`rahFjahGjq_hIjhK}ra(UreftypeXclassjjXTypes.SystemMetadataU refdomainXpyrahP]hO]U refexplicithM]hN]hR]jjjNjj_uhTK)h@]raj)ra}ra(hEjahK}ra(hM]hN]ra(jjaXpy-classraehO]hP]hR]uhFjah@]rah^XTypes.SystemMetadatarara}ra(hEUhFjaubahIjubaubh^X)ra}ra(hEUhFjaubh^X -- rara}ra(hEUhFjaubh^XCopy of the CN held system metadata for the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a rara}ra(hEXCopy of the CN held system metadata for the object. Transmitted as an UTF-8 encoded XML structure for the respective type as defined in the DataONE types schema, as a hFjaubj)ra}ra(hEX *File part*hK}ra(hM]hN]hO]hP]hR]uhFjah@]rah^X File partrara}ra(hEUhFjaubahIjubh^X% of the MIME multipart/mixed message.rara}ra(hEX% of the MIME multipart/mixed message.hFjaubehIhfubahIjubj)ra}ra(hEUhK}ra(hM]hN]hO]hP]hR]uhFjHah@]rahb)ra}ra(hEXsourceNode (Types.NodeReference) -- A reference to node from which the content should be retrieved. The reference should be resolved by checking the CN node registry. Transmitted as a UTF-8 String as a Param part of the MIME multipart/mixed message.hK}ra(hM]hN]hO]hP]hR]uhFjah@]ra(j)ra}ra(hEX sourceNodehK}ra(hP]hO]jhM]hN]hR]uhFjah@]rah^X sourceNoderara}ra(hEUhFjaubahIjubh^X (rara}ra(hEUhFjaubj)ra}ra(hEX:class:`Types.NodeReference`rahFjahGjq_hIjhK}ra(UreftypeXclassjjXTypes.NodeReferenceU refdomainXpyrahP]hO]U refexplicithM]hN]hR]jjjNjj_uhTK,h@]raj)ra}ra(hEjahK}ra(hM]hN]ra(jjaXpy-classraehO]hP]hR]uhFjah@]rah^XTypes.NodeReferencerara}ra(hEUhFjaubahIjubaubh^X)ra}ra(hEUhFjaubh^X -- rara}ra(hEUhFjaubh^XA reference to node from which the content should be retrieved. The reference should be resolved by checking the CN node registry. Transmitted as a UTF-8 String as a rara}ra(hEXA reference to node from which the content should be retrieved. The reference should be resolved by checking the CN node registry. Transmitted as a UTF-8 String as a hFjaubj)ra}ra(hEX *Param part*hK}ra(hM]hN]hO]hP]hR]uhFjah@]rah^X Param partrara}ra(hEUhFjaubahIjubh^X% of the MIME multipart/mixed message.rara}ra(hEX% of the MIME multipart/mixed message.hFjaubehIhfubahIjubehIjmubahIhubehIh}ubhz)ra}ra(hEUhK}ra(hM]hN]hO]hP]hR]uhFj`h@]ra(h)ra}ra(hEXReturnshFjahGjq_hIhhK}ra(hM]hN]hO]hP]hR]uhTKh@]rah^XReturnsrara}ra(hEUhFjaubaubh)ra}ra(hEUhK}ra(hM]hN]hO]hP]hR]uhFjah@]rahb)ra}ra(hEX<True if everything works OK, otherwise an error is returned.hK}ra(hM]hN]hO]hP]hR]uhFjah@]rah^X<True if everything works OK, otherwise an error is returned.rbrb}rb(hEX<True if everything works OK, otherwise an error is returned.rbhFjaubahIhfubahIhubehIh}ubhz)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFj`h@]rb(h)rb}r b(hEX Return typehFjbhGjq_hIhhK}r b(hM]hN]hO]hP]hR]uhTKh@]r bh^X Return typer br b}rb(hEUhFjbubaubh)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbhb)rb}rb(hEXbooleanhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbj)rb}rb(hEUhK}rb(UreftypejjU reftargetXbooleanU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjbh@]rbh^Xbooleanrbrb}rb(hEUhFjbubahIjubahIhfubahIhubehIh}ubhz)rb}rb(hEUhK}r b(hM]hN]hO]hP]hR]uhFj`h@]r!b(h)r"b}r#b(hEXRaiseshFjbhGjq_hIhhK}r$b(hM]hN]hO]hP]hR]uhTKh@]r%bh^XRaisesr&br'b}r(b(hEUhFj"bubaubh)r)b}r*b(hEUhK}r+b(hM]hN]hO]hP]hR]uhFjbh@]r,bj)r-b}r.b(hEUhK}r/b(hM]hN]hO]hP]hR]uhFj)bh@]r0b(j)r1b}r2b(hEUhK}r3b(hM]hN]hO]hP]hR]uhFj-bh@]r4bhb)r5b}r6b(hEX=Exceptions.NotImplemented -- (errorCode=501, detailCode=2150)hK}r7b(hM]hN]hO]hP]hR]uhFj1bh@]r8b(j)r9b}r:b(hEUhK}r;b(UreftypejjU reftargetXExceptions.NotImplementedrb}r?b(hEjbubahIjubahIjubh^X -- rEbrFb}rGb(hEUhFj5bubj)rHb}rIb(hEX$``(errorCode=501, detailCode=2150)``rJbhK}rKb(hM]hN]hO]hP]hR]uhFj5bh@]rLbh^X (errorCode=501, detailCode=2150)rMbrNb}rOb(hEUhFjHbubahIjubehIhfubahIjubj)rPb}rQb(hEUhK}rRb(hM]hN]hO]hP]hR]uhFj-bh@]rSbhb)rTb}rUb(hEX=Exceptions.ServiceFailure -- (errorCode=500, detailCode=2151)hK}rVb(hM]hN]hO]hP]hR]uhFjPbh@]rWb(j)rXb}rYb(hEUhK}rZb(UreftypejjU reftargetXExceptions.ServiceFailurer[bU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjTbh@]r\bj)r]b}r^b(hEj[bhK}r_b(hM]hN]hO]hP]hR]uhFjXbh@]r`bh^XExceptions.ServiceFailurerabrbb}rcb(hEUhFj]bubahIjubahIjubh^X -- rdbreb}rfb(hEUhFjTbubj)rgb}rhb(hEX$``(errorCode=500, detailCode=2151)``ribhK}rjb(hM]hN]hO]hP]hR]uhFjTbh@]rkbh^X (errorCode=500, detailCode=2151)rlbrmb}rnb(hEUhFjgbubahIjubehIhfubahIjubj)rob}rpb(hEUhK}rqb(hM]hN]hO]hP]hR]uhFj-bh@]rrbhb)rsb}rtb(hEX<Exceptions.NotAuthorized -- (errorCode=401, detailCode=2152)hK}rub(hM]hN]hO]hP]hR]uhFjobh@]rvb(j)rwb}rxb(hEUhK}ryb(UreftypejjU reftargetXExceptions.NotAuthorizedrzbU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjsbh@]r{bj)r|b}r}b(hEjzbhK}r~b(hM]hN]hO]hP]hR]uhFjwbh@]rbh^XExceptions.NotAuthorizedrbrb}rb(hEUhFj|bubahIjubahIjubh^X -- rbrb}rb(hEUhFjsbubj)rb}rb(hEX$``(errorCode=401, detailCode=2152)``rbhK}rb(hM]hN]hO]hP]hR]uhFjsbh@]rbh^X (errorCode=401, detailCode=2152)rbrb}rb(hEUhFjbubahIjubehIhfubahIjubj)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFj-bh@]rbhb)rb}rb(hEX=Exceptions.InvalidRequest -- (errorCode=400, detailCode=2153)hK}rb(hM]hN]hO]hP]hR]uhFjbh@]rb(j)rb}rb(hEUhK}rb(UreftypejjU reftargetXExceptions.InvalidRequestrbU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjbh@]rbj)rb}rb(hEjbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^XExceptions.InvalidRequestrbrb}rb(hEUhFjbubahIjubahIjubh^X -- rbrb}rb(hEUhFjbubj)rb}rb(hEX$``(errorCode=400, detailCode=2153)``rbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^X (errorCode=400, detailCode=2153)rbrb}rb(hEUhFjbubahIjubehIhfubahIjubj)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFj-bh@]rbhb)rb}rb(hEXDExceptions.InsufficientResources -- (errorCode=413, detailCode=2154)hK}rb(hM]hN]hO]hP]hR]uhFjbh@]rb(j)rb}rb(hEUhK}rb(UreftypejjU reftargetX Exceptions.InsufficientResourcesrbU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjbh@]rbj)rb}rb(hEjbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^X Exceptions.InsufficientResourcesrbrb}rb(hEUhFjbubahIjubahIjubh^X -- rbrb}rb(hEUhFjbubj)rb}rb(hEX$``(errorCode=413, detailCode=2154)``rbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^X (errorCode=413, detailCode=2154)rbrb}rb(hEUhFjbubahIjubehIhfubahIjubj)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFj-bh@]rbhb)rb}rb(hEX>Exceptions.UnsupportedType -- (errorCode=400, detailCode=2155)hK}rb(hM]hN]hO]hP]hR]uhFjbh@]rb(j)rb}rb(hEUhK}rb(UreftypejjU reftargetXExceptions.UnsupportedTyperbU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjbh@]rbj)rb}rb(hEjbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^XExceptions.UnsupportedTyperbrb}rb(hEUhFjbubahIjubahIjubh^X -- rbrb}rb(hEUhFjbubj)rb}rb(hEX$``(errorCode=400, detailCode=2155)``rbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^X (errorCode=400, detailCode=2155)rbrb}rb(hEUhFjbubahIjubehIhfubahIjubj)rb}rb(hEUhK}rb(hM]hN]hO]hP]hR]uhFj-bh@]rbhb)rb}rb(hEX;Exceptions.InvalidToken -- (errorCode=401, detailCode=2156)hK}rb(hM]hN]hO]hP]hR]uhFjbh@]rb(j)rb}rb(hEUhK}rb(UreftypejjU reftargetXExceptions.InvalidTokenrbU refdomainj`hP]hO]U refexplicithM]hN]hR]uhFjbh@]rbj)rb}rb(hEjbhK}rb(hM]hN]hO]hP]hR]uhFjbh@]rbh^XExceptions.InvalidTokenrbrb}rb(hEUhFjbubahIjubahIjubh^X -- rbrc}rc(hEUhFjbubj)rc}rc(hEX$``(errorCode=401, detailCode=2156)``rchK}rc(hM]hN]hO]hP]hR]uhFjbh@]rch^X (errorCode=401, detailCode=2156)rcrc}r c(hEUhFjcubahIjubehIhfubahIjubehIjmubahIhubehIh}ubeubeubeubhb)r c}r c(hEX **Response**r chFjN_hGjX"source/apis/examples/replicate.txtr crc}rcbhIhfhK}rc(hM]hN]hO]hP]hR]uhTKhUhh@]rcj|)rc}rc(hEj chK}rc(hM]hN]hO]hP]hR]uhFj ch@]rch^XResponsercrc}rc(hEUhFjcubahIjubaubhb)rc}rc(hEX^The 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.hFjN_hGjchIhfhK}rc(hM]hN]hO]hP]hR]uhTKhUhh@]rc(h^X<The 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 rcrc}rc(hEX<The 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 hFjcubj)r c}r!c(hEX*may*hK}r"c(hM]hN]hO]hP]hR]uhFjch@]r#ch^Xmayr$cr%c}r&c(hEUhFj cubahIjubh^X be returned in the response.r'cr(c}r)c(hEX be returned in the response.hFjcubeubhb)r*c}r+c(hEXThe outgoing request body *must* be encoded as `MIME multipart/form-data`_ with the system metadata portion as a file attachment and the sourceNode parameter as a form field.hFjN_hGjchIhfhK}r,c(hM]hN]hO]hP]hR]uhTK hUhh@]r-c(h^XThe outgoing request body r.cr/c}r0c(hEXThe outgoing request body hFj*cubj)r1c}r2c(hEX*must*hK}r3c(hM]hN]hO]hP]hR]uhFj*ch@]r4ch^Xmustr5cr6c}r7c(hEUhFj1cubahIjubh^X be encoded as r8cr9c}r:c(hEX be encoded as hFj*cubj,)r;c}rch^XMIME multipart/form-datar?cr@c}rAc(hEUhFj;cubaubh^Xd with the system metadata portion as a file attachment and the sourceNode parameter as a form field.rBcrCc}rDc(hEXd with the system metadata portion as a file attachment and the sourceNode parameter as a form field.hFj*cubeubj)rEc}rFc(hEXcurl -v -X POST "https://localhost:8000/mn/v1/replicate" \ -H "Content-type: multipart/form-data" \ -F "sysmeta=@systemmetadata.xml" \ -F "sourceNode=urn:node:MN_B" * About to connect() to localhost port 8000 (#0) * Trying ::1... Connection refused * Trying fe80::1... Connection refused * Trying 127.0.0.1... connected * Connected to localhost (127.0.0.1) port 8000 (#0) > POST /mn/v1/replicate HTTP/1.1 > User-Agent: curl/7.19.7 (universal-apple-darwin10.0) libcurl/7.19.7 OpenSSL/0.9.8l zlib/1.2.3 > Host: localhost:8000 > Accept: */* > Content-Length: 1021 > Expect: 100-continue > Content-type: multipart/form-data; boundary=----------------------------88ffdd8070e9 > * Done waiting for 100-continue * HTTP 1.0, assume close after body < HTTP/1.0 200 OK < Date: Fri, 14 Jan 2011 22:01:13 GMT < Server: WSGIServer/0.1 Python/2.6.1 < Content-Type: text/xml < < * Closing connection #0hFjN_hGjchIjhK}rGc(hhhP]hO]hM]hN]hR]uhTMhUhh@]rHch^Xcurl -v -X POST "https://localhost:8000/mn/v1/replicate" \ -H "Content-type: multipart/form-data" \ -F "sysmeta=@systemmetadata.xml" \ -F "sourceNode=urn:node:MN_B" * About to connect() to localhost port 8000 (#0) * Trying ::1... Connection refused * Trying fe80::1... Connection refused * Trying 127.0.0.1... connected * Connected to localhost (127.0.0.1) port 8000 (#0) > POST /mn/v1/replicate HTTP/1.1 > User-Agent: curl/7.19.7 (universal-apple-darwin10.0) libcurl/7.19.7 OpenSSL/0.9.8l zlib/1.2.3 > Host: localhost:8000 > Accept: */* > Content-Length: 1021 > Expect: 100-continue > Content-type: multipart/form-data; boundary=----------------------------88ffdd8070e9 > * Done waiting for 100-continue * HTTP 1.0, assume close after body < HTTP/1.0 200 OK < Date: Fri, 14 Jan 2011 22:01:13 GMT < Server: WSGIServer/0.1 Python/2.6.1 < Content-Type: text/xml < < * Closing connection #0rIcrJc}rKc(hEUhFjEcubaubje)rLc}rMc(hEXA.. _MIME multipart/form-data: http://www.ietf.org/rfc/rfc2388.txtjhKhFjN_hGjchIjihK}rNc(j\jPhP]rOch>ahO]hM]hN]hR]rPch$auhTMhUhh@]ubeubeubahEUU transformerrQcNU footnote_refsrRc}rScUrefnamesrTc}rUc(j[]rVcjWajP]rWcjPaXmime multipart/form-data]rXc(jPj;ceuUsymbol_footnotesrYc]rZcUautofootnote_refsr[c]r\cUsymbol_footnote_refsr]c]r^cU citationsr_c]r`chUhU current_lineracNUtransform_messagesrbc]rcc(cdocutils.nodes system_message rdc)rec}rfc(hEUhK}rgc(hM]UlevelKhP]hO]UsourcejHhN]hR]UtypeUINFOrhcuh@]richb)rjc}rkc(hEUhK}rlc(hM]hN]hO]hP]hR]uhFjech@]rmch^X-Hyperlink target "index-0" is not referenced.rncroc}rpc(hEUhFjjcubahIhfubahIUsystem_messagerqcubjdc)rrc}rsc(hEUhK}rtc(hM]UlevelKhP]hO]UsourcehHhN]hR]Utypejhcuh@]ruchb)rvc}rwc(hEUhK}rxc(hM]hN]hO]hP]hR]uhFjrch@]rych^X:Hyperlink target "module-MNReplication" is not referenced.rzcr{c}r|c(hEUhFjvcubahIhfubahIjqcubeUreporterr}cNUid_startr~cK U autofootnotesrc]rcU citation_refsrc}rcUindirect_targetsrc]rcUsettingsrc(cdocutils.frontend Values rcorc}rc(Ufootnote_backlinksrcKUrecord_dependenciesrcNU rfc_base_urlrcUhttps://tools.ietf.org/html/rcU tracebackrcUpep_referencesrcNUstrip_commentsrcNU toc_backlinksrcjKU language_codercUenrcU datestamprcNU report_levelrcKU _destinationrcNU halt_levelrcKU strip_classesrcNh[NUerror_encoding_error_handlerrcUbackslashreplacercUdebugrcNUembed_stylesheetrcUoutput_encoding_error_handlerrcUstrictrcU sectnum_xformrcKUdump_transformsrcNU docinfo_xformrcKUwarning_streamrcNUpep_file_url_templatercUpep-%04drcUexit_status_levelrcKUconfigrcNUstrict_visitorrcNUcloak_email_addressesrcUtrim_footnote_reference_spacercUenvrcNUdump_pseudo_xmlrcNUexpose_internalsrcNUsectsubtitle_xformrcU source_linkrcNUrfc_referencesrcNUoutput_encodingrcUutf-8rcU source_urlrcNUinput_encodingrcU utf-8-sigrcU_disable_configrcNU id_prefixrcUU tab_widthrcKUerror_encodingrcUUTF-8rcU_sourcerchHUgettext_compactrcU generatorrcNUdump_internalsrcNU smart_quotesrcU pep_base_urlrcU https://www.python.org/dev/peps/rcUsyntax_highlightrcUlongrcUinput_encoding_error_handlerrcjcUauto_id_prefixrcUidrcUdoctitle_xformrcUstrip_elements_with_classesrcNU _config_filesrc]Ufile_insertion_enabledrcU raw_enabledrcKU dump_settingsrcNubUsymbol_footnote_startrcKUidsrc}rc(jje)rc}rc(hEUhFjhGhHhIjihK}rc(hM]hP]rcjahO]UismodhN]hR]uhTNhUhh@]ubjjh=jN_jjh jFh9jfh j h6jfQh jvQjHje)rc}rc(hEUhFjHhGhHhIjihK}rc(hM]hP]rcjHahO]UismodhN]hR]uhTNhUhh@]ubh7j8AjM3je)rc}rc(hEUhFjI3hGhHhIjihK}rc(hM]hP]rcjM3ahO]UismodhN]hR]uhTNhUhh@]ubhjBhj&hjhj9hj]jh_jd_j|_jx_jkAjgAjje)rc}rc(hEUhFjhGhHhIjihK}rc(hM]hP]rcjahO]UismodhN]hR]uhTNhUhh@]ubj|3jx3j;j;h:j;h?jDjjhjC=jkXjmXhjhj`h5jhj,h4jHhj0hjLchj"8h!jLh8hCjHjHj