Jump to

• Request
• Response

Get a step task

get

/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}

Request

Path Parameters

• WorkerJourneyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• allStepTasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the All Step Tasks resource and used to uniquely identify an instance of All Step Tasks. The client should not generate the hash key value. Instead, the client should query on the All Step Tasks collection resource in order to navigate to a specific instance of All Step Tasks to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : workerJourneys-allStepTasks-item-response

Type: object

Show Source

• AccessActivity: string
  Title: Access Task

  Read Only: true

  Setting that determines if the signed in user can access the task.
• AccessAttachments: string
  Title: Access Attachments

  Read Only: true

  Setting that determines if the signed in user can access the task attachments.
• AccessComments: string
  Title: Access Comments

  Read Only: true

  Setting that determines if the signed in user can access the task comments.
• AccessContact: string
  Title: Access Contact Information

  Read Only: true

  Setting that determines if the signed in user can access the task contact details.
• AccessNotes: string
  Title: Access Notes

  Read Only: true

  Setting that determines if the signed in user can access the task notes.
• ActionComplete: string
  Title: Mark as Complete

  Read Only: true

  Setting that determines if the signed in user can mark the task as complete.
• ActionEdit: string
  Title: Edit

  Read Only: true

  Setting that determines if the signed in user can edit the task.
• ActionEditDueDate: string
  Title: Edit Due Date

  Read Only: true

  Setting that determines if the signed in user can edit the due date of the task.
• ActionReassign: string
  Title: Reassign

  Read Only: true

  Setting that determines if the signed in user can reassign the task.
• ActionReject: string
  Title: Mark as Not Applicable

  Read Only: true

  Setting that determines if the signed in user can mark the task as not applicable.
• ActionRemove: string
  Title: Remove

  Read Only: true

  Setting that determines if the signed in user can remove the task.
• ActionReopen: string
  Title: Reopen

  Read Only: true

  Setting that determines if the signed in user can reopen a completed task.
• ActionSendReminder: string
  Title: Send Reminder

  Read Only: true

  Setting that determines if the signed in user can send a reminder for a task.
• ActionURL: string
  Title: URL

  Read Only: true

  Maximum Length: 1000

  URL associated with the task that's entered on the setup screen.
• ActualEndDate: string (date)
  Title: Actual End Date

  Read Only: true

  End date of the task.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Read Only: true

  Date on which the task was opened.
• AllowAttachmentFlag: boolean
  Title: Allow Attachments

  Read Only: true

  Indicates whether attachments are enabled for a task. Valid values are Yes and No. The default value is No.
• AllowCommentFlag: boolean
  Title: Allow Comments

  Read Only: true

  Indicates whether comments are enabled for a task. Valid values are Yes and No. The default value is No.
• AllowNoteTitleFlag: boolean
  Title: Enable Notes Title

  Read Only: true

  Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No.
• ApplicationTaskName: string
  Title: Application Task

  Read Only: true

  Display name of the application task.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 4000

  Comments for the task.
• CompletedByDisplayName: string
  Title: Completed by Person Name

  Read Only: true

  Name of the person who completed the task.
• CompletedByPersonId: integer
  Title: Completed by Person ID

  Read Only: true

  Person identifier of the person who completed the task.
• CompletionDate: string (date)
  Title: Completed On

  Read Only: true

  Date on which the task was completed.
• ConfigurableFormContext: string
  Title: Configurable Form

  Read Only: true

  Maximum Length: 80

  Descriptive flexfield context code for configurable form task type.
• DeferredStartDate: string (date)
  Title: Deferred Task Start Date

  Read Only: true

  Start date for the deferred task.
• DependentTaskId: integer (int64)
  Title: Preceding Task ID

  Read Only: true

  Primary key or unique identifier of the dependent task.
• DependentTaskName: string
  Title: Preceding Task

  Read Only: true

  Maximum Length: 240

  Name of the dependent task.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 4000

  Description of the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the journey task.
• Notes: string (byte)
  Title: Notes

  Read Only: true

  Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
• NoteTitle: string
  Title: Notes Title

  Read Only: true

  Maximum Length: 150

  Title of the Notes section in the task.
• OpenInSamePageFlag: boolean
  Read Only: true

  Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.
• OwnerName: string
  Title: Owner Name

  Read Only: true

  Person display name of task owner in case of single owner. Else, returns responsibility type name.
• OwnerPersonId: integer (int64)
  Title: Owner Person ID

  Read Only: true

  Identifier of the task owner. Applicable only in case of a single task owner.
• OwnerType: string
  Title: Owner Type

  Read Only: true

  Maximum Length: 30

  Task owner type.
• OwnerTypeMeaning: string
  Title: Owner

  Read Only: true

  Task owner type meaning.
• ParentWorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Unique identifier of the parent enterprise onboarding checklist.
• PerformerName: string
  Title: Performer Name

  Read Only: true

  Person display name of task performer in case of single performer. Else, returns responsibility type name.
• PerformerPersonId: integer (int64)
  Title: Performer Person ID

  Read Only: true

  Person identifier of the task performer. Applicable only in case of a single task performer.
• PerformerType: string
  Title: Performer Type

  Read Only: true

  Task performer type.
• PerformerTypeMeaning: string
  Title: Performer

  Read Only: true

  Task performer type meaning.
• ReportPath: string
  Title: Report Path

  Read Only: true

  Maximum Length: 1000

  Path to the report in BI Catalog.
• RequiredFlag: boolean
  Title: Required

  Read Only: true

  Maximum Length: 30

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
• Sequence: integer (int32)
  Title: Sequence

  Read Only: true

  Task display ordering sequence. Default is 1.
• SignAddress: string
  Title: IP Address of Signature

  Read Only: true

  Maximum Length: 120

  Internet protocol address where the electronic signature was provided.
• SignDate: string (date)
  Title: Date of Signature

  Read Only: true

  Date on which the electronic signature was provided for an electronic signature task.
• SignerEmail: string
  Title: Email of Signer

  Read Only: true

  Maximum Length: 400

  Email address of the signer for an electronic signature task.
• SignerName: string
  Title: Name of Signer

  Read Only: true

  Maximum Length: 120

  Name of the signer for an electronic signature task.
• StageName: string
  Read Only: true

  Name of the phase in a journey with multiple phases.
• StageSequence: integer
  Read Only: true

  Sequence of the phase in a journey with multiple phases.
• Status: string
  Title: Status Code

  Read Only: true

  Maximum Length: 60

  Code for the task status.
• StatusCategory: string
  Title: Status Category

  Read Only: true

  Category of the status.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the task.
• SubType: string
  Title: Subtype Code

  Read Only: true

  Maximum Length: 30

  Task action subtype code. Available only for I 9 and Electronic Signature task types.
• SubTypeMeaning: string
  Title: Subtype

  Read Only: true

  Task action subtype. Available only for I 9 and Electronic Signature task types.
• TargetEndDate: string (date)
  Title: Target End Date

  Read Only: true

  Due date of the task.
• TargetStartDate: string (date)
  Title: Target Start Date

  Read Only: true

  Expected initiation date of the task.
• Type: string
  Title: Type Code

  Read Only: true

  Maximum Length: 80

  Code for the task action type.
• TypeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  Meaning of the task type.
• WorkerJourneyTaskId: integer (int64)
  Title: Journey Task ID

  Read Only: true

  Unique identifier of the journey task.

{
    "type":"object",
    "properties":{
        "DeferredStartDate":{
            "title":"Deferred Task Start Date",
            "type":"string",
            "description":"Start date for the deferred task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignAddress":{
            "title":"IP Address of Signature",
            "maxLength":120,
            "type":"string",
            "description":"Internet protocol address where the electronic signature was provided.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionComplete":{
            "title":"Mark as Complete",
            "type":"string",
            "description":"Setting that determines if the signed in user can mark the task as complete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which the task was opened.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AccessComments":{
            "title":"Access Comments",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":30,
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "title":"Allow Attachments",
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerTypeMeaning":{
            "title":"Owner",
            "type":"string",
            "description":"Task owner type meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerRespTypeMeaning",
                    "OwnerLookupMeaning"
                ]
            }
        },
        "PerformerTypeMeaning":{
            "title":"Performer",
            "type":"string",
            "description":"Task performer type meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RespPerformerAvailability",
                    "ResponsibilityTypeMeaning",
                    "PerformerLookupMeaning",
                    "DefaultRespTypeMeaning"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SignerEmail":{
            "title":"Email of Signer",
            "maxLength":400,
            "type":"string",
            "description":"Email address of the signer for an electronic signature task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTitle":{
            "title":"Notes Title",
            "maxLength":150,
            "type":"string",
            "description":"Title of the Notes section in the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status Code",
            "maxLength":60,
            "type":"string",
            "description":"Code for the task status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DependentTaskId":{
            "title":"Preceding Task ID",
            "type":"integer",
            "description":"Primary key or unique identifier of the dependent task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubType":{
            "title":"Subtype Code",
            "maxLength":30,
            "type":"string",
            "description":"Task action subtype code. Available only for I 9 and Electronic Signature task types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DependentTaskName":{
            "title":"Preceding Task",
            "maxLength":240,
            "type":"string",
            "description":"Name of the dependent task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetStartDate":{
            "title":"Target Start Date",
            "type":"string",
            "description":"Expected initiation date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetEndDate":{
            "title":"Target End Date",
            "type":"string",
            "description":"Due date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerPersonId":{
            "title":"Performer Person ID",
            "type":"integer",
            "description":"Person identifier of the task performer. Applicable only in case of a single task performer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ActionEdit":{
            "title":"Edit",
            "type":"string",
            "description":"Setting that determines if the signed in user can edit the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionReject":{
            "title":"Mark as Not Applicable",
            "type":"string",
            "description":"Setting that determines if the signed in user can mark the task as not applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedByPersonId":{
            "title":"Completed by Person ID",
            "type":"integer",
            "description":"Person identifier of the person who completed the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerName":{
            "title":"Performer Name",
            "type":"string",
            "description":"Person display name of task performer in case of single performer. Else, returns responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PerformerPersonId",
                    "PerformerType",
                    "PerformerDisplayName",
                    "PerformerTypeMeaning"
                ]
            }
        },
        "OpenInSamePageFlag":{
            "type":"boolean",
            "description":"Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentWorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Unique identifier of the parent enterprise onboarding checklist.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "type":"string",
            "description":"Person display name of task owner in case of single owner. Else, returns responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerPersonId",
                    "OwnerType",
                    "OwnerDisplayName",
                    "OwnerTypeMeaning"
                ]
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageSequence":{
            "type":"integer",
            "description":"Sequence of the phase in a journey with multiple phases.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionSendReminder":{
            "title":"Send Reminder",
            "type":"string",
            "description":"Setting that determines if the signed in user can send a reminder for a task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApplicationTaskName":{
            "title":"Application Task",
            "type":"string",
            "description":"Display name of the application task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignDate":{
            "title":"Date of Signature",
            "type":"string",
            "description":"Date on which the electronic signature was provided for an electronic signature task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessContact":{
            "title":"Access Contact Information",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task contact details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkerJourneyTaskId":{
            "title":"Journey Task ID",
            "type":"integer",
            "description":"Unique identifier of the journey task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AllowNoteTitleFlag":{
            "title":"Enable Notes Title",
            "type":"boolean",
            "description":"Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowCommentFlag":{
            "title":"Allow Comments",
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCategory":{
            "title":"Status Category",
            "type":"string",
            "description":"Category of the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubTypeMeaning":{
            "title":"Subtype",
            "type":"string",
            "description":"Task action subtype. Available only for I 9 and Electronic Signature task types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EsignTypeMeaning",
                    "I9TypeMeaning",
                    "ProcessAutomationTypeMeaning",
                    "VideoTypeMeaning",
                    "LearnTypeMeaning"
                ]
            }
        },
        "ActionReassign":{
            "title":"Reassign",
            "type":"string",
            "description":"Setting that determines if the signed in user can reassign the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionReopen":{
            "title":"Reopen",
            "type":"string",
            "description":"Setting that determines if the signed in user can reopen a completed task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignerName":{
            "title":"Name of Signer",
            "maxLength":120,
            "type":"string",
            "description":"Name of the signer for an electronic signature task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConfigurableFormContext":{
            "title":"Configurable Form",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context code for configurable form task type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "title":"Completed On",
            "type":"string",
            "description":"Date on which the task was completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionEditDueDate":{
            "title":"Edit Due Date",
            "type":"string",
            "description":"Setting that determines if the signed in user can edit the due date of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "type":"string",
            "description":"Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedByDisplayName":{
            "title":"Completed by Person Name",
            "type":"string",
            "description":"Name of the person who completed the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionRemove":{
            "title":"Remove",
            "type":"string",
            "description":"Setting that determines if the signed in user can remove the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActualEndDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"End date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageName":{
            "type":"string",
            "description":"Name of the phase in a journey with multiple phases.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comments for the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessAttachments":{
            "title":"Access Attachments",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task attachments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerType":{
            "title":"Performer Type",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TypeMeaning":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the task type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Type Code",
            "maxLength":80,
            "type":"string",
            "description":"Code for the task action type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AccessNotes":{
            "title":"Access Notes",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task notes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReportPath":{
            "title":"Report Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path to the report in BI Catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessActivity":{
            "title":"Access Task",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":1000,
            "type":"string",
            "description":"URL associated with the task that's entered on the setup screen.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerPersonId":{
            "title":"Owner Person ID",
            "type":"integer",
            "description":"Identifier of the task owner. Applicable only in case of a single task owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top