Jump to

• Request
• Response

Create an award project task burden schedule

post

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardProjectId(required): integer(int64)
  Unique identifier of the award project.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  Unique identifier of the award.
• AwardProjectScheduleId: integer (int64)
  Title: Award Project Schedule ID

  Unique identifier of the project schedule
• BurdenScheduleFixedDate: string (date)
  Title: Fixed Date

  Fixed date of the burden schedule
• BurdenScheduleId: integer (int64)
  Title: Burden Schedule ID

  The unique identifier of the burden schedule specified at the project or project task of an award.
• BurdenScheduleName: string
  Title: Burden Schedule

  Maximum Length: 30

  Name of the burden schedule
• ProjectId: integer (int64)
  Title: Project ID

  Unique identifier of the project.
• TaskId: integer (int64)
  Title: Task ID

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

  Maximum Length: 255

  Name of the task to which the funding is allocated.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task to which the funding is allocated.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the  task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BurdenScheduleName":{
            "title":"Burden Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the burden schedule",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task to which the funding is allocated.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task to which the funding is allocated.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AwardProjectScheduleId":{
            "title":"Award Project Schedule ID",
            "type":"integer",
            "description":"Unique identifier of the project schedule",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BurdenScheduleFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"Fixed date of the burden schedule",
            "format":"date",
            "nullable":true
        },
        "BurdenScheduleId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the burden schedule specified at the project or project task of an award.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : awards-AwardProject-AwardProjectTaskBurdenSchedule-item-response

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  Unique identifier of the award.
• AwardProjectScheduleId: integer (int64)
  Title: Award Project Schedule ID

  Unique identifier of the project schedule
• BurdenScheduleFixedDate: string (date)
  Title: Fixed Date

  Fixed date of the burden schedule
• BurdenScheduleId: integer (int64)
  Title: Burden Schedule ID

  The unique identifier of the burden schedule specified at the project or project task of an award.
• BurdenScheduleName: string
  Title: Burden Schedule

  Maximum Length: 30

  Name of the burden schedule
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the award project burden schedule
• CreationDate: string (date-time)
  Read Only: true

  The date when the award project burden schedule was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the award project burden schedule was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the award project burden schedule.
• links: array Links
  Title: Links

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

  Unique identifier of the project.
• TaskId: integer (int64)
  Title: Task ID

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

  Maximum Length: 255

  Name of the task to which the funding is allocated.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task to which the funding is allocated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award project burden schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award project burden schedule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award project burden schedule",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the  task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task to which the funding is allocated.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AwardProjectScheduleId":{
            "title":"Award Project Schedule ID",
            "type":"integer",
            "description":"Unique identifier of the project schedule",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BurdenScheduleFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"Fixed date of the burden schedule",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenScheduleId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the burden schedule specified at the project or project task of an award.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BurdenScheduleName":{
            "title":"Burden Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the burden schedule",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task to which the funding is allocated.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award project burden schedule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top