PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dataanalysis_datacollectors

Retrieves a dataanalysis_datacollectors resource.

Authorizations:

JWT

path Parameters

id

required

string

dataanalysis_datacollectors identifier

Responses

Response samples

200

Content type

application/ld+json

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

Replaces the dataanalysis_datacollectors resource.

Authorizations:

JWT

path Parameters

id

required

string

dataanalysis_datacollectors identifier

Request Body schema:
application/ld+json
required

The updated 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
deletedAt	string or null <date-time>
slug required	string DB Identifier
customData	Array of strings or null
disabledAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/ld+json

{"title": "string",
"description": "string",
"directives": "string",
"serializationGroups": "string",
"role": "string",
"type": 0,
"notes": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"slug": "string",
"customData": ["string"
],
"disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/ld+json

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

Removes the dataanalysis_datacollectors resource.

Authorizations:

JWT

path Parameters

id

required

string

dataanalysis_datacollectors identifier

PHPR API (3.7.0)

dataanalysis_datacollectors

Retrieves a dataanalysis_datacollectors resource.

Authorizations:

path Parameters

Responses

Response samples

Replaces the dataanalysis_datacollectors resource.

Authorizations:

path Parameters

Request Body schema: application/ld+jsonapplication/hal+jsonapplication/vnd.api+jsonapplication/jsontext/htmltext/csvapplication/ld+jsonrequired

Responses

Request samples

Response samples

Removes the dataanalysis_datacollectors resource.

Authorizations:

path Parameters

Responses

Request Body schema:
application/ld+json
required