Lock API

API call to lock or unlock activities

Examples in this guide reference code from the APS Web Service Client Sample project with 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 Lock API is used to lock or unlock activities.

API Parameters

The Lock API uses the following 6 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 getting 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 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. Suppose 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.

  • 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.Lock(lockRequest);

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 LockRequest : ApsWebServiceActionRequest
[DataMember(IsRequired = false)]
public bool Lock { get; set; } = true;

      API Request  Example

      //Create an Optimize request
      APSWebServiceRef.LockRequest lockRequest = new LockRequest() {
      Lock = true

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

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

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

      lockRequest.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.Lock(lockRequest);
      Console.WriteLine($"Response received after '{DateTime.Now.Subtract(start)}'");

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