SOAP API method PdfExport_target
Description
The target of the export. This method returns false if the original target no longer exists.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object PdfExport. The method only applies to the pdfexport with this id. |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
view | Structure of type 'view' | |
database | Structure of type 'database' | |
collection | Structure of type 'collection' | |
miniview | Structure of type 'miniview' | |
profile | Structure of type 'profile' | |
subprofile | Structure of type 'subprofile' |
Structure 'login'
Name | Type | Description |
---|---|---|
username | string | The username of the login attempt |
account | string | The account name of the login attempt |
password | string | The password for the login attempt |
Structure 'view'
Name | Type | Description |
---|---|---|
id | int | The ID of the view. |
name | string | The name of the view. |
description | string | The description of the view. |
archived | boolean | The view is archived. |
buildstatus | string | The status of the rebuild |
countprofiles | int | The number of profiles. |
lastbuilt | timestamp | When was the item rebuilt for the last time? |
Structure 'database'
Name | Type | Description |
---|---|---|
id | int | The ID of the database. |
name | string | The name of the database. |
description | string | The description of the database. |
archived | boolean | The database is archived. |
created | timestamp | The date and time when the account was created. |
unsubscribebehavior | string | Get the unsubscribe behavior of the database. Possible values are 'nothing', 'remove' or 'update'. |
countprofiles | int | The number of profiles. |
lastbuilt | timestamp | When was the item rebuilt for the last time? |
Structure 'collection'
Name | Type | Description |
---|---|---|
id | int | The ID of the collection. |
name | string | The name of the collection. |
weight | int | The weight of the collection. |
created | string | The date and time when the account was created. |
unsubscribebehavior | string | Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'. |
countsubprofiles | int | The number of subprofiles. |
Structure 'miniview'
Name | Type | Description |
---|---|---|
id | int | The ID of the miniview. |
name | string | The name of the miniview. |
description | string | The description of the miniview. |
buildstatus | string | The status of the rebuild |
countsubprofiles | int | The number of subprofiles. |
Structure 'profile'
Name | Type | Description |
---|---|---|
id | int | The ID of the profile. |
code | string | The code of the profile. |
extra | string | The extra data of the profile. |
created | timestamp | The timestamp when the profile was created. |
modified | timestamp | The timestamp when the profile was last modified. |
lastexport | timestamp | The last timestamp when the profile was exported. |
fields | Map | Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true |
interests | Map | Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true |
Structure 'subprofile'
Name | Type | Description |
---|---|---|
id | int | The ID of the subprofile. |
code | string | The code of the subprofile. |
created | timestamp | The timestamp when the subprofile was created. |
modified | timestamp | The timestamp when the subprofile was last modified. |
lastexport | timestamp | The last timestamp when the subprofile was exported. |
fields | Map | Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true |