REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get a milestone

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone/{MilestoneUniqID}

Request

Path Parameters

LineId(required): integer(int64)

The unique identifier of the contract line.
MilestoneUniqID(required): string

This is the hash key of the attributes which make up the composite key--- MilestoneId and MajorVersion ---for the Milestones resource and used to uniquely identify an instance of Milestones. The client should not generate the hash key value. Instead, the client should query on the Milestones collection resource with a filter on the primary key values in order to navigate to a specific instance of Milestones.

For example: Milestone?q=MilestoneId=<value1>;MajorVersion=<value2>
contractsUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

Metadata-Context: string

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version: string

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

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.

Root Schema : contracts-ContractLine-Milestone-item-response

Type: object

Show Source

ActualFinishDate: string (date)

Title: Actual Finish Date

Read Only: true

The actual finish date of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.
EventDescription: string

Title: Event Description

Maximum Length: 240

The description for the billing event created for the milestone. If you're creating a milestone and don't pass a value for this attribute, the milestone's name is used for the billing event description.
EventId: integer (int64)

Title: Event ID

Read Only: true

The unique identifier of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
EventNumber: integer (int64)

Title: Event Number

Read Only: true

The number of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
EventTypeId: integer (int64)

Title: Event Type ID

The unique identifier of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.
EventTypeName: string

Title: Event Type

Maximum Length: 240

The name of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.
ExceptionFlag: boolean

Title: Exception Flag

Read Only: true

Indicates whether there are exceptions for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.
ExternalReferenceKey: string

Title: External Reference Key

Maximum Length: 150

The external reference key of the milestone.
ExternalSourceKey: string

Title: External Source Key

Maximum Length: 150

The external source key of the milestone.
links: array Links

Title: Links

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

Title: Major Version

The contract major version of the milestone.
MilestoneAmount: number

Title: Milestone Amount

The bill transaction amount for the milestone. Milestone bill transaction amounts must be entered in the contract currency.
MilestoneId: integer (int64)

Title: Milestone ID

The unique identifier of the milestone on the contract line.
MilestoneName: string

Title: Milestone Name

Maximum Length: 255

The name of the milestone. If you're adding an existing project plan milestone to the contract line, this attribute is ignored. Instead, the project plan milestone name is used.
MilestoneStatusCode: string

Title: Milestone Status Code

Read Only: true

Maximum Length: 20

The status code of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.
ParentTaskId: integer (int64)

Title: Parent Task ID

The unique identifier of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
ParentTaskNumber: string

Title: Parent Task Number

Maximum Length: 100

The unique number of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
PlannedFinishDate: string (date)

Title: Planned Finish Date

The expected finish date of the milestone. The planned finish date must be within the effective dates of the milestone's parent in the project plan and the effectivity dates of the contract line. If the milestone is for an Award, then the planned finish date must be on or after the earlier of the preaward date or the contract line start date and on or before the later of the close date or contract line end date. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.
ProjectId: integer (int64)

Title: Project ID

The unique identifier of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.
ProjectNumber: string

Title: Project Number

Maximum Length: 25

The number of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.
ProjectPlanMilestoneId: integer (int64)

Title: Project Plan Milestone ID

The unique identifier of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.
ProjectPlanMilestoneNumber: string

Title: Project Plan Milestone Number

Maximum Length: 100

The unique number of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.
TransactionCurrency: string

Title: Transaction Currency

Maximum Length: 30

The currency code of the bill transaction amount for the milestone. The bill transaction currency must be the same as the contract currency for milestones.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Major Version",
            "type":"integer",
            "description":"The contract major version of the milestone.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"The external reference key of the milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneStatusCode":{
            "title":"Milestone Status Code",
            "maxLength":20,
            "type":"string",
            "description":"The status code of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"The external source key of the milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the milestone on the contract line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "title":"Milestone Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the milestone. If you're adding an existing project plan milestone to the contract line, this attribute is ignored. Instead, the project plan milestone name is used.",
            "nullable":false,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"The number of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"The unique identifier of the project that owns the milestone. The project must have an active association with the contract line. Either ProjectId or ProjectNumber must be passed to create a milestone. If both ProjectId and ProjectNumber are provided, ProjectNumber is used and ProjectId is ignored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectPlanMilestoneId":{
            "title":"Project Plan Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EventTypeId":{
            "title":"Event Type ID",
            "type":"integer",
            "description":"The unique identifier of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionCurrency":{
            "title":"Transaction Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code of the bill transaction amount for the milestone. The bill transaction currency must be the same as the contract currency for milestones.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlannedFinishDate":{
            "title":"Planned Finish Date",
            "type":"string",
            "description":"The expected finish date of the milestone. The planned finish date must be within the effective dates of the milestone's parent in the project plan and the effectivity dates of the contract line. If the milestone is for an Award, then the planned finish date must be on or after the earlier of the preaward date or the contract line start date and on or before the later of the close date or contract line end date. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneAmount":{
            "title":"Milestone Amount",
            "type":"number",
            "description":"The bill transaction amount for the milestone. Milestone bill transaction amounts must be entered in the contract currency.",
            "nullable":false,
            "x-queryable":true
        },
        "ActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"The actual finish date of the milestone in the project plan. This attribute is ignored when creating or updating a milestone on a contract line.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTaskNumber":{
            "title":"Parent Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The unique number of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventNumber":{
            "title":"Event Number",
            "type":"integer",
            "description":"The number of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the billing event created for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventTypeName":{
            "title":"Event Type",
            "maxLength":240,
            "type":"string",
            "description":"The name of the event type of the billing event created for the milestone. Either EventTypeName or EventTypeId must be passed to create a milestone. If both EventTypeName and EventTypeId are provided, EventTypeName is used and EventTypeId is ignored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExceptionFlag":{
            "title":"Exception Flag",
            "type":"boolean",
            "description":"Indicates whether there are exceptions for the milestone. This attribute is ignored when creating or updating a milestone on a contract line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectPlanMilestoneNumber":{
            "title":"Project Plan Milestone Number",
            "maxLength":100,
            "type":"string",
            "description":"The unique number of the milestone in the project plan. To add an existing project plan milestone to the contract line, either the ProjectPlanMilestoneId or ProjectPlanMilestoneNumber attribute must be passed. If both attributes are provided, the ProjectPlanMilestoneNumber is used and ProjectPlanMilestoneId is ignored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParentTaskId":{
            "title":"Parent Task ID",
            "type":"integer",
            "description":"The unique identifier of the project plan parent task under which the milestone is created. The parent task of a milestone must be on or below the level at which the project is associated with the contract line. Either ParentTaskId or ParentTaskNumber must be passed. If both ParentTaskId and ParentTaskNumber are provided, the ParentTaskNumber is used and ParentTaskId is ignored. Leave this attribute blank to create a milestone with the project as the parent. If you're adding an existing project plan milestone to the contract line, this attribute is ignored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description for the billing event created for the milestone. If you're creating a milestone and don't pass a value for this attribute, the milestone's name is used for the billing event description.",
            "nullable":false,
            "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."
        }
    }
}