List Attachments

GET

https://api.fortresstech.io/v1/workOrders/:workOrderId/attachments

GET

/v1/workOrders/:workOrderId/attachments

$ curl -G https://api.fortresstech.io/v1/workOrders/workOrderId/attachments \
>      --data-urlencode fields=id,name,property.*,documents.type

200Retrieved

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "name": "name",
4   "organizationId": "organizationId",
5   "propertyId": "propertyId",
6   "type": "ISSUE",
7   "updatedAt": "2024-01-15T09:30:00Z",
8   "url": "url",
9   "workOrderId": "workOrderId",
10   "customer": {
11     "firstName": "firstName",
12     "middleName": "middleName",
13     "lastName": "lastName",
14     "preferredName": "preferredName",
15     "suffix": "suffix",
16     "birthDate": "birthDate",
17     "status": "APPLICANT",
18     "email": "email",
19     "phone": "phone",
20     "gender": "gender",
21     "headOfHousehold": true,
22     "relationship": "PARTNER",
23     "id": "id",
24     "readableId": "readableId",
25     "idempotencyId": "idempotencyId",
26     "createdAt": "2024-01-15T09:30:00Z",
27     "updatedAt": "2024-01-15T09:30:00Z",
28     "deletedAt": "2024-01-15T09:30:00Z",
29     "householdId": "householdId",
30     "propertyId": "propertyId",
31     "organizationId": "organizationId"
32   },
33   "customerId": "customerId",
34   "deletedAt": "2024-01-15T09:30:00Z",
35   "household": {
36     "status": "APPLICANT",
37     "isUnderEviction": true,
38     "id": "id",
39     "readableId": "readableId",
40     "idempotencyId": "idempotencyId",
41     "createdAt": "2024-01-15T09:30:00Z",
42     "updatedAt": "2024-01-15T09:30:00Z",
43     "deletedAt": "2024-01-15T09:30:00Z",
44     "currentUnitId": "currentUnitId",
45     "currentLeaseId": "currentLeaseId",
46     "applicationId": "applicationId",
47     "organizationId": "organizationId",
48     "propertyId": "propertyId",
49     "currentCertificationId": "currentCertificationId",
50     "prospectId": "prospectId",
51     "primaryCustomerId": "primaryCustomerId",
52     "totalActiveRentAmount": 1.1,
53     "totalActiveSubsidyAmount": 1.1,
54     "totalActiveFeesAmount": 1.1,
55     "unitId": "unitId"
56   },
57   "householdId": "householdId",
58   "id": "id",
59   "idempotencyId": "idempotencyId",
60   "notes": "notes",
61   "organization": {
62     "key": "value"
63   },
64   "property": {
65     "name": "name",
66     "shortName": "shortName",
67     "email": "email",
68     "phone": "phone",
69     "physicalStreetAddress1": "physicalStreetAddress1",
70     "physicalStreetAddress2": "physicalStreetAddress2",
71     "physicalCity": "physicalCity",
72     "physicalState": "physicalState",
73     "physicalZip": "physicalZip",
74     "physicalCountry": "physicalCountry",
75     "mailingStreetAddress1": "mailingStreetAddress1",
76     "mailingStreetAddress2": "mailingStreetAddress2",
77     "mailingCity": "mailingCity",
78     "mailingState": "mailingState",
79     "mailingZip": "mailingZip",
80     "mailingCountry": "mailingCountry",
81     "phoneNumber": "phoneNumber",
82     "faxNumber": "faxNumber",
83     "timezone": "timezone",
84     "longitude": 1.1,
85     "latitude": 1.1,
86     "turnMoveOutDays": 1,
87     "status": "ACTIVE",
88     "propertyClass": "Conventional",
89     "organizationId": "organizationId",
90     "id": "id",
91     "readableId": "readableId",
92     "idempotencyId": "idempotencyId",
93     "createdAt": "2024-01-15T09:30:00Z",
94     "updatedAt": "2024-01-15T09:30:00Z",
95     "deletedAt": "2024-01-15T09:30:00Z",
96     "offboardedAt": "2024-01-15T09:30:00Z",
97     "countyName": "countyName",
98     "acquisitionDate": "2024-01-15T09:30:00Z"
99   },
100   "readableId": "readableId",
101   "workOrder": {
102     "status": "OPEN",
103     "priority": "LOW",
104     "hasPetAlert": true,
105     "completedAt": "2024-01-15T09:30:00Z",
106     "requestorPhone": "requestorPhone",
107     "requestorEmail": "requestorEmail",
108     "requestedStartDateFrom": "requestedStartDateFrom",
109     "requestedStartDateTo": "requestedStartDateTo",
110     "requestedStartTimeFrom": "requestedStartTimeFrom",
111     "requestedStartTimeTo": "requestedStartTimeTo",
112     "dueDate": "dueDate",
113     "description": "description",
114     "serviceNotes": "serviceNotes",
115     "vendorNotes": "vendorNotes",
116     "entryNotes": "entryNotes",
117     "entryPreference": "24_HOUR_NOTICE",
118     "isDoorCodeActive": true,
119     "isAlarmActive": true,
120     "doorCode": "doorCode",
121     "alarmCode": "alarmCode",
122     "holdReason": "holdReason",
123     "otherLocationDetail": "otherLocationDetail",
124     "attachmentIds": "attachmentIds",
125     "technicianNotes": "technicianNotes",
126     "previouslyReported": true,
127     "id": "id",
128     "readableId": "readableId",
129     "idempotencyId": "idempotencyId",
130     "createdAt": "createdAt",
131     "updatedAt": "2024-01-15T09:30:00Z",
132     "deletedAt": "2024-01-15T09:30:00Z",
133     "assignedUserId": "assignedUserId",
134     "householdId": "householdId",
135     "customerId": "customerId",
136     "unitId": "unitId",
137     "maintenanceIssueId": "maintenanceIssueId",
138     "maintenanceLocationId": "maintenanceLocationId",
139     "propertyId": "propertyId",
140     "organizationId": "organizationId",
141     "totalCostOfMaterialsUsed": 1.1,
142     "totalAmountOwedByResident": 1.1,
143     "totalAmountOwedByProperty": 1.1,
144     "hourlyServiceRate": 1.1,
145     "totalLaborCost": 1.1
146   }
147 }

List all work orders documents

Path parameters

workOrderIdstringRequired

The id of the work order

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0

the page number when used with pagination, defaults to 0

limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of attachments

createdAtdatetime

namestring

organizationIdstringformat: "uuid"

propertyIdstringformat: "uuid"

typeenum

updatedAtdatetime

urlstring

workOrderIdstringformat: "uuid"

customerobjectOptional

customerIdstringOptionalformat: "uuid"

deletedAtdatetimeOptional

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

notesstringOptional

organizationanyOptional

propertyobjectOptional

readableIdstringOptional

workOrderobjectOptional