Jump to

• Request
• Response

Update a sync profile

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DemandPlanId: integer (int64)
  Value that uniquely identifies the demand plan associated with the sync profile.
• DocumentTypeCode(required): string
  Maximum Length: 60

  Abbreviation that identifies the type of document used for collaboration.
• measureMappings: array Measure Mappings
  Title: Measure Mappings

  The Measure Mappings resource manages the measure mappings associated with a sync profile.
• notifications: array Notifications
  Title: Notifications

  The Notifications resource manages the notification recipients associated with a sync profile.
• PlanningCalendarId: integer (int64)
  Value that uniquely identifies the planning calendar.
• PlanningTimeLevelId: integer (int64)
  Value that uniquely identifies the collaboration planning time level.
• SourceSystemCode(required): string
  Maximum Length: 30

  Abbreviation that identifies the planning source system associated with the sync profile.
• StatusCode(required): string
  Maximum Length: 30

  Abbreviation that identifies the current state of the sync profile.
• SyncProfile(required): string
  Maximum Length: 80

  Name of the sync profile.

{
    "required":[
        "DocumentTypeCode",
        "SourceSystemCode",
        "StatusCode",
        "SyncProfile"
    ],
    "type":"object",
    "properties":{
        "SyncProfile":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the sync profile.",
            "nullable":false
        },
        "DocumentTypeCode":{
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":false
        },
        "PlanningCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DemandPlanId"
                ]
            }
        },
        "measureMappings":{
            "title":"Measure Mappings",
            "type":"array",
            "description":"The Measure Mappings resource manages the measure mappings associated with a sync profile.",
            "items":{
                "$ref":"#/components/schemas/collaborationSyncProfiles-measureMappings-item-patch-request"
            }
        },
        "SourceSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the planning source system associated with the sync profile.",
            "nullable":false
        },
        "PlanningTimeLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration planning time level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DemandPlanId",
                    "PlanningCalendarId"
                ]
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current state of the sync profile.",
            "nullable":false
        },
        "DemandPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand plan associated with the sync profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SourceSystemCode"
                ]
            }
        },
        "notifications":{
            "title":"Notifications",
            "type":"array",
            "description":"The Notifications resource manages the notification recipients associated with a sync profile.",
            "items":{
                "$ref":"#/components/schemas/collaborationSyncProfiles-notifications-item-patch-request"
            }
        }
    }
}

Nested Schema : Measure Mappings

Type: array

Title: Measure Mappings

The Measure Mappings resource manages the measure mappings associated with a sync profile.

Show Source

• Array of: object collaborationSyncProfiles-measureMappings-item-patch-request

{
    "title":"Measure Mappings",
    "type":"array",
    "description":"The Measure Mappings resource manages the measure mappings associated with a sync profile.",
    "items":{
        "$ref":"#/components/schemas/collaborationSyncProfiles-measureMappings-item-patch-request"
    }
}

Nested Schema : Notifications

Type: array

Title: Notifications

The Notifications resource manages the notification recipients associated with a sync profile.

Show Source

• Array of: object collaborationSyncProfiles-notifications-item-patch-request

{
    "title":"Notifications",
    "type":"array",
    "description":"The Notifications resource manages the notification recipients associated with a sync profile.",
    "items":{
        "$ref":"#/components/schemas/collaborationSyncProfiles-notifications-item-patch-request"
    }
}

Nested Schema : collaborationSyncProfiles-measureMappings-item-patch-request

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.

{
    "type":"object",
    "properties":{
        "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
        }
    }
}

Nested Schema : collaborationSyncProfiles-notifications-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the sync profile.
• DemandPlan: string
  Read Only: true

  Maximum Length: 30

  Name of the demand plan.
• DemandPlanId: integer (int64)
  Value that uniquely identifies the demand plan associated with the sync profile.
• DocumentId: integer
  Read Only: true

  Value that uniquely identifies the document definition.
• DocumentTypeCode: string
  Maximum Length: 60

  Abbreviation that identifies the type of document used for collaboration.
• DocumentTypeName: string
  Read Only: true

  Maximum Length: 255

  Type of document used for collaboration.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the sync profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureMappings: array Measure Mappings
  Title: Measure Mappings

  The Measure Mappings resource manages the measure mappings associated with a sync profile.
• notifications: array Notifications
  Title: Notifications

  The Notifications resource manages the notification recipients associated with a sync profile.
• PlanningCalendar: string
  Read Only: true

  Maximum Length: 240

  Name of the planning calendar.
• PlanningCalendarId: integer (int64)
  Value that uniquely identifies the planning calendar.
• PlanningTimeLevel: string
  Read Only: true

  Maximum Length: 64

  Name of the collaboration planning time level.
• PlanningTimeLevelId: integer (int64)
  Value that uniquely identifies the collaboration planning time level.
• SourceSystemCode: string
  Maximum Length: 30

  Abbreviation that identifies the planning source system associated with the sync profile.
• SourceSystemId: integer
  Read Only: true

  Value that uniquely identifies the source system.
• Status: string
  Read Only: true

  Maximum Length: 80

  Current state of the sync profile.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the current state of the sync profile.
• SyncProfile: string
  Maximum Length: 80

  Name of the sync profile.
• SyncProfileId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sync profile.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Current state of the sync profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the sync profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the sync profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningTimeLevel":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the collaboration planning time level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the sync profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "measureMappings":{
            "title":"Measure Mappings",
            "type":"array",
            "description":"The Measure Mappings resource manages the measure mappings associated with a sync profile.",
            "items":{
                "$ref":"#/components/schemas/collaborationSyncProfiles-measureMappings-item-response"
            }
        },
        "PlanningTimeLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration planning time level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DemandPlanId",
                    "PlanningCalendarId"
                ]
            },
            "x-queryable":true
        },
        "SyncProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sync profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current state of the sync profile.",
            "nullable":false,
            "x-queryable":true
        },
        "DemandPlan":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the demand plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SyncProfile":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the sync profile.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCalendar":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the planning calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DemandPlanId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the planning source system associated with the sync profile.",
            "nullable":false,
            "x-queryable":true
        },
        "DemandPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand plan associated with the sync profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SourceSystemCode"
                ]
            },
            "x-queryable":true
        },
        "notifications":{
            "title":"Notifications",
            "type":"array",
            "description":"The Notifications resource manages the notification recipients associated with a sync profile.",
            "items":{
                "$ref":"#/components/schemas/collaborationSyncProfiles-notifications-item-response"
            }
        },
        "DocumentTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the sync profile.",
            "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 : Measure Mappings

Type: array

Title: Measure Mappings

The Measure Mappings resource manages the measure mappings associated with a sync profile.

Show Source

• Array of: object collaborationSyncProfiles-measureMappings-item-response

{
    "title":"Measure Mappings",
    "type":"array",
    "description":"The Measure Mappings resource manages the measure mappings associated with a sync profile.",
    "items":{
        "$ref":"#/components/schemas/collaborationSyncProfiles-measureMappings-item-response"
    }
}

Nested Schema : Notifications

Type: array

Title: Notifications

The Notifications resource manages the notification recipients associated with a sync profile.

Show Source

• Array of: object collaborationSyncProfiles-notifications-item-response

{
    "title":"Notifications",
    "type":"array",
    "description":"The Notifications resource manages the notification recipients associated with a sync profile.",
    "items":{
        "$ref":"#/components/schemas/collaborationSyncProfiles-notifications-item-response"
    }
}

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

Nested 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 : collaborationSyncProfiles-notifications-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the sync profile notification.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the sync profile notification.
• DisplayName: string
  Read Only: true

  Maximum Length: 240

  Name of the user displayed on the UI.
• Email: string
  Read Only: true

  Maximum Length: 240

  Primary work email of the user.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the sync profile notification.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the sync profile notification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListName: string
  Read Only: true

  Maximum Length: 240

  Listed name of the user.
• NotificationId: integer (int64)
  Value that uniquely identifies the sync profile notification recipient.
• PersonId: integer
  Read Only: true

  Value that uniquely identifies the person associated with the sync profile notification recipient.
• UserName: string
  Maximum Length: 100

  Login of the sync profile notification recipient. This attribute is required.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the sync profile notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the sync profile notification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "maxLength":240,
            "type":"string",
            "description":"Primary work email of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the sync profile notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"Login of the sync profile notification recipient. This attribute is required.",
            "nullable":false,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person associated with the sync profile notification recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sync profile notification recipient.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListName":{
            "maxLength":240,
            "type":"string",
            "description":"Listed name of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the user displayed on the UI.",
            "nullable":true,
            "readOnly":true,
            "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":"Date and time when the user most recently updated the sync profile notification.",
            "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"
    }
}

Links

measureMappings

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

Parameters:

• SyncProfileId: $request.path.SyncProfileId

The Measure Mappings resource manages the measure mappings associated with a sync profile.

notifications

Operation: /fscmRestApi/resources/11.13.18.05/collaborationSyncProfiles/{SyncProfileId}/child/notifications

Parameters:

• SyncProfileId: $request.path.SyncProfileId

The Notifications resource manages the notification recipients associated with a sync profile.

Back to Top