Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

TaskRecurrences.list

Returns all defined TaskRecurrences

Input

type: object properties: parameters: type: object properties: include-deleted: type: boolean description: if enabled, deleted TaskRecurrences 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 - id - task - start_date - task_id 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 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: Specifies if the entity is considered deleted. readOnly: true 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 task: type: string format: uri description: >- Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. day: type: integer description: >- Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31 example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 day_of_week: type: string example: 1 enum: - 1 - 2 - 4 - 8 - 16 - 32 - 64 description: >- Bit Flag field, with limited combination of integer values. Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute. end_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: >- Date information. The last date when no more other items should be created. month: type: integer description: >- Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12 example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 occur_every: type: integer format: int32 example: 1 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum. occurrences_count: type: integer format: int32 example: 1 description: >- Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied. start_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: >- Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date. task_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. type: type: integer description: >- Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears example: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 week: type: integer description: >- Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4 example: -1 enum: - -1 - 1 - 2 - 3 - 4 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. 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).