GET v1/{subscriptionID}/projects/{projectID}/documents

Gets all documents in a project.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns all documents for the specified project ID.

Collection of DocumentViewModel
NameDescriptionTypeAdditional information
UProduceDocumentID

Gets the document ID in uProduce.

globally unique identifier

None.

FriendlyID

Gets the friendly ID of the document.

string

None.

ID

Gets the document ID.

globally unique identifier

None.

Name

Gets the document name.

string

None.

Type

Gets the document type.

DocumentType

None.

ModificationTime

Gets the last modification time of the document.

date

None.

Modifier

Gets the user who was the last to modify the document.

UserViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UProduceDocumentID": "cc4e54af-2ee1-48e4-b082-c5f6025834ce",
    "FriendlyID": "sample string 2",
    "ID": "a7b70621-88ff-4688-860b-60fd84ba2b2d",
    "Name": "sample string 4",
    "Type": 1,
    "ModificationTime": "2021-12-02T21:06:29.4249189Z",
    "Modifier": {
      "ID": "20f6cb33-2951-4785-8e13-b8802a2ac1c5",
      "Name": "sample string 2"
    }
  },
  {
    "UProduceDocumentID": "cc4e54af-2ee1-48e4-b082-c5f6025834ce",
    "FriendlyID": "sample string 2",
    "ID": "a7b70621-88ff-4688-860b-60fd84ba2b2d",
    "Name": "sample string 4",
    "Type": 1,
    "ModificationTime": "2021-12-02T21:06:29.4249189Z",
    "Modifier": {
      "ID": "20f6cb33-2951-4785-8e13-b8802a2ac1c5",
      "Name": "sample string 2"
    }
  }
]