Jump to

• Request
• Response

Update one task

patch

/fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCycleStages/{PlanningCycleStageId}/child/planningCycleActivities/{PlanningCycleActivityId}/child/planningCycleTasks/{PlanningCycleTaskId}

Request

Path Parameters

• PlanningCycleActivityId(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=
• PlanningCycleId(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=
• PlanningCycleStageId(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=
• PlanningCycleTaskId(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: string
  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: string
  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

• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the task in the planning cycle stage.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the task in the planning cycle stage is completed.
• PlanningCycleTaskDueDate: string (date)
  Date when the task in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the task in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the task in the planning cycle stage.
• PlanningCycleTaskLinktype: integer (int32)
  Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the task in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the task.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the task in the planning cycle stage.
• PlanningCycleTaskType: string
  Maximum Length: 80

  Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlannningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the task in the planning cycle stage.

{
    "type":"object",
    "properties":{
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the task in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is due.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskLinktype":{
            "type":"integer",
            "description":"Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task in the planning cycle stage.",
            "nullable":false
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the task in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the task in the planning cycle stage.",
            "nullable":true
        },
        "PlannningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the task in the planning cycle stage.",
            "nullable":true
        }
    }
}

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 : planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the task in the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the task in the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the task in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the task in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleTaskAssignee: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's assigned the task in the planning cycle stage.
• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the task in the planning cycle stage.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the task in the planning cycle stage is completed.
• PlanningCycleTaskDaysLate: integer
  Read Only: true

  Value that indicates the difference between the completion date and the due date for the task in the planning cycle stage.
• PlanningCycleTaskDueDate: string (date)
  Date when the task in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the task in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the task in the planning cycle stage.
• PlanningCycleTaskLinktype: integer (int32)
  Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwner: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the task in the planning cycle stage.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the task in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the task.
• PlanningCycleTaskStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage associated with the task.
• PlanningCycleTaskStatus: string
  Read Only: true

  Maximum Length: 80

  Status name of the task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the task in the planning cycle stage.
• PlanningCycleTaskType: string
  Maximum Length: 80

  Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlannningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the task in the planning cycle stage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the task in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the task in the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the task in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskLinktype":{
            "type":"integer",
            "description":"Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanningCycleTaskStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage associated with the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task in the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the task in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status name of the task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleTaskDaysLate":{
            "type":"integer",
            "description":"Value that indicates the difference between the completion date and the due date for the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssignee":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's assigned the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the task in the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top