Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Fields.list

Returns all defined Fields

Input

type: object properties: parameters: type: object properties: include-deleted: type: boolean description: if enabled, deleted Fields are returned as well first: type: integer format: int32 description: >- Number of entities to return from beginning of the result set. Max: 100. Default: 30 last: type: integer format: int32 description: >- Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. before: type: string description: Cursor until which to take entities to result set. after: type: string description: Cursor after which to start taking entities to result set. expand: type: string description: >- Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. order-by: type: string description: >- Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. filter: type: object description: >- Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. filter-op: type: object description: >- Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between]. load-only: type: string description: >- Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. title: Parameters

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: required: - is_delete_protected - has_draft - id - entity_name - name - type_id - data_set - is_available_for_webresource - source_field_id - source_type_id - use_in_interface_preview - translated_name - field_permissions - name_translations - name_translated - primitive_type properties: is_delete_protected: type: boolean example: false description: >- Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. modified: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Creation time. readOnly: true entity_name: type: string example: string description: >- Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...) readOnly: true api_name: type: string example: string description: Immutable and generated name. This name is used for integrations. name: type: string example: string description: User friendly name for field. use_lang: type: integer format: int32 example: 1 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. column_name: type: string example: string description: Simple text input field. column_source: type: integer format: int32 example: 1 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. readOnly: true relation_id: type: string example: string description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. relation_with_entity_id: type: string example: string description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. shared_with_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. system_type: type: integer format: int32 example: 1 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. readOnly: true type_id: type: string example: string description: >- Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url composite_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Optional custom data set id can be set. parent_data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. calc_formula: type: string example: string description: Calculated formula used for fields which supports calculation. default_value: type: string example: string description: A default value for field. sequence_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. system_required: type: boolean example: false description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. readOnly: true is_published: type: boolean example: false description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. readOnly: true system_readonly: type: boolean example: false description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. readOnly: true use_in_global_search: type: boolean example: false description: If this field is allowed in global search. settings: type: object description: Field containing json. is_unique: type: boolean example: false description: >- If true, then there will be an API validation if value of entity is unique. readOnly: true data_set: type: string format: uri description: >- Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties. sequence_pattern: type: string example: string description: A sequence pattern used for sequence type of field. is_available_for_webresource: type: boolean example: false description: '' lookup: type: object description: Lookup field definition. rollup: type: object description: Rollup field definition. options: type: object description: '' source_field_id: type: string example: string description: '' source_type_id: type: string example: string description: '' use_in_interface_preview: type: boolean example: false description: '' translated_name: type: string example: string description: '' field_permissions: type: string format: uri description: >- Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties. name_translations: type: string format: binary example: blob description: '' name_translated: type: string example: string description: '' primitive_type: type: string example: string description: '' type: object page_info: type: object description: >- Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: >- If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: >- If result set has next page (if yes, use end_cursor value in after parameter to load it).