Jump to

• Request
• Response
• Examples

Update a task

patch

/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/Tasks/{TaskId}

Request

Path Parameters

• TaskId(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=
• WorkPlanTemplateId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Allocation: number
  Title: Allocation Percentage

  The percentage of resource's hours allocated to the task for the task duration.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable.
• ChargeableFlag: boolean
  Title: Chargeable

  Maximum Length: 1

  Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.
• Description: string
  Title: Task Description

  Maximum Length: 2000

  Text description of the task.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  For internal use. The order in which the task is displayed.
• Duration: number
  Title: Planned Duration

  The planned duration of the task.
• Effort: number
  Title: Planned Effort in Hours

  The estimated effort, in hours, required to complete a task.
• ExpenseAmount: number
  Title: Planned Expense Amount

  Default Value: 0

  The planned expense amount for the task.
• GateApprovers: array Gate Approvers
  Title: Gate Approvers

  The Gate Approvers resource is used to view gate approver details.
• LaborBillAmount: number
  Title: Planned Labor Bill Amount

  The planned bill amount for all the labor resources associated with the task.
• LaborCost: number
  Title: Planned Labor Cost

  The planned cost amount for all the labor resources associated with the task.
• LeafIndicator: string
  Title: Leaf Indicator

  Maximum Length: 1

  Default Value: Y

  Indicates whether the task is a lowest-level task.
• ManualScheduleFlag: boolean
  Title: Manual Schedule

  Maximum Length: 1

  Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process.
• MilestoneFlag: boolean
  Title: Milestone

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is a milestone.
• Name: string
  Title: Task Name

  Maximum Length: 255

  Name of the task.
• NumberAttr01: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr02: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr03: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr04: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr05: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr06: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr07: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr08: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr09: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr10: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• ParentTaskId: integer (int64)
  Title: Parent Task ID

  Identifier of the parent task of the task.
• PeerReferenceTaskId: integer
  Title: Peer Reference Task ID

  Unique identifier of the peer task.
• Priority: number
  Title: Priority

  Priority of the task for the assigned resource.
• ScheduleTypeCode: string
  Title: Task Schedule Type Code

  Maximum Length: 30

  Schedule type of the task. Valid values are fixed effort and fixed duration.
• TaskCode01Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode02Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode03Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode04Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode05Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode06Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode07Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode08Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode09Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode10Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode11Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode12Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode13Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode14Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode15Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode16Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode17Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode18Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode19Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode20Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode21Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode22Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode23Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode24Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode25Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode26Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode27Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode28Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode29Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode30Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode31Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode32Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode33Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode34Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode35Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode36Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode37Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode38Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode39Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode40Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskDFF: array TaskDFF
• TaskLevel: integer (int32)
  Title: Task Level

  Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  The number assigned to a task. It's used to uniquely identify a task.
• TextAttr01: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr02: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr03: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr04: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr05: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr06: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr07: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr08: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr09: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr10: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr11: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr12: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr13: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr14: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr15: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr16: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr17: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr18: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr19: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr20: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TotalCost: number
  Title: Total Cost

  The total cost of the task. It's the sum of expense and labor costs.
• WorkType: string
  Title: Work Type

  Maximum Length: 240

  Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date.
• WorkTypeId: integer (int64)
  Title: Work Type ID

  Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.

{
    "type":"object",
    "properties":{
        "NumberAttr04":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "NumberAttr05":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr10":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr02":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TaskCode19Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr11":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr03":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr12":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TaskCode17Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NumberAttr01":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TaskCode15Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Effort":{
            "title":"Planned Effort in Hours",
            "type":"number",
            "description":"The estimated effort, in hours, required to complete a task.",
            "nullable":true
        },
        "TaskCode36Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode38Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task.",
            "nullable":false
        },
        "TotalCost":{
            "title":"Total Cost",
            "type":"number",
            "description":"The total cost of the task. It's the sum of expense and labor costs.",
            "nullable":true
        },
        "ExpenseAmount":{
            "title":"Planned Expense Amount",
            "type":"number",
            "description":"The planned expense amount for the task.",
            "nullable":true,
            "default":0
        },
        "TaskCode30Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode32Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode34Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode13Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr06":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr07":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "GateApprovers":{
            "title":"Gate Approvers",
            "type":"array",
            "description":"The Gate Approvers resource is used to view gate approver details.",
            "items":{
                "$ref":"#/components/schemas/workPlanTemplates-Tasks-GateApprovers-item-patch-request"
            }
        },
        "TaskCode11Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr08":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr09":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr02":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "LaborBillAmount":{
            "title":"Planned Labor Bill Amount",
            "type":"number",
            "description":"The planned bill amount for all the labor resources associated with the task.",
            "nullable":true
        },
        "TextAttr03":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr04":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr05":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TaskCode09Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode07Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr01":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "ManualScheduleFlag":{
            "title":"Manual Schedule",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process.",
            "nullable":true
        },
        "TaskCode05Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Priority":{
            "title":"Priority",
            "type":"number",
            "description":"Priority of the task for the assigned resource.",
            "nullable":true
        },
        "TaskCode03Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workPlanTemplates-Tasks-TaskDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "TaskCode26Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeerReferenceTaskId":{
            "title":"Peer Reference Task ID",
            "type":"integer",
            "description":"Unique identifier of the peer task.",
            "nullable":true
        },
        "Duration":{
            "title":"Planned Duration",
            "type":"number",
            "description":"The planned duration of the task.",
            "nullable":true
        },
        "TaskCode28Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode20Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode22Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode24Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode01Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ParentTaskId":{
            "title":"Parent Task ID",
            "type":"integer",
            "description":"Identifier of the parent task of the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Task Description",
            "maxLength":2000,
            "type":"string",
            "description":"Text description of the task.",
            "nullable":true
        },
        "TaskCode18Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"For internal use. The order in which the task is displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode16Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode14Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ScheduleTypeCode":{
            "title":"Task Schedule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Schedule type of the task. Valid values are fixed effort and fixed duration.",
            "nullable":true
        },
        "TaskCode37Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode39Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeableFlag":{
            "title":"Chargeable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.",
            "nullable":true
        },
        "WorkTypeId":{
            "title":"Work Type ID",
            "type":"integer",
            "description":"Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode31Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Allocation":{
            "title":"Allocation Percentage",
            "type":"number",
            "description":"The percentage of resource's hours allocated to the task for the task duration.",
            "nullable":true
        },
        "TaskCode33Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode35Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode12Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LeafIndicator":{
            "title":"Leaf Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the task is a lowest-level task.",
            "nullable":true,
            "default":"Y"
        },
        "TaskCode10Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr20":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TaskCode08Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode06Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkType":{
            "title":"Work Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MilestoneFlag":{
            "title":"Milestone",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is a milestone.",
            "nullable":true,
            "default":false
        },
        "TaskCode04Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NumberAttr10":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable.",
            "nullable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number assigned to a task. It's used to uniquely identify a task.",
            "nullable":false
        },
        "TaskCode25Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode27Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LaborCost":{
            "title":"Planned Labor Cost",
            "type":"number",
            "description":"The planned cost amount for all the labor resources associated with the task.",
            "nullable":true
        },
        "TaskCode29Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode40Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode21Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskCode23Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskLevel":{
            "title":"Task Level",
            "type":"integer",
            "description":"Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "TaskCode02Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TextAttr17":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr18":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "TextAttr19":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr08":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr13":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr09":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr14":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr06":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr15":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        },
        "NumberAttr07":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true
        },
        "TextAttr16":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true
        }
    }
}

Nested Schema : Gate Approvers

Type: array

Title: Gate Approvers

The Gate Approvers resource is used to view gate approver details.

Show Source

• Array of: object workPlanTemplates-Tasks-GateApprovers-item-patch-request

{
    "title":"Gate Approvers",
    "type":"array",
    "description":"The Gate Approvers resource is used to view gate approver details.",
    "items":{
        "$ref":"#/components/schemas/workPlanTemplates-Tasks-GateApprovers-item-patch-request"
    }
}

Nested Schema : TaskDFF

Type: array

Show Source

• Array of: object workPlanTemplates-Tasks-TaskDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workPlanTemplates-Tasks-TaskDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : workPlanTemplates-Tasks-GateApprovers-item-patch-request

Type: object

Show Source

• GateApproverEmail: string
  Title: Gate Approver Email

  Email address of the gate approver.
• GateApproverId: integer (int64)
  Title: Gate Approver ID

  Unique identifier of the gate approver.
• GateApproverName: string
  Title: Gate Approver Name

  Name of the gate approver.

{
    "type":"object",
    "properties":{
        "GateApproverName":{
            "title":"Gate Approver Name",
            "type":"string",
            "description":"Name of the gate approver.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverEmail",
                    "GateApproverId"
                ]
            }
        },
        "GateApproverId":{
            "title":"Gate Approver ID",
            "type":"integer",
            "description":"Unique identifier of the gate approver.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GateApproverEmail":{
            "title":"Gate Approver Email",
            "type":"string",
            "description":"Email address of the gate approver.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverId"
                ]
            }
        }
    }
}

Nested Schema : workPlanTemplates-Tasks-TaskDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ProjElementId: integer (int64)

{
    "type":"object",
    "properties":{
        "ProjElementId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : workPlanTemplates-Tasks-item-response

Type: object

Show Source

• Allocation: number
  Title: Allocation Percentage

  The percentage of resource's hours allocated to the task for the task duration.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable.
• ChargeableFlag: boolean
  Title: Chargeable

  Maximum Length: 1

  Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the task.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the task was created.
• Description: string
  Title: Task Description

  Maximum Length: 2000

  Text description of the task.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  For internal use. The order in which the task is displayed.
• Duration: number
  Title: Planned Duration

  The planned duration of the task.
• Effort: number
  Title: Planned Effort in Hours

  The estimated effort, in hours, required to complete a task.
• ElementType: string
  Title: Task Element Type

  Maximum Length: 30

  Default Value: EXECUTION

  Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL.
• ExpenseAmount: number
  Title: Planned Expense Amount

  Default Value: 0

  The planned expense amount for the task.
• GateApprovers: array Gate Approvers
  Title: Gate Approvers

  The Gate Approvers resource is used to view gate approver details.
• GateFlag: boolean
  Title: Gate

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is a gate.
• LaborBillAmount: number
  Title: Planned Labor Bill Amount

  The planned bill amount for all the labor resources associated with the task.
• LaborCost: number
  Title: Planned Labor Cost

  The planned cost amount for all the labor resources associated with the task.
• LeafIndicator: string
  Title: Leaf Indicator

  Maximum Length: 1

  Default Value: Y

  Indicates whether the task is a lowest-level task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualScheduleFlag: boolean
  Title: Manual Schedule

  Maximum Length: 1

  Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process.
• MilestoneFlag: boolean
  Title: Milestone

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is a milestone.
• Name: string
  Title: Task Name

  Maximum Length: 255

  Name of the task.
• NumberAttr01: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr02: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr03: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr04: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr05: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr06: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr07: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr08: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr09: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• NumberAttr10: number
  Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
• ParentTaskId: integer (int64)
  Title: Parent Task ID

  Identifier of the parent task of the task.
• PeerReferenceTaskId: integer
  Title: Peer Reference Task ID

  Unique identifier of the peer task.
• PrimaryResourceEmail: string
  Title: Primary Resource Email

  Read Only: true

  Maximum Length: 240

  Email of the person who leads the task.
• PrimaryResourceName: string
  Title: Primary Resource Name

  Read Only: true

  Maximum Length: 240

  Name of the resource who leads the work on a task.
• Priority: number
  Title: Priority

  Priority of the task for the assigned resource.
• ScheduleTypeCode: string
  Title: Task Schedule Type Code

  Maximum Length: 30

  Schedule type of the task. Valid values are fixed effort and fixed duration.
• TaskCode01Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode02Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode03Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode04Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode05Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode06Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode07Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode08Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode09Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode10Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode11Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode12Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode13Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode14Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode15Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode16Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode17Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode18Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode19Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode20Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode21Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode22Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode23Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode24Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode25Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode26Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode27Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode28Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode29Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode30Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode31Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode32Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode33Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode34Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode35Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode36Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode37Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode38Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode39Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskCode40Id: integer (int64)
  Task code defined during implementation that provides a list of values to capture additional information for a task.
• TaskDFF: array TaskDFF
• TaskId: integer (int64)
  Title: Task ID

  Unique identifier of the task.
• TaskLevel: integer (int32)
  Title: Task Level

  Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  The number assigned to a task. It's used to uniquely identify a task.
• TextAttr01: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr02: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr03: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr04: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr05: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr06: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr07: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr08: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr09: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr10: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr11: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr12: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr13: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr14: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr15: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr16: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr17: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr18: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr19: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TextAttr20: string
  Maximum Length: 200

  Task code defined during implementation that provides free-form text entry to capture additional information for a task.
• TotalCost: number
  Title: Total Cost

  The total cost of the task. It's the sum of expense and labor costs.
• WorkType: string
  Title: Work Type

  Maximum Length: 240

  Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date.
• WorkTypeId: integer (int64)
  Title: Work Type ID

  Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TextAttr10":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode19Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TextAttr11":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr12":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode15Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryResourceName":{
            "title":"Primary Resource Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the resource who leads the work on a task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode38Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCost":{
            "title":"Total Cost",
            "type":"number",
            "description":"The total cost of the task. It's the sum of expense and labor costs.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode30Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode34Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TextAttr06":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr07":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "GateApprovers":{
            "title":"Gate Approvers",
            "type":"array",
            "description":"The Gate Approvers resource is used to view gate approver details.",
            "items":{
                "$ref":"#/components/schemas/workPlanTemplates-Tasks-GateApprovers-item-response"
            }
        },
        "TaskCode11Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TextAttr08":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr09":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr02":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborBillAmount":{
            "title":"Planned Labor Bill Amount",
            "type":"number",
            "description":"The planned bill amount for all the labor resources associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr03":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr04":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr05":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode07Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TextAttr01":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualScheduleFlag":{
            "title":"Manual Schedule",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode03Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode26Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeerReferenceTaskId":{
            "title":"Peer Reference Task ID",
            "type":"integer",
            "description":"Unique identifier of the peer task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode22Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTaskId":{
            "title":"Parent Task ID",
            "type":"integer",
            "description":"Identifier of the parent task of the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Task Description",
            "maxLength":2000,
            "type":"string",
            "description":"Text description of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode18Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"For internal use. The order in which the task is displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode14Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleTypeCode":{
            "title":"Task Schedule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Schedule type of the task. Valid values are fixed effort and fixed duration.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode37Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode33Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode10Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode06Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneFlag":{
            "title":"Milestone",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is a milestone.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "NumberAttr10":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number assigned to a task. It's used to uniquely identify a task.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskCode25Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LaborCost":{
            "title":"Planned Labor Cost",
            "type":"number",
            "description":"The planned cost amount for all the labor resources associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode29Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode40Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode21Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode02Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberAttr08":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr09":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr06":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr07":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr04":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr05":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr02":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberAttr03":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode17Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberAttr01":{
            "type":"number",
            "description":"Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "Effort":{
            "title":"Planned Effort in Hours",
            "type":"number",
            "description":"The estimated effort, in hours, required to complete a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode36Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpenseAmount":{
            "title":"Planned Expense Amount",
            "type":"number",
            "description":"The planned expense amount for the task.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "TaskCode32Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryResourceEmail":{
            "title":"Primary Resource Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the person who leads the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode13Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskCode09Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ElementType":{
            "title":"Task Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL.",
            "nullable":false,
            "default":"EXECUTION",
            "x-queryable":true
        },
        "GateFlag":{
            "title":"Gate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is a gate.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "TaskCode05Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"number",
            "description":"Priority of the task for the assigned resource.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workPlanTemplates-Tasks-TaskDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Duration":{
            "title":"Planned Duration",
            "type":"number",
            "description":"The planned duration of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode28Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode20Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode24Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode01Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode16Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode39Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeableFlag":{
            "title":"Chargeable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkTypeId":{
            "title":"Work Type ID",
            "type":"integer",
            "description":"Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode31Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Allocation":{
            "title":"Allocation Percentage",
            "type":"number",
            "description":"The percentage of resource's hours allocated to the task for the task duration.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode35Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode12Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeafIndicator":{
            "title":"Leaf Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the task is a lowest-level task.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "TextAttr20":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode08Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkType":{
            "title":"Work Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskCode04Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode27Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskCode23Id":{
            "type":"integer",
            "description":"Task code defined during implementation that provides a list of values to capture additional information for a task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskLevel":{
            "title":"Task Level",
            "type":"integer",
            "description":"Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TextAttr17":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr18":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr19":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr13":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr14":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr15":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAttr16":{
            "maxLength":200,
            "type":"string",
            "description":"Task code defined during implementation that provides free-form text entry to capture additional information for a task.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Gate Approvers

Type: array

Title: Gate Approvers

The Gate Approvers resource is used to view gate approver details.

Show Source

• Array of: object workPlanTemplates-Tasks-GateApprovers-item-response

{
    "title":"Gate Approvers",
    "type":"array",
    "description":"The Gate Approvers resource is used to view gate approver details.",
    "items":{
        "$ref":"#/components/schemas/workPlanTemplates-Tasks-GateApprovers-item-response"
    }
}

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 : TaskDFF

Type: array

Show Source

• Array of: object workPlanTemplates-Tasks-TaskDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workPlanTemplates-Tasks-TaskDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : workPlanTemplates-Tasks-GateApprovers-item-response

Type: object

Show Source

• ApprovalId: integer (int64)
  Title: Approval ID

  Read Only: true

  Unique identifier of the Gate Approver. Value is auto-generated.
• GateApproverEmail: string
  Title: Gate Approver Email

  Email address of the gate approver.
• GateApproverId: integer (int64)
  Title: Gate Approver ID

  Unique identifier of the gate approver.
• GateApproverName: string
  Title: Gate Approver Name

  Name of the gate approver.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ApprovalId":{
            "title":"Approval ID",
            "type":"integer",
            "description":"Unique identifier of the Gate Approver. Value is auto-generated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GateApproverName":{
            "title":"Gate Approver Name",
            "type":"string",
            "description":"Name of the gate approver.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverEmail",
                    "GateApproverId"
                ]
            }
        },
        "GateApproverId":{
            "title":"Gate Approver ID",
            "type":"integer",
            "description":"Unique identifier of the gate approver.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GateApproverEmail":{
            "title":"Gate Approver Email",
            "type":"string",
            "description":"Email address of the gate approver.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverId"
                ]
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : workPlanTemplates-Tasks-TaskDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjElementId: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjElementId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

GateApprovers

Operation: /fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/Tasks/{TaskId}/child/GateApprovers

Parameters:

• TaskId: $request.path.TaskId
• WorkPlanTemplateId: $request.path.WorkPlanTemplateId

The Gate Approvers resource is used to view gate approver details.

TaskDFF

Operation: /fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/Tasks/{TaskId}/child/TaskDFF

Parameters:

• TaskId: $request.path.TaskId
• WorkPlanTemplateId: $request.path.WorkPlanTemplateId

Back to Top

Examples

The following example shows how to update a task in a work plan template by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369456

Request Body Example

The following shows an example of the request body in JSON format.

{
"Name" : "Task 2"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"BillableFlag": null,
"ChargeableFlag": null,
"Description": null,
"DisplaySequence": 10000000,
"ElementType": "EXECUTION",
"GateFlag": false,
"ManualScheduleFlag": false,
"MilestoneFlag": true,
"Name": "Task 2",
"ParentTaskId": 100100148369455,
"Allocation": 100,
"Duration": 0,
"Effort": 0,
"PrimaryResourceEmail": "[e-mail]",
"PrimaryResourceName": "Connor Horton",
"TaskId": 100100148369456,
"TaskLevel": 1,
"TaskNumber": "2006",
"NumberAttr01": null,
"NumberAttr02": null,
"NumberAttr03": null,
"NumberAttr04": null,
"NumberAttr05": null,
"NumberAttr06": null,
"NumberAttr07": null,
"NumberAttr08": null,
"NumberAttr09": null,
"NumberAttr10": null,
"TaskCode01Id": null,
"TaskCode02Id": null,
"TaskCode03Id": null,
"TaskCode04Id": null,
"TaskCode05Id": null,
"TaskCode06Id": null,
"TaskCode07Id": null,
"TaskCode08Id": null,
"TaskCode09Id": null,
"TaskCode10Id": null,
"TaskCode11Id": null,
"TaskCode12Id": null,
"TaskCode13Id": null,
"TaskCode14Id": null,
"TaskCode15Id": null,
"TaskCode16Id": null,
"TaskCode17Id": null,
"TaskCode18Id": null,
"TaskCode19Id": null,
"TaskCode20Id": null,
"TaskCode21Id": null,
"TaskCode22Id": null,
"TaskCode23Id": null,
"TaskCode24Id": null,
"TaskCode25Id": null,
"TaskCode26Id": null,
"TaskCode27Id": null,
"TaskCode28Id": null,
"TaskCode29Id": null,
"TaskCode30Id": null,
"TaskCode31Id": null,
"TaskCode32Id": null,
"TaskCode33Id": null,
"TaskCode34Id": null,
"TaskCode35Id": null,
"TaskCode36Id": null,
"TaskCode37Id": null,
"TaskCode38Id": null,
"TaskCode39Id": null,
"TaskCode40Id": null,
"TextAttr01": null,
"TextAttr02": null,
"TextAttr03": null,
"TextAttr04": null,
"TextAttr05": null,
"TextAttr06": null,
"TextAttr07": null,
"TextAttr08": null,
"TextAttr09": null,
"TextAttr10": null,
"TextAttr11": null,
"TextAttr12": null,
"TextAttr13": null,
"TextAttr14": null,
"TextAttr15": null,
"TextAttr16": null,
"TextAttr17": null,
"TextAttr18": null,
"TextAttr19": null,
"TextAttr20": null,
"LaborCost": 0,
"LaborBillAmount": 0,
"ExpenseAmount": 0,
"TotalCost": 0,
"Priority": null,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369456",
"name": "Tasks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E0002000000017371007E0002000000057372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369456",
"name": "Tasks",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454",
"name": "workPlanTemplates",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369456/child/GateApprovers",
"name": "GateApprovers",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369456/child/TaskDFF",
"name": "TaskDFF",
"kind": "collection"
}
]
}

Back to Top