Get all synchronization details records

get

/fscmRestApi/resources/11.13.18.05/collaborationSynchronizationDetails

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds collaboration synchronization details according to the primary key criteria.
      Finder Variables
      • SyncId; integer; Value that uniquely identifies the synchronization details.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CollectionProcessId; integer; Value that uniquely identifies the running Collection Job Set scheduled process.
    • CollectionRefreshNumber; integer; Number used by the Collection Job Set scheduled process to collect data.
    • CollectionStatus; string; Current state of the collection process.
    • CreatedBy; string; User who created the synchronization request.
    • CreationDate; string; Date and time when the user created the synchronization request.
    • CustomerId; integer; Value that uniquely identifies the collaboration customer.
    • CustomerName; string; Name of the customer.
    • CustomerNumber; string; Number that identifies the customer.
    • CustomerSiteId; string; Value that uniquely identifies the collaboration customer site.
    • CustomerSiteNumber; string; Number that identifies the customer site.
    • DemandMeasure; string; Demand planning measure associated with the sync profile.
    • DemandMeasureId; integer; Value that uniquely identifies the demand planning measure.
    • DemandPlan; string; Name of the demand plan.
    • DemandPlanId; integer; Value that uniquely identifies the demand plan associated with the sync profile.
    • DisplayMeasure; string; Name of the type of displayed measure used for collaboration.
    • DocumentType; string; Type of document used for collaboration.
    • DocumentTypeCode; string; Abbreviation that identifies the type of document used for collaboration.
    • ItemLevelId; integer; Value that uniquely identifies the item level.
    • ItemLevelValue; string; Value of the defined item level of the collaboration customer demand.
    • LastReceiveDate; string; Date and time when the user most recently received the measure data for demand management.
    • LastUpdateDate; string; Date and time when the user most recently updated the synchronization details record.
    • LastUpdatedBy; string; Login of the user who most recently updated the synchronization details record.
    • MeasureTypeCode; string; Abbreviation that identifies the type of measure used for collaboration in a document.
    • OrganizationLevelId; integer; Value that uniquely identifies the organization level.
    • OrganizationLevelValue; string; Value of the defined organization level of the collaboration customer demand.
    • ProcessId; integer; Value that uniquely identifies the receive customer demand scheduled process.
    • ReceiveEditStartDate; string; Date that identifies the measure's first editable time bucket.
    • ReceiveEndDate; string; Date that identifies the measure's last time bucket.
    • ReceiveStartDate; string; Date that identifies the measure's first time bucket.
    • SourceSystemCode; string; Abbreviation that identifies the planning source system associated with the sync profile.
    • SyncId; integer; Value that uniquely identifies the synchronization details.
    • SyncProfile; string; Name of the sync profile.
    • SyncProfileId; integer; Value that uniquely identifies the sync profile.
    • UOMCode; string; Abbreviation that identifies the unit of measure for the item.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationSynchronizationDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get the synchronization details for the last time measure data synchronized for demand management.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationSynchronizationDetails?q=SyncProfile='Forecast plan sync'&onlyData=true"

Example Response Body

The following shows an example of the response body in JSON format.

[   {
    "items": [
        {
            "SyncId": 1001,
            "SyncProfileId": 300100553780562,
            "SyncProfile": "Forecast plan sync",
            "CustomerId": 300100135694203,
            "CustomerNumber": "AegonFitness",
            "CustomerName": "Aegon Fitness",
            "CustomerSiteId": "999990026453997",
            "CustomerSiteNumber": "AegonFitness_SITE_01",
            "ItemLevelId": 989186,
            "ItemLevelValue": "Eliptical Belt",
            "OrganizationLevelId": 52637,
            "OrganizationLevelValue": "SCC:M1",
            "DocumentTypeCode": "VCS_FORECAST",
            "DocumentType": "Forecast",
            "MeasureTypeCode": "ORDER_FORECAST",
            "DisplayMeasure": "Order Forecast",
            "SourceSystemCode": "SCC",
            "DemandPlanId": 300100541068697,
            "DemandPlan": "Demand Plan 1001",
            "DemandMeasureId": 4286,
            "DemandMeasure": "Customer Order Forecast",
            "UOMCode": "Ea",
            "ProcessId": 203832,
            "CollectionProcessId": 203835,
            "CollectionRefreshNumber": 342468,
            "CollectionStatus": "Collection complete",
            "ReceiveStartDate": "2022-05-02",
            "ReceiveEditStartDate": "2022-05-02",
            "ReceiveEndDate": "2023-04-30",
            "LastReceiveDate": "2022-05-03T14:47:06+00:00",
            "CreationDate": "2022-05-03T14:47:06+00:00",
            "CreatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2022-05-03T14:47:06+00:00",
            "LastUpdatedBy": "COLLABPLANNER",
            "@context": {
                "key": "1001"
            }
        },
        {
            "SyncId": 1002,
            "SyncProfileId": 300100553780562,
            "SyncProfile": "Forecast plan sync",
            "CustomerId": 300100135694203,
            "CustomerNumber": "AegonFitness",
            "CustomerName": "Aegon Fitness",
            "CustomerSiteId": "999990026453997",
            "CustomerSiteNumber": "AegonFitness_SITE_01",
            "ItemLevelId": 989186,
            "ItemLevelValue": "Eliptical Belt",
            "OrganizationLevelId": 52636,
            "OrganizationLevelValue": "SCC:M2",
            "DocumentTypeCode": "VCS_FORECAST",
            "DocumentType": "Forecast",
            "MeasureTypeCode": "ORDER_FORECAST",
            "DisplayMeasure": "Order Forecast",
            "SourceSystemCode": "SCC",
            "DemandPlanId": 300100541068697,
            "DemandPlan": "Demand Plan 1001",
            "DemandMeasureId": 4286,
            "DemandMeasure": "Customer Order Forecast",
            "UOMCode": "Ea",
            "ProcessId": 203832,
            "CollectionProcessId": 203835,
            "CollectionRefreshNumber": 342468,
            "CollectionStatus": "Collection complete",
            "ReceiveStartDate": "2022-05-02",
            "ReceiveEditStartDate": "2022-05-02",
            "ReceiveEndDate": "2023-04-30",
            "LastReceiveDate": "2022-05-03T14:47:06+00:00",
            "CreationDate": "2022-05-03T14:47:06+00:00",
            "CreatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2022-05-03T14:47:06+00:00",
            "LastUpdatedBy": "COLLABPLANNER",
            "@context": {
                "key": "1002"
            }
        },
        {
            "SyncId": 1003,
            "SyncProfileId": 300100553780562,
            "SyncProfile": "Forecast plan sync",
            "CustomerId": 300100135694203,
            "CustomerNumber": "AegonFitness",
            "CustomerName": "Aegon Fitness",
            "CustomerSiteId": "999990026453997",
            "CustomerSiteNumber": "Dallas",
            "ItemLevelId": 989186,
            "ItemLevelValue": "Eliptical Belt",
            "OrganizationLevelId": 52635,
            "OrganizationLevelValue": "SCC:M3",
            "DocumentTypeCode": "VCS_FORECAST",
            "DocumentType": "Forecast",
            "MeasureTypeCode": "ORDER_FORECAST",
            "DisplayMeasure": "Order Forecast",
            "SourceSystemCode": "SCC",
            "DemandPlanId": 300100541068697,
            "DemandPlan": "Demand Plan 1001",
            "DemandMeasureId": 4286,
            "DemandMeasure": "Customer Order Forecast",
            "UOMCode": "Ea",
            "ProcessId": 203832,
            "CollectionProcessId": 203835,
            "CollectionRefreshNumber": 342468,
            "CollectionStatus": "Collection complete",
            "ReceiveStartDate": "2022-05-02",
            "ReceiveEditStartDate": "2022-05-02",
            "ReceiveEndDate": "2023-04-30",
            "LastReceiveDate": "2022-05-03T14:47:06+00:00",
            "CreationDate": "2022-05-03T14:47:06+00:00",
            "CreatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2022-05-03T14:47:06+00:00",
            "LastUpdatedBy": "COLLABPLANNER",
            "@context": {
                "key": "1003"
            }
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/collaborationSynchronizationDetails",
            "name": "collaborationSynchronizationDetails",
            "kind": "collection"
        }
    ]
} ]
Back to Top