GET_workflows

/workflows

Lists all items in the workflow pool.

BUG: Users who have submitted items to workflow can view all workflow items. To limit what they can see to only their submissions, use the querystring parameter submitter and set it to the id of the current user.

Endpoint URL: http://path/to/rest/workflows.format

Response Formats: xml, json

HTTP Methods: GET

Parameters:

ParameterDescription

fields
(optional)

Filter the workflows by one or more fields. Multiple fields are separated by a comma.

Search parameters take the form <field_name>:<field_value>.

Example:

fields=dc.title:Title,dc.author:Hayden Young

reviewer
(optional)

Show only workflows owned by the reviewer, identified by their DSpace user id.

Example:

reviewer=53

status
(optional)

Show only those workflows with a particular status. Possible values are:

  • "pool", for items in the workflow pool,
  • "review", for items currently under review by another user.

Example:

status=review

submitter
(optional)

Show only those workflows which were submitted by a user, identified by their DSpace user id.

Example:

submitter=84

Response Codes: 200, 400, 500

Example:

GET http://path/to/rest/workflows.xml?status=pool

<?xml version="1.0" encoding="utf-8"?>
<workflows>
    <workflow>
        <collection>
            <handle>123456789/21</handle>
            <id>1</id>
            <name>Test Collection</name>
        </collection>
        <id>18</id>
        <item>
            <handle />
            <id>18</id>
            <isArchived>false</isArchived>
            <isWithdrawn>false</isWithdrawn>
            <lastModified>1338887302642</lastModified>
            <metadata>
                <metadata>
                    <element>contributor</element>
                    <id>151</id>
                    <qualifier>author</qualifier>
                    <schema>dc</schema>
                    <value>Hayden Young</value>
                </metadata>
                <metadata>
                    <element>description</element>
                    <id>152</id>
                    <qualifier>provenance</qualifier>
                    <schema>dc</schema>
                    <value>Submitted by Contributor User
                    (contributor@example.com) on
                    2012-04-16T09:05:29Z No. of bitstreams: 1
                    photo.jpg: 20290 bytes, checksum:
                    f9d68e018b7174e36d57675fb632e698 (MD5)</value>
                </metadata>
                <metadata>
                    <element>description</element>
                    <id>1862</id>
                    <qualifier>provenance</qualifier>
                    <schema>dc</schema>
                    <value>Approved for entry into archive by
                    Regional Reviewer (reviewer@example.com) on
                    2012-06-05T09:08:22Z (GMT) No. of bitstreams: 2
                    photo.jpg: 20290 bytes, checksum:
                    f9d68e018b7174e36d57675fb632e698 (MD5)
                    02012-04-16T0905260000.zip: 21338 bytes,
                    checksum: a45cc1aae6251e781cecd288fd0855a6
                    (MD5)</value>
                </metadata>
                <metadata>
                    <element>title</element>
                    <id>150</id>
                    <qualifier />
                    <schema>dc</schema>
                    <value>My Third Test Item</value>
                </metadata>
                <metadata>
                    <element>date</element>
                    <id>153</id>
                    <qualifier>updated</qualifier>
                    <schema>dc</schema>
                    <value>2012-04-16T09:05:29Z</value>
                </metadata>
            </metadata>
            <name>My Third Test Item</name>
            <submitter>
                <canLogIn>true</canLogIn>
                <email>contributor@example.com</email>
                <firstName>Contributor</firstName>
                <fullName>Contributor User</fullName>
                <id>28</id>
                <language />
                <lastName>User</lastName>
                <netId />
                <phone />
                <requireCertificate>false</requireCertificate>
                <selfRegistered>false</selfRegistered>
            </submitter>
        </item>
        <reviewer>
            <canLogIn>true</canLogIn>
            <email>reviewer@example.com</email>
            <firstName>Reviewer</firstName>
            <fullName>Reviewer User</fullName>
            <id>26</id>
            <language />
            <lastName>User</lastName>
            <netId />
            <phone />
            <requireCertificate>false</requireCertificate>
            <selfRegistered>false</selfRegistered>
        </reviewer>
        <state>3</state>
    </workflow>
</workflows>