API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

projects

Creates a projects resource.

Creates a projects resource.

Authorizations:
JWT
path Parameters
id
required
string

projects identifier

Request Body schema:
required

The new projects resource

bonis
Array of strings <iri-reference> [ items <iri-reference > ]
invoices
Array of strings <iri-reference> [ items <iri-reference > ]
bills
Array of strings <iri-reference> [ items <iri-reference > ]
tasks
Array of strings <iri-reference> [ items <iri-reference > ]
projectSectors
Array of strings <iri-reference> [ items <iri-reference > ]
followups
Array of strings <iri-reference> [ items <iri-reference > ]
rents
Array of strings <iri-reference> [ items <iri-reference > ]
allowances
Array of strings <iri-reference> [ items <iri-reference > ]
chargedBillLines
Array of strings <iri-reference> [ items <iri-reference > ]

Get chargedBillLines.

chargedRents
Array of strings <iri-reference> [ items <iri-reference > ]

Get chargedRentsines.

chargedTimesheets
Array of strings <iri-reference> [ items <iri-reference > ]

Get chargedTimesheets.

chargedAllowances
Array of strings <iri-reference> [ items <iri-reference > ]

Get chargedAllowances.

schedules
Array of strings <iri-reference> [ items <iri-reference > ]
code
string or null
client
required
string <iri-reference>
salesman
required
string <iri-reference>
inchargeEmployee
required
string <iri-reference>
estimatedAdmin
required
string
materialPrice
required
string
value
required
string
priority
required
string <iri-reference>
status
required
string <iri-reference>
type
required
string <iri-reference>
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
projectNotes
Array of strings <iri-reference> [ items <iri-reference > ]
owningCorporation
string <iri-reference>
object
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
apiTranslations
Array of strings
title
string or null
descriptionInternal
any
currentLocale
string or null

currentLocale is a non persisted field configured during postLoad event

defaultLocale
string
Default: "en"
projectsWebsite
string or null

Get projectsWebsite.

description
string or null
currentTitle
string or null
currentDescription
string or null
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{}

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
}