Jump to

• Request
• Response

Get one synchronization details record

get

/fscmRestApi/resources/11.13.18.05/collaborationSynchronizationDetails/{SyncId}

Request

Path Parameters

• SyncId(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=

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:
  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.

There's no request body for this operation.

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

Type: object

Show Source

• CollectionProcessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the running Collection Job Set scheduled process.
• CollectionRefreshNumber: integer (int64)
  Read Only: true

  Number used by the Collection Job Set scheduled process to collect data.
• CollectionStatus: string
  Read Only: true

  Maximum Length: 80

  Current state of the collection process.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the synchronization request.
• CustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration customer.
• CustomerName: string
  Read Only: true

  Maximum Length: 360

  Name of the customer.
• CustomerNumber: string
  Read Only: true

  Maximum Length: 360

  Number that identifies the customer.
• CustomerSiteId: string
  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the collaboration customer site.
• CustomerSiteNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the customer site.
• DemandMeasure: string
  Read Only: true

  Maximum Length: 250

  Demand planning measure associated with the sync profile.
• DemandMeasureId: integer (int64)
  Read Only: true

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

  Maximum Length: 30

  Name of the demand plan.
• DemandPlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand plan associated with the sync profile.
• DisplayMeasure: string
  Read Only: true

  Maximum Length: 80

  Name of the type of displayed measure used for collaboration.
• DocumentType: string
  Read Only: true

  Maximum Length: 80

  Type of document used for collaboration.
• DocumentTypeCode: string
  Read Only: true

  Maximum Length: 60

  Abbreviation that identifies the type of document used for collaboration.
• ItemLevelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item level.
• ItemLevelValue: string
  Read Only: true

  Maximum Length: 300

  Value of the defined item level of the collaboration customer demand.
• LastReceiveDate: string (date-time)
  Read Only: true

  Date and time when the user most recently received the measure data for demand management.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the synchronization details record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login of the user who most recently updated the synchronization details record.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Abbreviation that identifies the type of measure used for collaboration in a document.
• OrganizationLevelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization level.
• OrganizationLevelValue: string
  Read Only: true

  Maximum Length: 49

  Value of the defined organization level of the collaboration customer demand.
• ProcessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receive customer demand scheduled process.
• ReceiveEditStartDate: string (date)
  Read Only: true

  Date that identifies the measure's first editable time bucket.
• ReceiveEndDate: string (date)
  Read Only: true

  Date that identifies the measure's last time bucket.
• ReceiveStartDate: string (date)
  Read Only: true

  Date that identifies the measure's first time bucket.
• SourceSystemCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the planning source system associated with the sync profile.
• SyncId: integer (int64)
  Read Only: true

  Value that uniquely identifies the synchronization details.
• SyncProfile: string
  Read Only: true

  Maximum Length: 80

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

  Value that uniquely identifies the sync profile.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the synchronization request.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SyncId":{
            "type":"integer",
            "description":"Value that uniquely identifies the synchronization details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of measure used for collaboration in a document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SyncProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sync profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollectionProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the running Collection Job Set scheduled process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand planning measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandPlan":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the demand plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReceiveDate":{
            "type":"string",
            "description":"Date and time when the user most recently received the measure data for demand management.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "maxLength":360,
            "type":"string",
            "description":"Number that identifies the customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectionRefreshNumber":{
            "type":"integer",
            "description":"Number used by the Collection Job Set scheduled process to collect data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemLevelValue":{
            "maxLength":300,
            "type":"string",
            "description":"Value of the defined item level of the collaboration customer demand.",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollectionStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Current state of the collection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayMeasure":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of displayed measure used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand plan associated with the sync profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Login of the user who most recently updated the synchronization details record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the synchronization request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandMeasure":{
            "maxLength":250,
            "type":"string",
            "description":"Demand planning measure associated with the sync profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiveEndDate":{
            "type":"string",
            "description":"Date that identifies the measure's last time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration customer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiveStartDate":{
            "type":"string",
            "description":"Date that identifies the measure's first time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SyncProfile":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the sync profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the collaboration customer site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the planning source system associated with the sync profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelValue":{
            "maxLength":49,
            "type":"string",
            "description":"Value of the defined organization level of the collaboration customer demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receive customer demand scheduled process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiveEditStartDate":{
            "type":"string",
            "description":"Date that identifies the measure's first editable time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the synchronization details record.",
            "format":"date-time",
            "nullable":true,
            "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