Jump to

• Request
• Response
• Examples

Update the progress of a financial task

patch

/fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}

Request

Path Parameters

• ProjectId(required): integer(int64)
  Unique identifier of the project.
• TaskId(required): integer(int64)
  Unique identifier of the task.

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

• ActualFinishDate: string (date)
  Title: Actual Finish Date

  Date on which work completed on the task as opposed to the planned end date of the task.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Date on which work commenced on the task as opposed to the planned start date of the task.
• Attachments: array Attachments
  Title: Attachments

  The Attachment resource is used to view, create, update, and delete attachments for task progress.
• EstimatedFinishDate: string (date)
  Title: Estimated Finish Date

  Projected end date of the task.
• EstimatedStartDate: string (date)
  Title: Estimated Start Date

  Projected start date of the task.
• Notes: array Notes
  Title: Notes

  The Note resource is used to view, create, update, and delete notes for task progress.
• PercentComplete: number
  Title: Physical Percent Complete

  The amount of physical work achieved on the task.
• ProgressStatus: string
  Title: Progress Status

  Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
• ProgressStatusCode: string
  Title: Progress Status Code

  Maximum Length: 30

  Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
• ResourceProgress: array Resource Progress
  Title: Resource Progress

  The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.
• TaskProgressDFF: array Task Progress Descriptive Flexfields
  Title: Task Progress Descriptive Flexfields

  The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

{
    "type":"object",
    "properties":{
        "EstimatedStartDate":{
            "title":"Estimated Start Date",
            "type":"string",
            "description":"Projected start date of the task.",
            "format":"date",
            "nullable":true
        },
        "EstimatedFinishDate":{
            "title":"Estimated Finish Date",
            "type":"string",
            "description":"Projected end date of the task.",
            "format":"date",
            "nullable":true
        },
        "ActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"Date on which work completed on the task as opposed to the planned end date of the task.",
            "format":"date",
            "nullable":true
        },
        "ProgressStatus":{
            "title":"Progress Status",
            "type":"string",
            "description":"Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceProgress":{
            "title":"Resource Progress",
            "type":"array",
            "description":"The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-item-patch-request"
            }
        },
        "PercentComplete":{
            "title":"Physical Percent Complete",
            "type":"number",
            "description":"The amount of physical work achieved on the task.",
            "nullable":true,
            "x-hints":{
                "precision":"14",
                "scale":"10"
            }
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which work commenced on the task as opposed to the planned start date of the task.",
            "format":"date",
            "nullable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachment resource is used to view, create, update, and delete attachments for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-Attachments-item-patch-request"
            }
        },
        "TaskProgressDFF":{
            "title":"Task Progress Descriptive Flexfields",
            "type":"array",
            "description":"The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-TaskProgressDFF-item-patch-request"
            }
        },
        "Notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Note resource is used to view, create, update, and delete notes for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-Notes-item-patch-request"
            }
        },
        "ProgressStatusCode":{
            "title":"Progress Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachment resource is used to view, create, update, and delete attachments for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachment resource is used to view, create, update, and delete attachments for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-Attachments-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The Note resource is used to view, create, update, and delete notes for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-Notes-item-patch-request

{
    "title":"Notes",
    "type":"array",
    "description":"The Note resource is used to view, create, update, and delete notes for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-Notes-item-patch-request"
    }
}

Nested Schema : Resource Progress

Type: array

Title: Resource Progress

The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.

Show Source

• Array of: object schema

{
    "title":"Resource Progress",
    "type":"array",
    "description":"The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-item-patch-request"
    }
}

Nested Schema : Task Progress Descriptive Flexfields

Type: array

Title: Task Progress Descriptive Flexfields

The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-TaskProgressDFF-item-patch-request

{
    "title":"Task Progress Descriptive Flexfields",
    "type":"array",
    "description":"The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-TaskProgressDFF-item-patch-request"
    }
}

Nested Schema : projectProgress-TaskProgress-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : projectProgress-TaskProgress-Notes-item-patch-request

Type: object

Show Source

• NoteTxt: string (byte)
  Title: Note Text

  The text for the progress note.

{
    "type":"object",
    "properties":{
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the progress note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ActualFinishDate: string (date)
  Title: Actual Finish Date

  Actual finish date collected during progress entry.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Actual start date collected during progress entry.
• Attachments: array Attachments
  Title: Attachments

  The Attachment resource is used to view, create, update, and delete attachments for resource progress.
• EstimatedFinishDate: string (date)
  Title: Estimated Finish Date

  An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date.
• EstimatedStartDate: string (date)
  Title: Estimated Start Date

  An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date.
• EstimatetoCompleteCostinProjectCurrency: number
  Title: ETC

  Estimate to complete burdened cost in project currency.
• EstimatetoCompleteQuantity: number
  Title: ETC

  Estimate to complete in quantity.
• Notes: array Notes
  Title: Notes

  The Note resource is used to view, create, update, and delete notes for resource progress.
• ResourceProgressDFF: array Resource Progress Descriptive Flexfields
  Title: Resource Progress Descriptive Flexfields

  The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.

{
    "type":"object",
    "properties":{
        "EstimatetoCompleteCostinProjectCurrency":{
            "title":"ETC",
            "type":"number",
            "description":"Estimate to complete burdened cost in project currency.",
            "nullable":true
        },
        "EstimatedStartDate":{
            "title":"Estimated Start Date",
            "type":"string",
            "description":"An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date.",
            "format":"date",
            "nullable":true
        },
        "EstimatedFinishDate":{
            "title":"Estimated Finish Date",
            "type":"string",
            "description":"An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date.",
            "format":"date",
            "nullable":true
        },
        "ActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"Actual finish date collected during progress entry.",
            "format":"date",
            "nullable":true
        },
        "EstimatetoCompleteQuantity":{
            "title":"ETC",
            "type":"number",
            "description":"Estimate to complete in quantity.",
            "nullable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Actual start date collected during progress entry.",
            "format":"date",
            "nullable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachment resource is used to view, create, update, and delete attachments for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Attachments-item-patch-request"
            }
        },
        "Notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Note resource is used to view, create, update, and delete notes for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request"
            }
        },
        "ResourceProgressDFF":{
            "title":"Resource Progress Descriptive Flexfields",
            "type":"array",
            "description":"The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachment resource is used to view, create, update, and delete attachments for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachment resource is used to view, create, update, and delete attachments for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Attachments-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The Note resource is used to view, create, update, and delete notes for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request

{
    "title":"Notes",
    "type":"array",
    "description":"The Note resource is used to view, create, update, and delete notes for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request"
    }
}

Nested Schema : Resource Progress Descriptive Flexfields

Type: array

Title: Resource Progress Descriptive Flexfields

The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request

{
    "title":"Resource Progress Descriptive Flexfields",
    "type":"array",
    "description":"The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request"
    }
}

Nested Schema : projectProgress-TaskProgress-ResourceProgress-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request

Type: object

Show Source

• NoteTxt: string (byte)
  Title: Note Text

  The text for the progress note.

{
    "type":"object",
    "properties":{
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the progress note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        }
    }
}

Nested Schema : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context of the descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context display value of the descriptive flexfield.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : projectProgress-TaskProgress-TaskProgressDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context of the descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context display value of the descriptive flexfield.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "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":"LOV"
            },
            "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 : projectProgress-TaskProgress-item-response

Type: object

Show Source

• ActualAmountsDate: string (date)
  Title: Progress Actual Amounts Summarization Date

  Read Only: true

  Date on which actual amounts are most recently summarized.
• ActualAmountsThroughPeriod: string
  Title: Actual Amounts Through Period

  Read Only: true

  Maximum Length: 30

  Period through which actual amounts are summarized for project progress.
• ActualFinishDate: string (date)
  Title: Actual Finish Date

  Date on which work completed on the task as opposed to the planned end date of the task.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Date on which work commenced on the task as opposed to the planned start date of the task.
• Attachments: array Attachments
  Title: Attachments

  The Attachment resource is used to view, create, update, and delete attachments for task progress.
• BaselineFinishDate: string (date)
  Title: Baseline Finish Date

  Read Only: true

  Planned end date of the task in baseline project plan. Used to compare the deviation of the current task end from the original planned end date.
• BaselineStartDate: string (date)
  Title: Baseline Start Date

  Read Only: true

  Planned start date of the task in baseline project plan. Used to compare the deviation of the current task start from the original planned start date.
• CurrentActualAmountsDate: string (date)
  Title: Current Actual Amounts Summarization Date

  Read Only: true

  Date on which actual amounts are most recently summarized.
• CurrentActualAmountsPeriod: string
  Title: Current Actual Amount Period

  Read Only: true

  Maximum Length: 255

  Period through which actual amounts are most recently summarized.
• EstimatedFinishDate: string (date)
  Title: Estimated Finish Date

  Projected end date of the task.
• EstimatedStartDate: string (date)
  Title: Estimated Start Date

  Projected start date of the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: array Notes
  Title: Notes

  The Note resource is used to view, create, update, and delete notes for task progress.
• PercentComplete: number
  Title: Physical Percent Complete

  The amount of physical work achieved on the task.
• PlannedFinishDate: string (date)
  Title: Planned Finish Date

  Read Only: true

  Scheduled end date of the task.
• PlannedStartDate: string (date)
  Title: Planned Start Date

  Read Only: true

  Scheduled start date of the task.
• PreviousPercentComplete: number
  Title: Previous Physical Percent Complete

  Read Only: true

  The amount of physical work achieved on the task in the most recently captured progress.
• ProgressAsOfDate: string (date)
  Title: Progress As-of Date

  Read Only: true

  Date through which progress is captured for the project.
• ProgressAsOfPeriod: string
  Title: Progress As-of Period

  Read Only: true

  Maximum Length: 30

  Period through which progress is captured for the project.
• ProgressStatus: string
  Title: Progress Status

  Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
• ProgressStatusCode: string
  Title: Progress Status Code

  Maximum Length: 30

  Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
• ProjectBurdenedActualCost: number
  Title: Actual Burdened Cost in Project Currency

  Read Only: true

  Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead.
• ProjectCurrency: string
  Title: Project Currency

  Read Only: true

  Maximum Length: 15

  The currency code for the project. The currency code is a three-letter ISO code associated with a currency.
• ProjectId: integer (int64)
  Title: Project ID

  Read Only: true

  Unique identifier of the project.
• ProjectLedgerBurdenedActualCost: number
  Title: Actual Burdened Cost in Ledger Currency

  Read Only: true

  Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead.
• ProjectLedgerCurrency: string
  Title: Project Ledger Currency

  Read Only: true

  Maximum Length: 15

  The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency.
• ProjectLedgerRawActualCost: number
  Title: Actual Raw Cost in Ledger Currency

  Read Only: true

  Actual amount paid or actual amount incurred for the task in project ledger currency.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  Name assigned to the project.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  Alphanumeric identifier of the project.
• ProjectRawActualCost: number
  Title: Actual Raw Cost in Project Currency

  Read Only: true

  Actual amount paid or actual amount incurred for the task in project currency.
• PublicationStatus: string
  Title: Progress Publication Status

  Read Only: true

  Maximum Length: 255

  Status of current project progress. The status can either be Draft or Published.
• ResourceProgress: array Resource Progress
  Title: Resource Progress

  The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.
• SourceApplicationCode: string
  Title: Source Application

  Read Only: true

  Maximum Length: 30

  The third-party application from which the project originated.
• SourceProjectReference: string
  Title: Source Reference

  Read Only: true

  Maximum Length: 25

  The identifier of the project in the external application where it was originally created.
• TaskId: integer (int64)
  Title: Task ID

  Read Only: true

  Unique identifier of the task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  Name assigned to the task.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  Alphanumeric identifier of the task.
• TaskProgressDFF: array Task Progress Descriptive Flexfields
  Title: Task Progress Descriptive Flexfields

  The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

{
    "type":"object",
    "properties":{
        "ProgressAsOfDate":{
            "title":"Progress As-of Date",
            "type":"string",
            "description":"Date through which progress is captured for the project.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedStartDate":{
            "title":"Estimated Start Date",
            "type":"string",
            "description":"Projected start date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name assigned to the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProjectReference":{
            "title":"Source Reference",
            "maxLength":"25",
            "type":"string",
            "description":"The identifier of the project in the external application where it was originally created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineStartDate":{
            "title":"Baseline Start Date",
            "type":"string",
            "description":"Planned start date of the task in baseline project plan. Used to compare the deviation of the current task start from the original planned start date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which work commenced on the task as opposed to the planned start date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachment resource is used to view, create, update, and delete attachments for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-Attachments-item-response"
            }
        },
        "PlannedStartDate":{
            "title":"Planned Start Date",
            "type":"string",
            "description":"Scheduled start date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedFinishDate":{
            "title":"Planned Finish Date",
            "type":"string",
            "description":"Scheduled end date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectLedgerRawActualCost":{
            "title":"Actual Raw Cost in Ledger Currency",
            "type":"number",
            "description":"Actual amount paid or actual amount incurred for the task in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgressAsOfPeriod":{
            "title":"Progress As-of Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period through which progress is captured for the project.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ProgressAsOfDate"
                ]
            },
            "x-queryable":true
        },
        "ActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"Date on which work completed on the task as opposed to the planned end date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousPercentComplete":{
            "title":"Previous Physical Percent Complete",
            "type":"number",
            "description":"The amount of physical work achieved on the task in the most recently captured progress.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"14",
                "scale":"10"
            },
            "x-queryable":true
        },
        "ProjectLedgerBurdenedActualCost":{
            "title":"Actual Burdened Cost in Ledger Currency",
            "type":"number",
            "description":"Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrency":{
            "title":"Project Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for the project. The currency code is a three-letter ISO code associated with a currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicationStatus":{
            "title":"Progress Publication Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of current project progress. The status can either be Draft or Published.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Note resource is used to view, create, update, and delete notes for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-Notes-item-response"
            }
        },
        "ActualAmountsThroughPeriod":{
            "title":"Actual Amounts Through Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period through which actual amounts are summarized for project progress.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceProgress":{
            "title":"Resource Progress",
            "type":"array",
            "description":"The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-item-response"
            }
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Alphanumeric identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectBurdenedActualCost":{
            "title":"Actual Burdened Cost in Project Currency",
            "type":"number",
            "description":"Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceApplicationCode":{
            "title":"Source Application",
            "maxLength":"30",
            "type":"string",
            "description":"The third-party application from which the project originated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Alphanumeric identifier of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentActualAmountsPeriod":{
            "title":"Current Actual Amount Period",
            "maxLength":"255",
            "type":"string",
            "description":"Period through which actual amounts are most recently summarized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskProgressDFF":{
            "title":"Task Progress Descriptive Flexfields",
            "type":"array",
            "description":"The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-TaskProgressDFF-item-response"
            }
        },
        "ActualAmountsDate":{
            "title":"Progress Actual Amounts Summarization Date",
            "type":"string",
            "description":"Date on which actual amounts are most recently summarized.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentActualAmountsDate":{
            "title":"Current Actual Amounts Summarization Date",
            "type":"string",
            "description":"Date on which actual amounts are most recently summarized.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedFinishDate":{
            "title":"Estimated Finish Date",
            "type":"string",
            "description":"Projected end date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgressStatus":{
            "title":"Progress Status",
            "type":"string",
            "description":"Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name assigned to the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectRawActualCost":{
            "title":"Actual Raw Cost in Project Currency",
            "type":"number",
            "description":"Actual amount paid or actual amount incurred for the task in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Physical Percent Complete",
            "type":"number",
            "description":"The amount of physical work achieved on the task.",
            "nullable":true,
            "x-hints":{
                "precision":"14",
                "scale":"10"
            },
            "x-queryable":true
        },
        "ProjectLedgerCurrency":{
            "title":"Project Ledger Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineFinishDate":{
            "title":"Baseline Finish Date",
            "type":"string",
            "description":"Planned end date of the task in baseline project plan. Used to compare the deviation of the current task end from the original planned end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgressStatusCode":{
            "title":"Progress Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachment resource is used to view, create, update, and delete attachments for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachment resource is used to view, create, update, and delete attachments for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-Attachments-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 : Notes

Type: array

Title: Notes

The Note resource is used to view, create, update, and delete notes for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-Notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Note resource is used to view, create, update, and delete notes for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-Notes-item-response"
    }
}

Nested Schema : Resource Progress

Type: array

Title: Resource Progress

The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-item-response

{
    "title":"Resource Progress",
    "type":"array",
    "description":"The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-item-response"
    }
}

Nested Schema : Task Progress Descriptive Flexfields

Type: array

Title: Task Progress Descriptive Flexfields

The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

Show Source

• Array of: object projectProgress-TaskProgress-TaskProgressDFF-item-response

{
    "title":"Task Progress Descriptive Flexfields",
    "type":"array",
    "description":"The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-TaskProgressDFF-item-response"
    }
}

Nested Schema : projectProgress-TaskProgress-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : projectProgress-TaskProgress-Notes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the progress note.
• NoteTxt: string (byte)
  Title: Note Text

  The text for the progress note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the progress note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the progress note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "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 : projectProgress-TaskProgress-ResourceProgress-item-response

Type: object

Show Source

• ActualAmountsDate: string (date)
  Title: Progress Actual Amounts Summarization Date

  Read Only: true

  Date on which actual amounts are most recently summarized.
• ActualFinishDate: string (date)
  Title: Actual Finish Date

  Actual finish date collected during progress entry.
• ActualsAmountsThroughPeriod: string
  Title: Actual Amounts Through Period

  Read Only: true

  Maximum Length: 30

  Period through which actual amounts are summarized for project progress.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Actual start date collected during progress entry.
• Attachments: array Attachments
  Title: Attachments

  The Attachment resource is used to view, create, update, and delete attachments for resource progress.
• BaselinedPlannedCost: number
  Title: Baseline Planned Cost

  Read Only: true

  Baseline planned burdened cost from the project plan.
• BaselinedPlannedEffort: number
  Title: Baseline Planned Effort

  Read Only: true

  Baselined planned effort from the financial project plan.
• BaselinedPlannedQuantity: number
  Title: Baseline Planned Quantity

  Read Only: true

  Baselined planned quantity from the financial project plan.
• BaselineFinishDate: string (date)
  Title: Baseline Finish Date

  Read Only: true

  Planned end date of the task in the baseline project plan. Used to compare the deviation of the current task end from the original planned end date.
• BaselineStartDate: string (date)
  Title: Baseline Start Date

  Read Only: true

  Planned start date of the task in the baseline project plan. Used to compare the deviation of the current task start from the original planned start date.
• CurrentActualAmountsDate: string (date)
  Title: Current Actual Amounts Summarization Date

  Read Only: true

  Date on which actual amounts are most recently summarized.
• CurrentActualAmountsPeriod: string
  Title: Current Actual Amount Period

  Read Only: true

  Maximum Length: 255

  Period through which actual amounts are most recently summarized.
• CurrentPlannedCost: number
  Title: Current Planned Cost

  Read Only: true

  Current planned burdened cost from the project plan.
• CurrentPlannedEffort: number
  Title: Current Planned Effort

  Read Only: true

  Current planned effort from the financial project plan.
• CurrentPlannedQuantity: number
  Title: Current Planned Quantity

  Read Only: true

  Current planned quantity from the financial project plan.
• EstimateatCompletionCostinProjectCurrency: number
  Title: EAC

  Read Only: true

  Estimate at completion burdened cost in project currency.
• EstimateatCompletionQuantity: number
  Title: EAC

  Read Only: true

  Estimate at completion quantity.
• EstimatedFinishDate: string (date)
  Title: Estimated Finish Date

  An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date.
• EstimatedStartDate: string (date)
  Title: Estimated Start Date

  An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date.
• EstimatetoCompleteCostinProjectCurrency: number
  Title: ETC

  Estimate to complete burdened cost in project currency.
• EstimatetoCompleteQuantity: number
  Title: ETC

  Estimate to complete in quantity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: array Notes
  Title: Notes

  The Note resource is used to view, create, update, and delete notes for resource progress.
• PlanningEndDate: string (date)
  Title: Planned Finish Date

  Read Only: true

  Scheduled end date of the task.
• PlanningStartDate: string (date)
  Title: Planned Start Date

  Read Only: true

  Scheduled start date of the task.
• ProgressAsOfDate: string (date)
  Title: Progress As-of Date

  Read Only: true

  Date through which progress is captured for the project.
• ProgressAsOfPeriod: string
  Title: Progress As-of Period

  Read Only: true

  Maximum Length: 30

  Period through which progress is captured for the project.
• ProjectBurdenedActualCost: number
  Title: Actual Burdened Cost in Project Currency

  Read Only: true

  Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead.
• ProjectCurrency: string
  Title: Project Currency

  Read Only: true

  Maximum Length: 15

  The currency code for the project. It is a three-letter ISO code associated with a currency.
• ProjectId: integer (int64)
  Title: Project ID

  Read Only: true

  Unique identifier of the project.
• ProjectLedgerBurdenedActualCost: number
  Title: Actual Burdened Cost in Ledger Currency

  Read Only: true

  Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead.
• ProjectLedgerCurrency: string
  Title: Project Ledger Currency

  Read Only: true

  Maximum Length: 15

  The currency code used for accounting and reporting in the project ledger. It is a three-letter ISO code associated with a currency.
• ProjectLedgerRawActualCost: number
  Title: Actual Raw Cost in Ledger Currency

  Read Only: true

  Actual amount paid or actual amount incurred for the task in project ledger currency.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  Name assigned to the project.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  Alphanumeric identifier of the project.
• ProjectRawActualCost: number
  Title: Actual Raw Cost in Project Currency

  Read Only: true

  Actual amount paid or actual amount incurred for the task in project currency.
• PublicationStatus: string
  Title: Progress Publication Status

  Read Only: true

  Maximum Length: 255

  Status of the current project progress. The status can either be Draft or Published.
• ResourceAssignmentFromDate: string (date)
  Title: Resource Assignment From Date

  Read Only: true

  The date that is planned on the financial plan for a resource to begin their assignment on a project task.
• ResourceAssignmentToDate: string (date)
  Title: Resource Assignment To Date

  Read Only: true

  The date that is planned on the financial plan for a resource to finish their assignment on a project task.
• ResourceClass: string
  Title: Resource Class

  Read Only: true

  Maximum Length: 30

  Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.
• ResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  Identifier of the resource breakdown structure element used to create the financial plan resource assignment.
• ResourceName: string
  Title: Resource

  Read Only: true

  Maximum Length: 240

  Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment.
• ResourceProgressDFF: array Resource Progress Descriptive Flexfields
  Title: Resource Progress Descriptive Flexfields

  The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.
• SourceApplicationCode: string
  Title: Source Application

  Read Only: true

  Maximum Length: 30

  The third-party application from which the project originated.
• SourceApplicationReference: string
  Title: Source Reference

  Read Only: true

  Maximum Length: 25

  The identifier of the project in the external application where it was originally created.
• TaskId: integer (int64)
  Title: Task ID

  Read Only: true

  Unique identifier of the task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  Name assigned to the task.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  Alphanumeric identifier of the task.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

  Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.
• Unplanned: string
  Title: Unplanned Resource

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Unplanned project cost included on the project.

{
    "type":"object",
    "properties":{
        "ProgressAsOfDate":{
            "title":"Progress As-of Date",
            "type":"string",
            "description":"Date through which progress is captured for the project.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPlannedQuantity":{
            "title":"Current Planned Quantity",
            "type":"number",
            "description":"Current planned quantity from the financial project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource",
            "maxLength":"240",
            "type":"string",
            "description":"Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatetoCompleteQuantity":{
            "title":"ETC",
            "type":"number",
            "description":"Estimate to complete in quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningEndDate":{
            "title":"Planned Finish Date",
            "type":"string",
            "description":"Scheduled end date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPlannedEffort":{
            "title":"Current Planned Effort",
            "type":"number",
            "description":"Current planned effort from the financial project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Actual start date collected during progress entry.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EstimateatCompletionQuantity":{
            "title":"EAC",
            "type":"number",
            "description":"Estimate at completion quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublicationStatus":{
            "title":"Progress Publication Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the current project progress. The status can either be Draft or Published.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BaselinedPlannedQuantity":{
            "title":"Baseline Planned Quantity",
            "type":"number",
            "description":"Baselined planned quantity from the financial project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceClass":{
            "title":"Resource Class",
            "maxLength":"30",
            "type":"string",
            "description":"Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatetoCompleteCostinProjectCurrency":{
            "title":"ETC",
            "type":"number",
            "description":"Estimate to complete burdened cost in project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAssignmentToDate":{
            "title":"Resource Assignment To Date",
            "type":"string",
            "description":"The date that is planned on the financial plan for a resource to finish their assignment on a project task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceApplicationCode":{
            "title":"Source Application",
            "maxLength":"30",
            "type":"string",
            "description":"The third-party application from which the project originated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentActualAmountsDate":{
            "title":"Current Actual Amounts Summarization Date",
            "type":"string",
            "description":"Date on which actual amounts are most recently summarized.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name assigned to the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectRawActualCost":{
            "title":"Actual Raw Cost in Project Currency",
            "type":"number",
            "description":"Actual amount paid or actual amount incurred for the task in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselinedPlannedEffort":{
            "title":"Baseline Planned Effort",
            "type":"number",
            "description":"Baselined planned effort from the financial project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningStartDate":{
            "title":"Planned Start Date",
            "type":"string",
            "description":"Scheduled start date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualsAmountsThroughPeriod":{
            "title":"Actual Amounts Through Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period through which actual amounts are summarized for project progress.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedStartDate":{
            "title":"Estimated Start Date",
            "type":"string",
            "description":"An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name assigned to the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineStartDate":{
            "title":"Baseline Start Date",
            "type":"string",
            "description":"Planned start date of the task in the baseline project plan. Used to compare the deviation of the current task start from the original planned start date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPlannedCost":{
            "title":"Current Planned Cost",
            "type":"number",
            "description":"Current planned burdened cost from the project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachment resource is used to view, create, update, and delete attachments for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Attachments-item-response"
            }
        },
        "ProjectLedgerRawActualCost":{
            "title":"Actual Raw Cost in Ledger Currency",
            "type":"number",
            "description":"Actual amount paid or actual amount incurred for the task in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAssignmentFromDate":{
            "title":"Resource Assignment From Date",
            "type":"string",
            "description":"The date that is planned on the financial plan for a resource to begin their assignment on a project task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgressAsOfPeriod":{
            "title":"Progress As-of Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period through which progress is captured for the project.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ProgressAsOfDate"
                ]
            },
            "x-queryable":true
        },
        "ActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"Actual finish date collected during progress entry.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EstimateatCompletionCostinProjectCurrency":{
            "title":"EAC",
            "type":"number",
            "description":"Estimate at completion burdened cost in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectLedgerBurdenedActualCost":{
            "title":"Actual Burdened Cost in Ledger Currency",
            "type":"number",
            "description":"Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrency":{
            "title":"Project Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for the project. It is a three-letter ISO code associated with a currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselinedPlannedCost":{
            "title":"Baseline Planned Cost",
            "type":"number",
            "description":"Baseline planned burdened cost from the project plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Note resource is used to view, create, update, and delete notes for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Notes-item-response"
            }
        },
        "Unplanned":{
            "title":"Unplanned Resource",
            "maxLength":"1",
            "type":"string",
            "description":"Unplanned project cost included on the project.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Alphanumeric identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectBurdenedActualCost":{
            "title":"Actual Burdened Cost in Project Currency",
            "type":"number",
            "description":"Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Alphanumeric identifier of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceApplicationReference":{
            "title":"Source Reference",
            "maxLength":"25",
            "type":"string",
            "description":"The identifier of the project in the external application where it was originally created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentActualAmountsPeriod":{
            "title":"Current Actual Amount Period",
            "maxLength":"255",
            "type":"string",
            "description":"Period through which actual amounts are most recently summarized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualAmountsDate":{
            "title":"Progress Actual Amounts Summarization Date",
            "type":"string",
            "description":"Date on which actual amounts are most recently summarized.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedFinishDate":{
            "title":"Estimated Finish Date",
            "type":"string",
            "description":"An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the resource breakdown structure element used to create the financial plan resource assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectLedgerCurrency":{
            "title":"Project Ledger Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used for accounting and reporting in the project ledger. It is a three-letter ISO code associated with a currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaselineFinishDate":{
            "title":"Baseline Finish Date",
            "type":"string",
            "description":"Planned end date of the task in the baseline project plan. Used to compare the deviation of the current task end from the original planned end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceProgressDFF":{
            "title":"Resource Progress Descriptive Flexfields",
            "type":"array",
            "description":"The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.",
            "items":{
                "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachment resource is used to view, create, update, and delete attachments for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachment resource is used to view, create, update, and delete attachments for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Attachments-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 : Notes

Type: array

Title: Notes

The Note resource is used to view, create, update, and delete notes for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-Notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Note resource is used to view, create, update, and delete notes for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-Notes-item-response"
    }
}

Nested Schema : Resource Progress Descriptive Flexfields

Type: array

Title: Resource Progress Descriptive Flexfields

The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.

Show Source

• Array of: object projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response

{
    "title":"Resource Progress Descriptive Flexfields",
    "type":"array",
    "description":"The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.",
    "items":{
        "$ref":"#/components/schemas/projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response"
    }
}

Nested Schema : projectProgress-TaskProgress-ResourceProgress-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : projectProgress-TaskProgress-ResourceProgress-Notes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the progress note.
• NoteTxt: string (byte)
  Title: Note Text

  The text for the progress note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the progress note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the progress note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "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 : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context of the descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context display value of the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectProgressId: integer (int64)
  Unique identifier of the project progress.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectProgressId":{
            "type":"integer",
            "description":"Unique identifier of the project progress.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "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":"LOV"
            },
            "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"
    }
}

Nested Schema : projectProgress-TaskProgress-TaskProgressDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context of the descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context display value of the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectProgressId: integer (int64)
  Unique identifier of the project progress.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectProgressId":{
            "type":"integer",
            "description":"Unique identifier of the project progress.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "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":"LOV"
            },
            "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

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments

Parameters:

• ProjectId: $request.path.ProjectId
• TaskId: $request.path.TaskId

The Attachment resource is used to view, create, update, and delete attachments for task progress.

Notes

Operation: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes

Parameters:

• ProjectId: $request.path.ProjectId
• TaskId: $request.path.TaskId

The Note resource is used to view, create, update, and delete notes for task progress.

ResourceProgress

Operation: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress

Parameters:

• ProjectId: $request.path.ProjectId
• TaskId: $request.path.TaskId

The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.

TaskProgressDFF

Operation: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/TaskProgressDFF

Parameters:

• ProjectId: $request.path.ProjectId
• TaskId: $request.path.TaskId

The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

Back to Top

Examples

The following example shows how to update the progress of a specific project task by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projectProgress/300100084467245/child/taskProgress/100100048792697

Example of Request Body

The following example shows the request body to update the progress of a project task with task id 100100048792697 that belongs to the project with the project ID 300100084467245.

{
    "PercentComplete": "15"
             							} 

Example of Response Body

The following example shows the contents of the response body in JSON format, including project progress:

 {
        "ProjectId": 300100084467245,
        "ProjectName": "PJO_PROGRESS_OTBI1",
        "ProjectNumber": "PJO_PROGRESS_OTBI1",
        "SourceApplicationCode": null,
        "SourceProjectReference": null,
        "TaskId": 100100048792697,
        "TaskName": "Schematic Design Phase",
        "TaskNumber": "1.0",
        "ProgressAsOfDate": "2015-05-21",
        "ProgressAsOfPeriod": "May-15",
        "ActualAmountsThroughPeriod": "May-16",
        "ActualAmountsDate": null,
        "PublicationStatus": "DRAFT",
        "CurrentActualAmountsPeriod": null,
        "CurrentActualAmountsDate": null,
        "PlannedStartDate": "2015-01-01",
        "PlannedFinishDate": "2015-03-17",
        "BaselineStartDate": "2015-01-01",
        "BaselineFinishDate": "2015-03-17",
        "EstimatedStartDate": "2015-01-01",
        "EstimatedFinishDate": "2015-03-17",
        "ActualStartDate": "2015-01-01",
        "ActualFinishDate": null,
        "PercentComplete": 15,
        	...
            							}

Back to Top