Jump to

• Request
• Response

Create measure mappings

post

/fscmRestApi/resources/11.13.18.05/collaborationSyncProfiles/{SyncProfileId}/child/measureMappings

Request

Path Parameters

• SyncProfileId(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:
  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

• DemandMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the demand planning measure associated with the sync profile.
• DocumentMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the measure used for collaboration.
• MeasureMappingId: integer (int64)
  Value that uniquely identifies the sync profile measure mapping.

{
    "type":"object",
    "properties":{
        "MeasureMappingId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sync profile measure mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the measure used for collaboration.",
            "nullable":false
        },
        "DemandMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the demand planning measure associated with the sync profile.",
            "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(required):
  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(required):
  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 : collaborationSyncProfiles-measureMappings-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure mapping.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the measure mapping.
• DemandMeasure: string
  Read Only: true

  Maximum Length: 255

  Demand planning measure associated with the sync profile.
• DemandMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the demand planning measure associated with the sync profile.
• DemandMeasureId: integer
  Read Only: true

  Value that uniquely identifies the demand planning measure.
• DocumentMeasure: string
  Read Only: true

  Maximum Length: 255

  Measure used for collaboration.
• DocumentMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the measure used for collaboration.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the measure mapping.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the measure mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureMappingId: integer (int64)
  Value that uniquely identifies the sync profile measure mapping.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the measure mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the measure used for collaboration.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the measure mapping.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the measure mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Demand planning measure associated with the sync profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureMappingId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sync profile measure mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DemandMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the demand planning measure associated with the sync profile.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Measure used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand planning measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the measure mapping.",
            "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