API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dataanalysis_datacollectors

Creates a dataanalysis_datacollectors resource.

Creates a dataanalysis_datacollectors resource.

Authorizations:
JWT
path Parameters
id
required
string

dataanalysis_datacollectors identifier

Request Body schema:
required

The new dataanalysis_datacollectors resource

title
required
string
description
string or null
directives
required
string
serializationGroups
string or null
role
required
string
type
integer
notes
string or null
filters
Array of strings <iri-reference> [ items <iri-reference > ]
dataCollectorParameters
Array of strings <iri-reference> [ items <iri-reference > ]
dataCollectorResults
Array of strings <iri-reference> [ items <iri-reference > ]
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
typeString
string
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "directives": "string",
  • "serializationGroups": "string",
  • "role": "string",
  • "type": 0,
  • "notes": "string",
  • "filters": [],
  • "dataCollectorParameters": [],
  • "dataCollectorResults": [],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "typeString": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "description": "string",
  • "directives": "string",
  • "serializationGroups": "string",
  • "role": "string",
  • "type": 0,
  • "notes": "string",
  • "dataCollectorParameters": [
    ],
  • "dataCollectorResults": [
    ],
  • "shortcode": "DC",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "directivesFormatted": "string",
  • "parameterOperatorsArray": [
    ],
  • "serializationGroupsArray": [
    ],
  • "parameterDefaultValuesArray": [
    ],
  • "parameterTypesArray": [
    ],
  • "resultNamesArray": [
    ],
  • "filterNamesArray": [
    ],
  • "dataProcessorsListing": "string",
  • "typeString": "string",
  • "filtersListing": "string",
  • "sortedFilters": [
    ],
  • "dataCollectorParametersListing": "string",
  • "dataCollectorResultsListing": "string",
  • "dataProcessorCollectorsListing": null,
  • "requestParamsListing": [
    ],
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}