Jump to

• Request
• Response

Update a revenue milestone

patch

/crmRestApi/resources/11.13.18.05/milestoneTemplates/{TemplateId}/child/revenueMilestones/{EventId}

Request

Path Parameters

• EventId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TemplateId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BillingOffset: number
  The billing offset of the revenue milestone.
• EventId: integer
  The event identifier associated with the revenue milestone.
• EventSource: string
  Maximum Length: 30

  The event source associated with the revenue milestone.
• EventSourceReference: string
  Maximum Length: 120

  The event source reference associated with the revenue milestone.
• EventType: string
  Maximum Length: 30

  Default Value: ORA_OSS_REV

  The event type associated with the revenue milestone.
• MilestoneComment: string
  Maximum Length: 300

  The comment associated with the revenue milestone.
• MilestoneName: string
  Maximum Length: 30

  The name of the revenue milestone.
• MilestoneTemplateId: number
  The template identifier of the revenue milestone.
• Percentage: number
  The percentage of the revenue milestone.

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset of the revenue milestone.",
            "nullable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The event identifier associated with the revenue milestone.",
            "nullable":false
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The event source associated with the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The event source reference associated with the revenue milestone.",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The event type associated with the revenue milestone.",
            "nullable":false,
            "default":"ORA_OSS_REV",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The comment associated with the revenue milestone.",
            "nullable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MilestoneTemplateId":{
            "type":"number",
            "description":"The template identifier of the revenue milestone.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        }
    }
}

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 : milestoneTemplates-revenueMilestones-item-response

Type: object

Show Source

• BillingOffset: number
  The billing offset of the revenue milestone.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the revenue milestone.
• CreationDate: string (date-time)
  Read Only: true

  The date when the revenue milestone was created.
• EventId: integer
  The event identifier associated with the revenue milestone.
• EventSource: string
  Maximum Length: 30

  The event source associated with the revenue milestone.
• EventSourceReference: string
  Maximum Length: 120

  The event source reference associated with the revenue milestone.
• EventType: string
  Maximum Length: 30

  Default Value: ORA_OSS_REV

  The event type associated with the revenue milestone.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the revenue milestone was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the revenue milestone.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the revenue milestone.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneComment: string
  Maximum Length: 300

  The comment associated with the revenue milestone.
• MilestoneName: string
  Maximum Length: 30

  The name of the revenue milestone.
• MilestoneTemplateId: number
  The template identifier of the revenue milestone.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the revenue milestone.
• Percentage: number
  The percentage of the revenue milestone.

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset of the revenue milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the revenue milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the revenue milestone was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The event identifier associated with the revenue milestone.",
            "nullable":false,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The event source associated with the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The event source reference associated with the revenue milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The event type associated with the revenue milestone.",
            "nullable":false,
            "default":"ORA_OSS_REV",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the revenue milestone was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the revenue milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the revenue milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The comment associated with the revenue milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneTemplateId":{
            "type":"number",
            "description":"The template identifier of the revenue milestone.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the revenue milestone.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of the revenue milestone.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

EventTypeLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_MILESTONE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: EventType; Target Attribute: LookupCode
• Display Attribute: Meaning

MilestoneNameLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_MILESTONE_NAME

The following properties are defined on the LOV link relation:

• Source Attribute: MilestoneName; Target Attribute: LookupCode
• Display Attribute: Meaning

MilestoneSourceLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_MILESTONE_SRC

The following properties are defined on the LOV link relation:

• Source Attribute: EventSource; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top