Close Publication Pattern

Close Publication Pattern

PUT /api/.../publicationpatterns/{id}?action=close&allowClose={false}

Close publication pattern.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the publication pattern.
DtoPubPatternUpdateCloseInfo Close Information Yes Define this parameter in the request body.
action String Yes. Value should be 'close' to close the publication pattern action identifier
allowClose bool Yes Indicator to allow closing the publication pattern if issues/parts have been received with status date later than the end date. Default is false if not specified.
DtoPubPatternUpdateCloseInfo
Property Type Nullable Description
EndDate DateTime No Date by when prediction for pattern or template stops or for a pattern only, gets closed.
Example
application/json, text/json 
 {
 "EndDate": "2022-02-08T14:13:04.051Z"
}

Response Information

True is returned upon success.

Example
application/json, text/json 
true

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid publication pattern ID

Required Permissions

Permission IDs found here.

    CR_AccessSerials_Allow (),
    CR_SerialCopyRecords_Access (based on owner ID),
    CR_SerialCopyRecords_Modify (based on owner ID)