Anchor API

API call to anchor and, if needed, lock activities

Examples in this guide reference code from the APS Web Service Client Sample project that has a web service proxy configured. If you are just getting started with the APS Web Services APIs, please see our client sample.

API Function

The Anchor API is used to anchor activities with the option to also lock them.

API Parameters

The Hold API uses the following 8 parameters:

  • Username (string) - the user's username performing the call
  • Password (string) - the user's related password. An empty string will be used if this parameter is not included in the request.
  • TimeoutDuration (TimeSpan) - the time to wait when trying to connect to Extra Services or attempting to get a data lock. If this parameter is not included in the request, a default value of 30 seconds will be used.
  • ScenarioId (long) - Id of the scenario.
  • PtObjects (PtObjecs[]) - An array of objects that specify the activities that need to be updated.

PtObject contains 4 string parameters-- JobExternalId, MoExternalId, OperationExternalId and ActivityExternalId. If only JobExternalId is specified, all activities within the job are updated. If JobExternalId and MoExternalId, activities within the specific manufacturing order are updated. If the JobExternalId, MoExternalId, and OperationExternalId are specified, only activities for the specified operation are updated. Finally, if all are specified, only one activity is updated.

  • AnchorDate (DateTime) - The anchor date to place on the activity or activities. If not included in the request, the activity will be anchored to the scheduled start date.
  • Anchor (boolean) - Whether to anchor or unanchor.
  • Lock (boolean) - whether to lock or unlock.

API Call

Once the typed Request is created the API call can be made using the following format:

//Sending a request
ApsWebServiceResponseBase resp = client.Anchor(anchorRequest);

API Request

This API request inherits from ApsWebServiceActionRequest. Check out our KB article on the API Request Base classes to learn more: Basic API Structure

To use the API you must create a typed Request using the Request Data Contract. The related web client will use this Request to trigger the process.

  • Data Contract
public class AnchorRequest : ApsWebServiceActionRequest
[DataMember(IsRequired = false)]
public DateTime AnchorDate { get; set; } = PTDateTime.MinDateTime;

[DataMember(IsRequired = false)]
public bool Lock { get; set; } = true;

[DataMember(IsRequired = false)]
public bool Anchor { get; set; } = true;

      API Request  Example

      //Create an Optimize request
      APSWebServiceRef.AnchorRequest anchorRequest = new AnchorRequest() {
      AnchorDate = DateTime.Now,
      Anchor= true,
      Lock = true

      //Request Base
      anchorRequest.UserName = username;
      anchorRequest.Password = pwd;
      anchorRequest.TimeoutDuration = TimeSpan.FromMinutes(5);

      //Scenario Request
      anchorRequest.ScenarioId = long.MinValue;

      //Action Request
      List<PtObjectId> objectIds = new List<PtObjectId>();
      objectIds.Add(new PtObjectId() {JobExternalId = "job1", MoExternalId = "MO010", OperationExternalId = "Op010", ActivityExternalId = "PT00001" });

      anchorRequest.PtObjects = objectIds.ToArray();

      API Response

      All API calls return a Response object to help determine the result of the call. Check out our Basic API Structure KB article for more information.

      Response Example

      //Sending a request
      start = DateTime.Now;
      ApsWebServiceResponseBase resp = client.Anchor(anchorRequest);
      Console.WriteLine($"Response received after '{DateTime.Now.Subtract(start)}'");

      //Display results
      if (!a_response.Exception)
      Trace($"Completed with Zero Errors");
      Trace($"Completed with Errors");