Jump to

• Request
• Response

Update measure details for one new product launch request

patch

/fscmRestApi/resources/11.13.18.05/productLaunchDefinitions/{NpiDefId}/child/npiMeasures/{NpiMeasureId}

Request

Path Parameters

• NpiDefId(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=
• NpiMeasureId(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=

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

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• FactorPct: number
  Percentage factor associated with the measure copy definition.
• NpiDefId: integer
  Unique identifier of the product launch request.
• NpiMeasureId: integer
  Unique identifier of the measure copy definition.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• TargetMeasureId: integer
  Title: Target Measure

  Unique identifier of the target measure.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the measure copy definition.",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false
        },
        "NpiMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure copy definition.",
            "nullable":false
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":false
        },
        "TargetMeasureId":{
            "title":"Target Measure",
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":false
        }
    }
}

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 : productLaunchDefinitions-npiMeasures-item-response

Type: object

Show Source

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure copy definition.
• CreatedDate: string (date-time)
  Read Only: true

  Date when the measure copy definition was created.
• FactorPct: number
  Percentage factor associated with the measure copy definition.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the measure copy definition.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Date when the user last updated the measure copy definition.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the measure copy definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NpiDefId: integer
  Unique identifier of the product launch request.
• NpiMeasureId: integer
  Unique identifier of the measure copy definition.
• SourceMeasure: string
  Read Only: true

  Maximum Length: 255

  Name of the source measure.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• TargetMeasure: string
  Read Only: true

  Maximum Length: 255

  Name of the target measure.
• TargetMeasureId: integer
  Title: Target Measure

  Unique identifier of the target measure.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the measure copy definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDate":{
            "type":"string",
            "description":"Date when the measure copy definition was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the measure copy definition.",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the measure copy definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the measure copy definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the user last updated the measure copy definition.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false,
            "x-queryable":true
        },
        "NpiMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure copy definition.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the target measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetMeasureId":{
            "title":"Target Measure",
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top