API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

projects

Retrieves the collection of projects resources.

Retrieves the collection of projects resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[bonis]
boolean
exists[invoices]
boolean
exists[bills]
boolean
exists[tasks]
boolean
exists[projectSectors]
boolean
exists[followups]
boolean
exists[rents]
boolean
exists[allowances]
boolean
exists[chargedBillLines]
boolean
exists[chargedRents]
boolean
exists[chargedTimesheets]
boolean
exists[chargedAllowances]
boolean
exists[schedules]
boolean
exists[code]
boolean
exists[deadline]
boolean
exists[dateEnd]
boolean
exists[reviewDate]
boolean
exists[notes]
boolean
exists[projectNotes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[code]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[estimatedAdmin]
string
Default: "asc"
Enum: "asc" "desc"
order[materialPrice]
string
Default: "asc"
Enum: "asc" "desc"
order[value]
string
Default: "asc"
Enum: "asc" "desc"
order[dateRequest]
string
Default: "asc"
Enum: "asc" "desc"
order[dateStart]
string
Default: "asc"
Enum: "asc" "desc"
order[deadline]
string
Default: "asc"
Enum: "asc" "desc"
order[dateEnd]
string
Default: "asc"
Enum: "asc" "desc"
order[reviewDate]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
client
string
client[]
Array of strings
code_end_with
string
code_partial
string
code_start_with
string
code
string
code[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateEnd[before]
string
dateEnd[strictly_before]
string
dateEnd[after]
string
dateEnd[strictly_after]
string
dateRequest[before]
string
dateRequest[strictly_before]
string
dateRequest[after]
string
dateRequest[strictly_after]
string
dateStart[before]
string
dateStart[strictly_before]
string
dateStart[after]
string
dateStart[strictly_after]
string
deadline[before]
string
deadline[strictly_before]
string
deadline[after]
string
deadline[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
estimatedAdmin_range[between]
string
estimatedAdmin_range[gt]
string
estimatedAdmin_range[gte]
string
estimatedAdmin_range[lt]
string
estimatedAdmin_range[lte]
string
estimatedAdmin
string
estimatedAdmin[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
inchargeEmployee
string
inchargeEmployee[]
Array of strings
materialPrice_range[between]
string
materialPrice_range[gt]
string
materialPrice_range[gte]
string
materialPrice_range[lt]
string
materialPrice_range[lte]
string
materialPrice
string
materialPrice[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
reviewDate[before]
string
reviewDate[strictly_before]
string
reviewDate[after]
string
reviewDate[strictly_after]
string
salesman
string
salesman[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
value_range[between]
string
value_range[gt]
string
value_range[gte]
string
value_range[lt]
string
value_range[lte]
string
value
string
value[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a projects resource.

Creates a projects resource.

Authorizations:
JWT
Request Body schema:
required

The new projects resource

code
string or null
required
object (person_clients.jsonld-add_post)

Clients.

required
object (person_employees.jsonld-add_post)

Employes.

required
object (person_employees.jsonld-add_post)

Employes.

estimatedAdmin
required
string
materialPrice
required
string
value
required
string
required
object (project_priorities.jsonld-add_post)

Priority.

required
object (project_statuses.jsonld-add_post)

Status.

required
object (project_types.jsonld-add_post)

Type.

dateRequest
required
string <date-time>
dateStart
required
string <date-time>
deadline
string or null <date-time>
dateEnd
string or null <date-time>
reviewDate
string or null <date-time>
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings
title
string or null
projectsWebsite
string or null

Get projectsWebsite.

Responses

Request samples

Content type
{
  • "code": "string",
  • "client": {
    },
  • "salesman": {
    },
  • "inchargeEmployee": {
    },
  • "estimatedAdmin": "string",
  • "materialPrice": "string",
  • "value": "string",
  • "priority": {
    },
  • "status": {
    },
  • "type": {
    },
  • "dateRequest": "2019-08-24T14:15:22Z",
  • "dateStart": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "reviewDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ],
  • "title": "string",
  • "projectsWebsite": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "chargedBillLines": [
    ],
  • "chargedRents": [
    ],
  • "chargedTimesheets": [
    ],
  • "chargedAllowances": [
    ],
  • "code": "string",
  • "client": {
    },
  • "salesman": {
    },
  • "inchargeEmployee": {
    },
  • "estimatedAdmin": "string",
  • "materialPrice": "string",
  • "value": "string",
  • "priority": {
    },
  • "status": {
    },
  • "type": {
    },
  • "dateRequest": "2019-08-24T14:15:22Z",
  • "dateStart": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "reviewDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "owningCorporation": {
    },
  • "shortcode": "W",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "projectsWebsite": "string",
  • "toString": "string",
  • "projectSectorsListing": "string",
  • "tasksListing": "string",
  • "invoicesListing": "string",
  • "projectRemainingTime": "string",
  • "bonisListing": "string",
  • "billsListing": "string",
  • "followupsListing": "string",
  • "rentsListing": "string",
  • "allowancesListing": "string",
  • "customPropertiesListing": "string",
  • "projectNotesListing": "string",
  • "translationsListing": "string",
  • "description": "string",
  • "translationTitlePropertyName": "string",
  • "translationDescriptionPropertyName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}