Create Attachment

POST

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

POST

/v1/workOrders/:workOrderId/attachments

1 curl -X POST https://api.fortresstech.io/v1/workOrders/workOrderId/attachments \
2      -H "Content-Type: multipart/form-data" \
3      -F file=@<file1> \
4      -F idempotencyId="idempotencyId" \
5      -F type="ISSUE" \
6      -F createdById="createdById"

Try it

200Successful

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     "organizationId": "organizationId",
88     "id": "id",
89     "readableId": "readableId",
90     "idempotencyId": "idempotencyId",
91     "createdAt": "2024-01-15T09:30:00Z",
92     "updatedAt": "2024-01-15T09:30:00Z",
93     "deletedAt": "2024-01-15T09:30:00Z",
94     "offboardedAt": "2024-01-15T09:30:00Z",
95     "countyName": "countyName",
96     "acquisitionDate": "2024-01-15T09:30:00Z"
97   },
98   "readableId": "readableId",
99   "workOrder": {
100     "status": "OPEN",
101     "priority": "LOW",
102     "hasPetAlert": true,
103     "completedAt": "2024-01-15T09:30:00Z",
104     "requestorPhone": "requestorPhone",
105     "requestorEmail": "requestorEmail",
106     "requestedStartDateFrom": "requestedStartDateFrom",
107     "requestedStartDateTo": "requestedStartDateTo",
108     "requestedStartTimeFrom": "requestedStartTimeFrom",
109     "requestedStartTimeTo": "requestedStartTimeTo",
110     "dueDate": "dueDate",
111     "description": "description",
112     "serviceNotes": "serviceNotes",
113     "vendorNotes": "vendorNotes",
114     "entryNotes": "entryNotes",
115     "entryPreference": "24_HOUR_NOTICE",
116     "isDoorCodeActive": true,
117     "isAlarmActive": true,
118     "doorCode": "doorCode",
119     "alarmCode": "alarmCode",
120     "holdReason": "holdReason",
121     "otherLocationDetail": "otherLocationDetail",
122     "attachmentIds": "attachmentIds",
123     "technicianNotes": "technicianNotes",
124     "previouslyReported": true,
125     "id": "id",
126     "readableId": "readableId",
127     "idempotencyId": "idempotencyId",
128     "createdAt": "createdAt",
129     "updatedAt": "2024-01-15T09:30:00Z",
130     "deletedAt": "2024-01-15T09:30:00Z",
131     "assignedUserId": "assignedUserId",
132     "householdId": "householdId",
133     "customerId": "customerId",
134     "unitId": "unitId",
135     "maintenanceIssueId": "maintenanceIssueId",
136     "maintenanceLocationId": "maintenanceLocationId",
137     "propertyId": "propertyId",
138     "organizationId": "organizationId",
139     "totalCostOfMaterialsUsed": 1.1,
140     "totalAmountOwedByResident": 1.1,
141     "totalAmountOwedByProperty": 1.1,
142     "hourlyServiceRate": 1.1,
143     "totalLaborCost": 1.1
144   }
145 }

Uploads a file to a work order. The file can be an image, PDF, or other document types. The maximum file size is 5MB.

Path parameters

workOrderIdstringRequired

The id of the work order

Request

This endpoint expects a multipart form containing a file.

filefileRequired

idempotencyIdstringRequired

typeenumRequired

Type of attachment

Allowed values:

createdByIdstringRequiredformat: "uuid"

The ID of the user who created the attachment

namestringOptional

The name of the file, if not provided, the name will be taken from the file.

Response

The created attachment

createdAtdatetime

namestring

organizationIdstringformat: "uuid"

propertyIdstringformat: "uuid"

typeenum

Allowed values:

updatedAtdatetime

urlstring

workOrderIdstringformat: "uuid"

customerobject or null

customerIdstring or nullformat: "uuid"

deletedAtdatetime or null

householdobject or null

householdIdstring or nullformat: "uuid"

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

notesstring or null

organizationany or null

propertyobject or null

readableIdstring or null

workOrderobject or null