Centric 8 REST API

DEVELOPER GUIDE

Available in
C8 V7.6
December, 2022

i

Centric Software, Inc.
655 Campbell Technology Parkway,
Suite 200, Campbell
CA 95008
Ph. No.: 1.408.574.7802
Technical Support:
866. 796-6218 8:00 AM-8:00 PM EST
Email: support@centricsoftware.com
Documentation Feedback:
Email: documentation@centricsoftware.com
Copyrights
Centric 8 REST API DEVELOPER GUIDE
Copyright © 2022 Centric Software. All rights reserved. Under
the copyright laws, neither the documentation nor the software
may be copied, photocopied, reproduced, translated, or reduced
to any electronic medium or machine-readable form, in whole or
in part, without the prior written consent of Centric Software,
Inc., except in the manner described in the documentation.
Centric Software™, Centric 8™, and Centric 8 for Fashion & Soft
Goods™ are trademarks or registered trademarks of Centric
Software, Inc. Microsoft, Internet Explorer, and Outlook are
trademarks or registered trademarks of Microsoft Corporation in
the United States and/or other countries. Other product or
company names mentioned herein may be trademarks of their
respective owners.
ii
 Centric 8 REST API DEVELOPER GUIDE

TABLE OF CONTENTS
TABLE OF CONTENTS ............................................................................................................................. 3
REST API Technical Support............................................................................................................. 44
1. API USAGE GUIDELINE .................................................................................................................... 45
2. CENTRIC 8 REST API ........................................................................................................................ 49
What is the Centric 8 REST API? ...................................................................................................... 49
How to access the C8 REST API ....................................................................................................... 50
What is a Centric 8 REST URI? ......................................................................................................... 50
URI SYNTAX ................................................................................................................................................................................. 51
VERSION NAMING CONVENTION .............................................................................................................................................. 51
ENDPOINT EXAMPLES ................................................................................................................................................................ 52
Centric Custom Views................................................................................................................................................................. 52
3. LIMITATIONS .................................................................................................................................. 53
4. REST ENDPOINT DETAILS ................................................................................................................ 54
HTTP Request and Response Bodies in the C8 REST API ......................................................................................................... 54
Optional “link” header parameter for the ref objects ............................................................................................................. 55
Monitoring REST API performance via Response Header profile parameters ....................................................................... 55
Custom View alternatives to REST endpoint formats .............................................................................................................. 56
Authenticating Using REST API........................................................................................................ 57
Fine-Tuning Queries in the C8 REST API ........................................................................................... 58
Passing Specific Extra Data in the Query................................................................................................................................... 58
URL (Query) Parameter .............................................................................................................................................................. 59
List of valid URL (Query) parameters ........................................................................................................................................ 60
Encoding Data ............................................................................................................................................................................. 63
API Header(s) .............................................................................................................................................................................. 66
Custom Expression Validation in REST API ....................................................................................... 66
Authenticating to the Centric 8 Server ............................................................................................ 67
Configuring the Centric Server for REST........................................................................................... 68
Centric Server Configuration ..................................................................................................................................................... 68
Custom Attribute Configuration ................................................................................................................................................ 68
Wild-Card Search ............................................................................................................................ 70
REST API Log................................................................................................................................... 71
How to log API execution time .................................................................................................................................................. 72
How to enable Splunk and LaaS compatible log ...................................................................................................................... 73
Log levels in keyvalue format .................................................................................................................................................... 73
REST Interaction with Centric FileVault ........................................................................................... 74
Filevault ....................................................................................................................................................................................... 74
Concept of Document Revision ................................................................................................................................................. 74
Running Same Validation Rules for REST and UI Calls ...................................................................... 75
5. DOMAIN-ASSET RELATED APIS ........................................................................................................ 77
AcceptanceLimit ............................................................................................................................. 77
Creating AcceptanceLimit .......................................................................................................................................................... 77
Reading AcceptanceLimit ........................................................................................................................................................... 77
Updating AcceptanceLimit ......................................................................................................................................................... 77
Deleting AcceptanceLimit .......................................................................................................................................................... 77
Attribute List of AcceptanceLimit .............................................................................................................................................. 78

TABLE OF CONTENTS 3
 Centric 8 REST API DEVELOPER GUIDE

AffectedItem .................................................................................................................................. 79
Creating AffectedItem ................................................................................................................................................................ 79
Reading AffectedItem................................................................................................................................................................. 79
Updating AffectedItem............................................................................................................................................................... 79
Deleting AffectedItem ................................................................................................................................................................ 79
Attribute Summary ..................................................................................................................................................................... 80
AffectedSpec .................................................................................................................................. 81
Creating AffectedSpec ................................................................................................................................................................ 81
Reading AffectedSpec ................................................................................................................................................................ 81
Updating AffectedSpec............................................................................................................................................................... 81
Deleting AffectedSpec ................................................................................................................................................................ 81
Attribute Summary ..................................................................................................................................................................... 82
ApparelBOM................................................................................................................................... 84
Creating ApparelBOM ................................................................................................................................................................ 84
Reading ApparelBOM ................................................................................................................................................................. 84
Updating ApparelBOM ............................................................................................................................................................... 84
Deleting ApparelBOM ................................................................................................................................................................ 84
Attribute List of ApparelBOM .................................................................................................................................................... 85
ApparelBOMRevision ...................................................................................................................... 86
Creating ApparelBOMRevision .................................................................................................................................................. 86
Reading ApparelBOMRevision ................................................................................................................................................... 86
Updating ApparelBOMRevision ................................................................................................................................................. 86
DELETE unsupported .................................................................................................................................................................. 86
Attribute List of ApparelBOMRevision ...................................................................................................................................... 87
ApparelBOMSubtype ...................................................................................................................... 88
Creating ApparelBOMSubtype................................................................................................................................................... 88
Reading ApparelBOMSubtype ................................................................................................................................................... 88
Updating ApparelBOMSubtype ................................................................................................................................................. 88
Deleting ApparelBOMSubtype................................................................................................................................................... 88
Attribute List of ApparelBOMSubtype ...................................................................................................................................... 89
ApparelDimension .......................................................................................................................... 90
Creating ApparelDimension ....................................................................................................................................................... 90
Reading ApparelDimension........................................................................................................................................................ 90
Updating ApparelDimension...................................................................................................................................................... 90
Deleting ApparelDimension ....................................................................................................................................................... 90
Attribute List of ApparelDimension........................................................................................................................................... 91
Artwork .......................................................................................................................................... 92
Creating Artwork ........................................................................................................................................................................ 92
Reading Artwork ......................................................................................................................................................................... 92
Updating Artwork ....................................................................................................................................................................... 92
Deleting Artwork......................................................................................................................................................................... 92
Attribute List of Artwork ............................................................................................................................................................ 93
ArtworkRevision ............................................................................................................................. 94
Creating ArtworkRevision .......................................................................................................................................................... 94
Reading ArtworkRevision ........................................................................................................................................................... 94
Updating ArtworkRevision ......................................................................................................................................................... 94
DELETE unsupported .................................................................................................................................................................. 94
Attribute List of ArtworkRevision .............................................................................................................................................. 95
AuthenticationType ........................................................................................................................ 96
Reading AuthenticationType ..................................................................................................................................................... 96
Method: POST, PUT & DELETE are unsupported...................................................................................................................... 96
Attribute List of authentication_types ...................................................................................................................................... 96

TABLE OF CONTENTS 4
 Centric 8 REST API DEVELOPER GUIDE

Avatar ............................................................................................................................................ 97
Creating Avatar ........................................................................................................................................................................... 97
Reading Avatar............................................................................................................................................................................ 97
Updating Avatar .......................................................................................................................................................................... 97
Deleting Avatar ........................................................................................................................................................................... 97
Attribute Summary ..................................................................................................................................................................... 98
AvatarLibrary ................................................................................................................................. 99
Creating AvatarLibrary ............................................................................................................................................................... 99
Reading AvatarLibrary ................................................................................................................................................................ 99
Updating AvatarLibrary .............................................................................................................................................................. 99
Deleting AvatarLibrary ............................................................................................................................................................... 99
Attribute Summary ................................................................................................................................................................... 100
BOMSectionDefinition .................................................................................................................. 101
Creating BOMSectionDefinition .............................................................................................................................................. 101
Reading BOMSectionDefinition ............................................................................................................................................... 101
Updating BOMSectionDefinition ............................................................................................................................................. 101
Deleting BOMSectionDefinition .............................................................................................................................................. 101
Attribute List of BOMSectionDefinition .................................................................................................................................. 102
BOMSupplierAttributes................................................................................................................. 103
Reading BOMSupplierAttributes ............................................................................................................................................. 103
Updating BOMSupplierAttributes ........................................................................................................................................... 103
Deleting BOMSupplierAttributes ............................................................................................................................................. 103
Method:POST unsupported ..................................................................................................................................................... 103
Attribute List of BOMSupplierAttributes ................................................................................................................................ 104
BusinessObject ............................................................................................................................. 105
Reading BusinessObject ........................................................................................................................................................... 105
Attribute Summary ................................................................................................................................................................... 105
CalendarTrackingType .................................................................................................................. 106
Reading CalendarTrackingType ............................................................................................................................................... 106
Attribute Summary ................................................................................................................................................................... 106
CamundaGlobal............................................................................................................................ 107
Reading CamundaGlobal .......................................................................................................................................................... 107
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 107
Attribute List of CamundaGlobal ............................................................................................................................................. 108
CamundaProcessDefinition ........................................................................................................... 109
Reading CamundaProcessDefinition ....................................................................................................................................... 109
POST, PUT & DELETE unsupported .......................................................................................................................................... 109
Attribute List of CamundaProcessDefinition .......................................................................................................................... 110
CamundaProcessDefinitionRevision .............................................................................................. 111
Reading CamundaProcessDefinitionRevision ......................................................................................................................... 111
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 111
Attribute List of CamundaProcessDefinitionRevision ............................................................................................................ 112
CamundaProcessInstance ............................................................................................................. 113
Reading CamundaProcessInstance.......................................................................................................................................... 113
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 113
Attribute List of CamundaProcessInstance............................................................................................................................. 114
CamundaTask............................................................................................................................... 116
Reading CamundaTask ............................................................................................................................................................. 116
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 116
Attribute List of CamundaTask ................................................................................................................................................ 117
CamundaTaskDefinition................................................................................................................ 120
Reading CamundaTaskDefinition ............................................................................................................................................ 120

TABLE OF CONTENTS 5
 Centric 8 REST API DEVELOPER GUIDE

Method: POST, PUT & DELETE unsupported .......................................................................................................................... 120

Attribute List of CamundaTaskDefinition................................................................................................................................ 121
CanvasTemplate ........................................................................................................................... 122
Creating CanvasTemplate ........................................................................................................................................................ 122
Reading CanvasTemplate ......................................................................................................................................................... 122
Updating CanvasTemplate ....................................................................................................................................................... 122
Deleting CanvasTemplate ........................................................................................................................................................ 122
Attribute List of CanvasTemplate ............................................................................................................................................ 123
CareAndComposition .................................................................................................................... 125
Creating CareAndComposition ................................................................................................................................................ 125
Reading CareAndComposition ................................................................................................................................................. 125
Updating CareAndComposition ............................................................................................................................................... 125
Deleting CareAndComposition ................................................................................................................................................ 125
Attribute List of CareAndComposition .................................................................................................................................... 126
CareAndCompositionRevision ....................................................................................................... 127
Creating CareAndCompositionRevision .................................................................................................................................. 127
Reading CareAndCompositionRevision ................................................................................................................................... 127
Updating CareAndCompositionRevision ................................................................................................................................. 127
Method: DELETE unsupported ................................................................................................................................................ 127
Attribute List of CareAndCompositionRevision ...................................................................................................................... 128
CareSymbol .................................................................................................................................. 129
Creating CareSymbol ................................................................................................................................................................ 129
Reading CareSymbol................................................................................................................................................................. 129
Updating CareSymbol ............................................................................................................................................................... 129
Deleting CareSymbol ................................................................................................................................................................ 129
Attribute List of CareSymbol.................................................................................................................................................... 130
Category1..................................................................................................................................... 131
Creating Category1 ................................................................................................................................................................... 131
Reading Category1.................................................................................................................................................................... 131
Updating Category1.................................................................................................................................................................. 131
Deleting Category1 ................................................................................................................................................................... 131
Attribute List of Category1....................................................................................................................................................... 132
Category2..................................................................................................................................... 133
Creating Category2 ................................................................................................................................................................... 133
Reading Category2.................................................................................................................................................................... 133
Updating Category2.................................................................................................................................................................. 133
Deleting Category2 ................................................................................................................................................................... 133
Attribute List of Category2....................................................................................................................................................... 134
ClaimItem..................................................................................................................................... 135
Creating ClaimItem ................................................................................................................................................................... 135
Reading ClaimItem.................................................................................................................................................................... 135
Updating ClaimItem.................................................................................................................................................................. 135
Deleting ClaimItem ................................................................................................................................................................... 135
Attribute Summary ................................................................................................................................................................... 136
Classifier0 ..................................................................................................................................... 137
Creating Classifier0 ................................................................................................................................................................... 137
Reading Classifier0.................................................................................................................................................................... 137
Updating Classifier0.................................................................................................................................................................. 137
Deleting Classifier0 ................................................................................................................................................................... 137
Attribute List of Classifier0 ....................................................................................................................................................... 138
Classifier1 ..................................................................................................................................... 139
Creating Classifier1 ................................................................................................................................................................... 139

TABLE OF CONTENTS 6
 Centric 8 REST API DEVELOPER GUIDE

Reading Classifier1.................................................................................................................................................................... 139

Updating Classifier1.................................................................................................................................................................. 139
Deleting Classifier1 ................................................................................................................................................................... 139
Attribute List of Classifier1 ....................................................................................................................................................... 140
Classifier2 ..................................................................................................................................... 141
Creating Classifier2 ................................................................................................................................................................... 141
Reading Classifier2.................................................................................................................................................................... 141
Updating Classifier2.................................................................................................................................................................. 141
Deleting Classifier2 ................................................................................................................................................................... 141
Attribute List of Classifier2 ....................................................................................................................................................... 142
Classifier3 ..................................................................................................................................... 143
Creating Classifier3 ................................................................................................................................................................... 143
Reading Classifier3.................................................................................................................................................................... 143
Updating Classifier3.................................................................................................................................................................. 143
Deleting Classifier3 ................................................................................................................................................................... 143
Attribute List of Classifier3 ....................................................................................................................................................... 144
Collection ..................................................................................................................................... 145
Creating Collection ................................................................................................................................................................... 145
Reading Collection .................................................................................................................................................................... 145
Updating Collection .................................................................................................................................................................. 145
Deleting Collection ................................................................................................................................................................... 145
Attribute List of Collection ....................................................................................................................................................... 146
ColorColorwayContext .................................................................................................................. 147
Creating ColorColorwayContext .............................................................................................................................................. 147
Reading ColorColorwayContext ............................................................................................................................................... 147
Updating ColorColorwayContext ............................................................................................................................................. 147
Deleting ColorColorwayContext .............................................................................................................................................. 147
Attribute List of ColorColorwayContext .................................................................................................................................. 148
ColorDataSheet ............................................................................................................................ 149
Creating ColorDataSheet.......................................................................................................................................................... 149
Reading ColorDataSheet .......................................................................................................................................................... 149
Updating ColorDataSheet ........................................................................................................................................................ 149
Deleting ColorDataSheet .......................................................................................................................................................... 149
Attribute List of ColorDataSheet ............................................................................................................................................. 150
ColorDataSheetRevision................................................................................................................ 151
Creating ColorDataSheetRevision ........................................................................................................................................... 151
Reading ColorDataSheetRevision ............................................................................................................................................ 151
Updating ColorDataSheetRevision .......................................................................................................................................... 151
Method: DELETE unsupported ................................................................................................................................................ 151
Attribute List of ColorDataSheetRevision ............................................................................................................................... 152
ColoInPalette ................................................................................................................................ 153
Creating ColorInPalette ............................................................................................................................................................ 153
Reading ColorInPalette............................................................................................................................................................. 153
Updating ColorInPalette........................................................................................................................................................... 154
Deleting ColorInPalette ............................................................................................................................................................ 154
Attribute Summary ................................................................................................................................................................... 154
ColorMaterial ............................................................................................................................... 156
Creating ColorMaterial ............................................................................................................................................................. 156
Reading ColorMaterial ............................................................................................................................................................. 156
Updating ColorMaterial............................................................................................................................................................ 156
Deleting ColorMaterial ............................................................................................................................................................. 156
Attribute List of ColorMaterial................................................................................................................................................. 157

TABLE OF CONTENTS 7
 Centric 8 REST API DEVELOPER GUIDE

ColorPalette ................................................................................................................................. 158

Creating ColorPalette ............................................................................................................................................................... 158
Reading ColorPalette ................................................................................................................................................................ 158
Updating ColorPalette .............................................................................................................................................................. 158
Deleting ColorPalette ............................................................................................................................................................... 158
Attribute Summary ................................................................................................................................................................... 159
ColorSpecification ......................................................................................................................... 160
Creating ColorSpecification...................................................................................................................................................... 160
Reading ColorSpecification ...................................................................................................................................................... 160
Updating ColorSpecification .................................................................................................................................................... 160
Deleting ColorSpecification...................................................................................................................................................... 160
Attribute List of ColorSpecification ......................................................................................................................................... 161
Colorway ...................................................................................................................................... 162
Creating Colorway .................................................................................................................................................................... 162
Reading Colorway ..................................................................................................................................................................... 162
Updating Colorway ................................................................................................................................................................... 162
Deleting Colorway .................................................................................................................................................................... 162
Attribute List of Colorway ........................................................................................................................................................ 163
Comment ..................................................................................................................................... 164
Creating Comment.................................................................................................................................................................... 164
Reading Comment .................................................................................................................................................................... 164
Updating Comment .................................................................................................................................................................. 164
Deleting Comment.................................................................................................................................................................... 164
Attribute List of Comment ....................................................................................................................................................... 165
CommentReply ............................................................................................................................. 166
Creating CommentReply .......................................................................................................................................................... 166
Reading CommentReply ........................................................................................................................................................... 166
Updating CommentReply ......................................................................................................................................................... 166
Deleting CommentReply .......................................................................................................................................................... 166
Attribute List of CommentReply .............................................................................................................................................. 167
CompetitiveFood .......................................................................................................................... 168
Creating CompetitiveFood ....................................................................................................................................................... 168
Reading CompetitiveFood ........................................................................................................................................................ 168
Updating CompetitiveFood ...................................................................................................................................................... 168
Deleting CompetitiveFood ....................................................................................................................................................... 168
Attribute Summary ................................................................................................................................................................... 169
CompanyInfo ................................................................................................................................ 170
Reading CompanyInfo .............................................................................................................................................................. 170
Updating CompanyInfo ............................................................................................................................................................ 170
Method: POST & DELETE unsupported ................................................................................................................................... 170
Attribute List of CompanyInfo ................................................................................................................................................. 171
Composition ................................................................................................................................. 172
Creating Composition ............................................................................................................................................................... 172
Reading Composition ............................................................................................................................................................... 172
Updating Composition ............................................................................................................................................................. 172
Deleting Composition ............................................................................................................................................................... 172
Attribute List of Composition .................................................................................................................................................. 173
CompositionPlacement ................................................................................................................. 174
Creating CompositionPlacement ............................................................................................................................................. 174
Reading CompositionPlacement ............................................................................................................................................. 174
Updating CompositionPlacement............................................................................................................................................ 174
Deleting CompositionPlacement ............................................................................................................................................. 174

TABLE OF CONTENTS 8
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CompositionPlacement................................................................................................................................. 175

ConfigurableAttribute ................................................................................................................... 176
Creating ConfigurableAttribute ............................................................................................................................................... 176
Reading ConfigurableAttribute ................................................................................................................................................ 176
Updating ConfigurableAttribute .............................................................................................................................................. 176
Deleting ConfigurableAttribute ............................................................................................................................................... 176
Attribute Summary ................................................................................................................................................................... 177
Contact......................................................................................................................................... 178
Creating Contact ....................................................................................................................................................................... 178
Reading Contact ........................................................................................................................................................................ 179
Updating Contact ...................................................................................................................................................................... 180
Deleting Contact ....................................................................................................................................................................... 180
Attribute List of Contact ........................................................................................................................................................... 181
ContractualDocument .................................................................................................................. 182
Creating ContractualDocument ............................................................................................................................................... 182
Reading ContractualDocument ............................................................................................................................................... 182
Updating ContractualDocument ............................................................................................................................................. 182
Deleting ContractualDocument ............................................................................................................................................... 182
Attribute List of ContractualDocument .................................................................................................................................. 183
ContractualDocumentGroup ......................................................................................................... 184
Creating ContractualDocumentGroup .................................................................................................................................... 184
Reading ContractualDocumentGroup ..................................................................................................................................... 184
Updating ContractualDocumentGroup ................................................................................................................................... 184
Deleting ContractualDocumentGroup .................................................................................................................................... 184
Attribute List of ContractualDocumentGroup ........................................................................................................................ 185
ContractualDocumentPackage ..................................................................................................... 186
Creating ContractualDocumentPackage ................................................................................................................................. 186
Reading ContractualDocumentPackage.................................................................................................................................. 186
Updating ContractualDocumentPackage................................................................................................................................ 186
Deleting ContractualDocumentPackage ................................................................................................................................. 186
Attribute List of ContractualDocumentPackage..................................................................................................................... 187
ContractualDocumentRevision...................................................................................................... 188
Creating ContractualDocumentRevision................................................................................................................................. 188
Reading ContractualDocumentRevision ................................................................................................................................. 188
Updating ContractualDocumentRevision ............................................................................................................................... 188
Method: DELETE unsupported ................................................................................................................................................ 188
Attribute List of ContractualDocumentRevision .................................................................................................................... 189
ContractualDocumentSubtype ...................................................................................................... 190
Creating ContractualDocumentSubtype ................................................................................................................................. 190
Reading ContractualDocumentSubtype.................................................................................................................................. 190
Updating ContractualDocumentSubtype................................................................................................................................ 190
Deleting ContractualDocumentSubtype ................................................................................................................................. 190
Attribute List of ContractualDocumentSubtype..................................................................................................................... 191
CostMaterial ................................................................................................................................ 192
Creating CostMaterial .............................................................................................................................................................. 192
Reading CostMaterial ............................................................................................................................................................... 192
Updating CostMaterial ............................................................................................................................................................. 192
Deleting CostMaterial .............................................................................................................................................................. 192
Attribute list of CostMaterial ................................................................................................................................................... 193
CostRoutingGroup ........................................................................................................................ 194
Reading CostRoutingGroup...................................................................................................................................................... 194
Updating CostRoutingGroup .................................................................................................................................................... 194

TABLE OF CONTENTS 9
 Centric 8 REST API DEVELOPER GUIDE

Method: POST and DELETE unsupported ............................................................................................................................... 194

Attribute list of CostRoutingGroup ......................................................................................................................................... 195
CostRoutingItem........................................................................................................................... 196
Creating CostRoutingItem ........................................................................................................................................................ 196
Reading CostRoutingItem ........................................................................................................................................................ 196
Updating CostRoutingItem ...................................................................................................................................................... 196
Deleting CostRoutingItem ........................................................................................................................................................ 196
Attribute list of CostRoutingItem ............................................................................................................................................ 197
CostScenario................................................................................................................................. 198
Creating CostScenario .............................................................................................................................................................. 198
Reading CostScenario ............................................................................................................................................................... 198
Updating CostScenario ............................................................................................................................................................. 198
Deleting CostScenario .............................................................................................................................................................. 198
Attribute list of CostScenario................................................................................................................................................... 199
Country ........................................................................................................................................ 200
Creating Country ....................................................................................................................................................................... 200
Reading Country ....................................................................................................................................................................... 200
Updating Country ..................................................................................................................................................................... 200
Deleting Country ....................................................................................................................................................................... 200
Attribute list of Country ........................................................................................................................................................... 201
CreateFormDefinition ................................................................................................................... 202
Reading CreateFormDefinition ................................................................................................................................................ 202
Updating CreateFormDefinition .............................................................................................................................................. 202
Attribute Summary ................................................................................................................................................................... 203
Crew............................................................................................................................................. 204
Creating Crew............................................................................................................................................................................ 204
Reading Crew ............................................................................................................................................................................ 204
Updating Crew .......................................................................................................................................................................... 204
Deleting Crew............................................................................................................................................................................ 205
Attribute List of Crew ............................................................................................................................................................... 205
CrewAssignment........................................................................................................................... 206
Creating CrewAssignment ........................................................................................................................................................ 206
Reading CrewAssignment ........................................................................................................................................................ 206
Updating CrewAssignment ...................................................................................................................................................... 206
Deleting CrewAssignment ........................................................................................................................................................ 206
Attribute List of CrewAssignment ........................................................................................................................................... 207
Currency ....................................................................................................................................... 208
Creating Currency ..................................................................................................................................................................... 208
Reading Currency...................................................................................................................................................................... 208
Updating Currency .................................................................................................................................................................... 208
Deleting Currency ..................................................................................................................................................................... 208
Attribute List of Currency......................................................................................................................................................... 209
CurrencyExchangeRate ................................................................................................................. 210
Creating CurrencyExchangeRate ............................................................................................................................................. 210
Reading CurrencyExchangeRate .............................................................................................................................................. 210
Updating CurrencyExchangeRate ............................................................................................................................................ 210
Deleting CurrencyExchangeRate ............................................................................................................................................. 210
Attribute List of CurrencyExchangeRate ................................................................................................................................. 211
CurrencyExchangeTable................................................................................................................ 212
Creating CurrencyExchangeTable ............................................................................................................................................ 212
Reading CurrencyExchangeTable ............................................................................................................................................ 212
Updating CurrencyExchangeTable .......................................................................................................................................... 212

TABLE OF CONTENTS 10
 Centric 8 REST API DEVELOPER GUIDE

Deleting CurrencyExchangeTable ............................................................................................................................................ 212

Attribute List of CurrencyExchangeTable ............................................................................................................................... 213
Customer...................................................................................................................................... 214
Creating Customer .................................................................................................................................................................... 214
Reading Customer .................................................................................................................................................................... 214
Updating Customer .................................................................................................................................................................. 214
Deleting Customer .................................................................................................................................................................... 214
Attribute List of Customer ....................................................................................................................................................... 215
CustomerOrder ............................................................................................................................. 216
Creating CustomerOrder .......................................................................................................................................................... 216
Reading CustomerOrder .......................................................................................................................................................... 216
Updating CustomerOrder......................................................................................................................................................... 216
Deleting CustomerOrder .......................................................................................................................................................... 216
Attribute List of CustomerOrder.............................................................................................................................................. 217
CustomerPurchaseOrder ............................................................................................................... 218
Creating CustomerPurchaseOrder .......................................................................................................................................... 218
Reading CustomerPurchaseOrder ........................................................................................................................................... 218
Updating CustomerPurchaseOrder ......................................................................................................................................... 218
Deleting CustomerPurchaseOrder .......................................................................................................................................... 218
Attribute List of CustomerPurchaseOrder .............................................................................................................................. 219
DataPackage ................................................................................................................................ 220
Creating DataPackage .............................................................................................................................................................. 220
Reading DataPackage ............................................................................................................................................................... 220
Updating DataPackage ............................................................................................................................................................. 220
Deleting DataPackage............................................................................................................................................................... 220
Attribute List of DataPackage .................................................................................................................................................. 221
DataPackageTemplate ................................................................................................................. 222
Creating DataPackageTemplate .............................................................................................................................................. 222
Reading DataPackageTemplate ............................................................................................................................................... 222
Updating DataPackageTemplate ............................................................................................................................................. 222
Deleting DataPackageTemplate .............................................................................................................................................. 222
Attribute List of DataPackageTemplate .................................................................................................................................. 223
DataPackageTemplateSheet ......................................................................................................... 224
Creating DataPackageTemplateSheet ..................................................................................................................................... 224
Reading DataPackageTemplateSheet ..................................................................................................................................... 224
Updating DataPackageTemplateSheet ................................................................................................................................... 224
Deleting DataPackageTemplateSheet ..................................................................................................................................... 224
Attribute List of DataPackageTemplateSheet ........................................................................................................................ 225
DataSheetPage............................................................................................................................. 226
Creating DataSheetPage .......................................................................................................................................................... 226
Reading DataSheetPage ........................................................................................................................................................... 226
Updating DataSheetPage ......................................................................................................................................................... 227
Deleting DataSheetPage........................................................................................................................................................... 227
Attribute List of DataSheetPage .............................................................................................................................................. 227
DataSheetSizeLabel ...................................................................................................................... 228
Creating DataSheetSizeLabel ................................................................................................................................................... 228
Reading DataSheetSizeLabel .................................................................................................................................................... 228
Updating DataSheetSizeLabel .................................................................................................................................................. 228
Deleting DataSheetSizeLabel ................................................................................................................................................... 228
Attribute List of DataSheetSizeLabel ....................................................................................................................................... 229
DataSheetSizeLabelRevision ......................................................................................................... 230
Creating DataSheetSizeLabelRevision ..................................................................................................................................... 230

TABLE OF CONTENTS 11
 Centric 8 REST API DEVELOPER GUIDE

Reading DataSheetSizeLabelRevision...................................................................................................................................... 230

Updating DataSheetSizeLabelRevision.................................................................................................................................... 230
Method: DELETE unsupported ................................................................................................................................................ 230
Attribute List of DataSheetSizeLabelRevision......................................................................................................................... 231
Defect........................................................................................................................................... 232
Creating Defect ......................................................................................................................................................................... 232
Reading Defect .......................................................................................................................................................................... 232
Updating Defect ........................................................................................................................................................................ 232
Deleting Defect ......................................................................................................................................................................... 232
Attribute List of Defect ............................................................................................................................................................. 233
Document..................................................................................................................................... 234
Creating Document and uploading file/s ................................................................................................................................ 234
Reading Document ................................................................................................................................................................... 235
Updating Document ................................................................................................................................................................. 236
Deleting Document................................................................................................................................................................... 236
Attribute List of Document ...................................................................................................................................................... 236
DocumentRevision ........................................................................................................................ 237
Creating DocumentRevision .................................................................................................................................................... 237
Reading DocumentRevision ..................................................................................................................................................... 237
Updating DocumentRevision and uploading document to filevault..................................................................................... 237
Method: DELETE unsupported ................................................................................................................................................ 237
Attribute List of DocumentRevision ........................................................................................................................................ 238
DSLineDivider ............................................................................................................................... 240
Reading DSLineDivider ............................................................................................................................................................. 240
Updating DSLineDivider ........................................................................................................................................................... 240
Deleting DSLineDivider ............................................................................................................................................................. 240
Method: POST is unsupported................................................................................................................................................. 240
Attribute List of DSLineDivider ................................................................................................................................................ 241
DutyRate ...................................................................................................................................... 242
Creating DutyRate .................................................................................................................................................................... 242
Reading DutyRate ..................................................................................................................................................................... 242
Updating DutyRate ................................................................................................................................................................... 242
Deleting DutyRate..................................................................................................................................................................... 242
Attribute List of DutyRate ........................................................................................................................................................ 243
DutyRateUsage ............................................................................................................................ 244
Creating DutyRateUsage .......................................................................................................................................................... 244
Reading DutyRateUsage ........................................................................................................................................................... 244
Updating DutyRateUsage ......................................................................................................................................................... 244
Deleting DutyRateUsage .......................................................................................................................................................... 244
Attribute List of DutyRateUsage .............................................................................................................................................. 245
EngineeringChange ...................................................................................................................... 246
Creating EngineeringChange.................................................................................................................................................... 246
Reading EngineeringChange .................................................................................................................................................... 246
Updating EngineeringChange .................................................................................................................................................. 246
Deleting EngineeringChange.................................................................................................................................................... 246
Attribute Summary ................................................................................................................................................................... 247
EnumList....................................................................................................................................... 249
Creating EnumList ..................................................................................................................................................................... 249
Reading EnumList ..................................................................................................................................................................... 249
Updating EnumList ................................................................................................................................................................... 249
Deleting EnumList ..................................................................................................................................................................... 249
Attribute List of EnumList ........................................................................................................................................................ 250

TABLE OF CONTENTS 12
 Centric 8 REST API DEVELOPER GUIDE

EnumValue ................................................................................................................................... 251

Creating EnumValue ................................................................................................................................................................. 251
Reading EnumValue.................................................................................................................................................................. 251
Updating EnumValue................................................................................................................................................................ 251
Deleting EnumValue ................................................................................................................................................................. 251
Attribute List of EnumValue..................................................................................................................................................... 252
Factory ......................................................................................................................................... 253
Creating Factory........................................................................................................................................................................ 253
Reading Factory ........................................................................................................................................................................ 253
Updating Factory ...................................................................................................................................................................... 253
Deleting Factory ........................................................................................................................................................................ 253
Attribute List of Factory ........................................................................................................................................................... 254
FactoryReview .............................................................................................................................. 255
Creating FactoryReview ........................................................................................................................................................... 255
Reading FactoryReview ............................................................................................................................................................ 255
Updating FactoryReview .......................................................................................................................................................... 255
Deleting FactoryReview ........................................................................................................................................................... 255
Attribute List of FactoryReview ............................................................................................................................................... 256
FactoryReviewTemplate ............................................................................................................... 257
Creating FactoryReviewTemplate ........................................................................................................................................... 257
Reading FactoryReviewTemplate ............................................................................................................................................ 257
Updating FactoryReviewTemplate .......................................................................................................................................... 257
Deleting FactoryReviewTemplate ........................................................................................................................................... 257
Attribute List of FactoryReviewTemplate ............................................................................................................................... 258
FactoryReviewTemplateRevision................................................................................................... 259
Creating FactoryReviewTemplateRevision ............................................................................................................................. 259
Reading FactoryReviewTemplateRevision .............................................................................................................................. 259
Updating FactoryReviewTemplateRevision ............................................................................................................................ 259
Method: DELETE unsupported ................................................................................................................................................ 259
Attribute List of FactoryReviewTemplateRevision ................................................................................................................. 260
FinalInspection ............................................................................................................................. 261
Creating FinalInspection........................................................................................................................................................... 261
Reading FinalInspection ........................................................................................................................................................... 261
Updating FinalInspection ......................................................................................................................................................... 261
Deleting FinalInspection ........................................................................................................................................................... 261
Attribute List of FinalInspection .............................................................................................................................................. 262
FinalInspectionBatch .................................................................................................................... 264
Creating FinalInspectionBatch ................................................................................................................................................. 264
Reading FinalInspectionBatch.................................................................................................................................................. 264
Updating FinalInspectionBatch................................................................................................................................................ 264
Deleting FinalInspectionBatch ................................................................................................................................................. 264
Attribute List of FinalInspectionBatch..................................................................................................................................... 265
FinalInspectionBatchErrorType ..................................................................................................... 266
Reading FinalInspectionBatchErrorType ................................................................................................................................. 266
Updating FinalInspectionBatchErrorType ............................................................................................................................... 266
Method: POST & DELETE unsupported ................................................................................................................................... 266
Attribute List of FinalInspectionBatchErrorType .................................................................................................................... 267
FinalInspectionBatchSection ......................................................................................................... 268
Reading FinalInspectionBatchSection ..................................................................................................................................... 268
Updating FinalInspectionBatchSection ................................................................................................................................... 268
Deleting FinalInspectionBatchSection..................................................................................................................................... 268
Method: POST unsupported .................................................................................................................................................... 268

TABLE OF CONTENTS 13
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchSection ........................................................................................................................ 269

FinalInspectionBatchSectionSample .............................................................................................. 270
Creating FinalInspectionBatchSectionSample ........................................................................................................................ 270
Reading FinalInspectionBatchSectionSample......................................................................................................................... 270
Updating FinalInspectionBatchSectionSample....................................................................................................................... 270
Method: DELETE unsupported ................................................................................................................................................ 270
Attribute List of FinalInspectionBatchSectionSample............................................................................................................ 271
FinalInspectionBatchSectionSampleDimension ............................................................................. 272
Reading FinalInspectionBatchSectionSampleDimension....................................................................................................... 272
Updating FinalInspectionBatchSectionSampleDimension..................................................................................................... 272
Method: POST & DELETE unsupported ................................................................................................................................... 272
Attribute List of FinalInspectionBatchSectionSampleDimension .......................................................................................... 273
FinalInspectionBatchTest .............................................................................................................. 274
Creating FinalInspectionBatchTest .......................................................................................................................................... 274
Reading FinalInspectionBatchTest .......................................................................................................................................... 274
Updating FinalInspectionBatchTest......................................................................................................................................... 274
Deleting FinalInspectionBatchTest .......................................................................................................................................... 274
Attribute List of FinalInspectionBatchTest.............................................................................................................................. 275
FinalInspectionBOM ..................................................................................................................... 276
Creating FinalInspectionBOM .................................................................................................................................................. 276
Reading FinalInspectionBOM................................................................................................................................................... 276
Updating FinalInspectionBOM................................................................................................................................................. 276
Deleting FinalInspectionBOM .................................................................................................................................................. 276
Attribute List of FinalInspectionBOM...................................................................................................................................... 277
FinalInspectionDataPackage......................................................................................................... 278
Reading FinalInspectionDataPackage ..................................................................................................................................... 278
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 278
Attribute List of FinalInspectionDataPackage......................................................................................................................... 279
FinalInspectionDefect ................................................................................................................... 280
Creating FinalInspectionDefect ............................................................................................................................................... 280
Reading FinalInspectionDefect ................................................................................................................................................ 280
Updating FinalInspectionDefect .............................................................................................................................................. 280
Deleting FinalInspectionDefect................................................................................................................................................ 281
Attribute List of FinalInspectionDefect ................................................................................................................................... 281
FinalInspectionErrorType .............................................................................................................. 282
Creating FinalInspectionErrorType .......................................................................................................................................... 282
Reading FinalInspectionErrorType .......................................................................................................................................... 282
Updating FinalInspectionErrorType......................................................................................................................................... 282
Deleting FinalInspectionErrorType .......................................................................................................................................... 282
Attribute List of FinalInspectionErrorType.............................................................................................................................. 283
FinalInspectionImageDataSheet ................................................................................................... 284
Reading FinalInspectionImageDataSheet ............................................................................................................................... 284
Updating FinalInspectionImageDataSheet ............................................................................................................................. 284
Deleting FinalInspectionImageDataSheet ............................................................................................................................... 284
POST unsupported .................................................................................................................................................................... 284
Attribute List of FinalInspectionImageDataSheet .................................................................................................................. 285
FinalInspectionLabeledImage........................................................................................................ 286
Reading FinalInspectionLabeledImage.................................................................................................................................... 286
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 286
Attribute List of FinalInspectionLabeledImage....................................................................................................................... 287
FinalInspectionOrder .................................................................................................................... 288
Creating FinalInspectionOrder................................................................................................................................................. 288

TABLE OF CONTENTS 14
 Centric 8 REST API DEVELOPER GUIDE

Reading FinalInspectionOrder ................................................................................................................................................. 288

Updating FinalInspectionOrder ............................................................................................................................................... 288
Deleting FinalInspectionOrder ................................................................................................................................................. 288
Attribute List of FinalInspectionOrder .................................................................................................................................... 289
FinalInspectionPartMaterial ......................................................................................................... 290
Creating FinalInspectionPartMaterial ..................................................................................................................................... 290
Reading FinalInspectionPartMaterial ...................................................................................................................................... 290
Updating FinalInspectionPartMaterial .................................................................................................................................... 290
Deleting FinalInspectionPartMaterial ..................................................................................................................................... 290
Attribute List of FinalInspectionPartMaterial ......................................................................................................................... 291
FinalInspectionReviewStyle ........................................................................................................... 292
Reading FinalInspectionReviewStyle ....................................................................................................................................... 292
Deleting FinalInspectionReviewStyle ...................................................................................................................................... 292
Method: POST & PUT unsupported ........................................................................................................................................ 292
Attribute List of FinalInspectionReviewStyle .......................................................................................................................... 293
FinalInspectionSection .................................................................................................................. 294
Creating FinalInspectionSection .............................................................................................................................................. 294
Reading FinalInspectionSection ............................................................................................................................................... 294
Updating FinalInspectionSection ............................................................................................................................................. 294
Deleting FinalInspectionSection .............................................................................................................................................. 294
Attribute List of FinalInspectionSection .................................................................................................................................. 295
FinalInspectionSectionSubtype...................................................................................................... 296
Reading FinalInspectionSectionSubtype ................................................................................................................................. 296
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 296
Attribute List of FinalInspectionSectionSubtype .................................................................................................................... 297
FinalInspectionSecurityGroup ....................................................................................................... 298
Creating FinalInspectionSecurityGroup .................................................................................................................................. 298
Reading FinalInspectionSecurityGroup ................................................................................................................................... 298
Updating FinalInspectionSecurityGroup ................................................................................................................................. 298
Deleting FinalInspectionSecurityGroup .................................................................................................................................. 298
Attribute List of FinalInspectionSecurityGroup ...................................................................................................................... 299
FinalInspectionSizeChart ............................................................................................................... 300
Creating FinalInspectionSizeChart ........................................................................................................................................... 300
Reading FinalInspectionSizeChart ........................................................................................................................................... 300
Updating FinalInspectionSizeChart ......................................................................................................................................... 300
Deleting FinalInspectionSizeChart ........................................................................................................................................... 300
Attribute List of FinalInspectionSizeChart .............................................................................................................................. 301
FinalInspectionSizeChartDimension .............................................................................................. 302
Reading FinalInspectionSizeChartDimension ......................................................................................................................... 302
Updating FinalInspectionSizeChartDimension ....................................................................................................................... 302
Method: POST & DELETE unsupported ................................................................................................................................... 302
Attribute List of FinalInspectionSizeChartDimension ............................................................................................................ 303
FinalInspectionShipment............................................................................................................... 304
Creating FinalInspectionShipment .......................................................................................................................................... 304
Reading FinalInspectionShipment ........................................................................................................................................... 304
Updating FinalInspectionShipment ......................................................................................................................................... 304
Deleting FinalInspectionShipment .......................................................................................................................................... 304
Attribute List of FinalInspectionShipment .............................................................................................................................. 305
FinalInspectionTemplate............................................................................................................... 306
Creating FinalInspectionTemplate........................................................................................................................................... 306
Reading FinalInspectionTemplate ........................................................................................................................................... 306
Updating FinalInspectionTemplate ......................................................................................................................................... 306

TABLE OF CONTENTS 15
 Centric 8 REST API DEVELOPER GUIDE

Deleting FinalInspectionTemplate........................................................................................................................................... 306

Attribute List of FinalInspectionTemplate .............................................................................................................................. 307
Food ............................................................................................................................................. 308
Creating Food ............................................................................................................................................................................ 308
Reading Food ............................................................................................................................................................................ 308
Updating Food .......................................................................................................................................................................... 308
Deleting Food ............................................................................................................................................................................ 308
Attribute Summary ................................................................................................................................................................... 309
FoodAllergen ................................................................................................................................ 310
Creating FoodAllergen.............................................................................................................................................................. 310
Reading FoodAllergen .............................................................................................................................................................. 310
Updating FoodAllergen ............................................................................................................................................................ 310
Deleting FoodAllergen .............................................................................................................................................................. 310
Attribute Summary ................................................................................................................................................................... 311
FoodBOMRevision ........................................................................................................................ 312
Reading FoodBOMRevision...................................................................................................................................................... 312
Attribute Summary ................................................................................................................................................................... 312
FoodClaim .................................................................................................................................... 314
Creating FoodClaim .................................................................................................................................................................. 314
Reading FoodClaim ................................................................................................................................................................... 314
Updating FoodClaim ................................................................................................................................................................. 314
Deleting FoodClaim .................................................................................................................................................................. 314
Attribute Summary ................................................................................................................................................................... 315
FoodIngredient ............................................................................................................................. 316
Creating FoodIngredient .......................................................................................................................................................... 316
Reading FoodIngredient ........................................................................................................................................................... 316
Updating FoodIngredient ......................................................................................................................................................... 316
Deleting FoodIngredient .......................................................................................................................................................... 316
Attribute Summary ................................................................................................................................................................... 317
FoodLabelDataSheet..................................................................................................................... 318
Creating FoodLabelDataSheet ................................................................................................................................................. 318
Reading FoodLabelDataSheet .................................................................................................................................................. 318
Updating FoodLabelDataSheet ................................................................................................................................................ 318
Deleting FoodLabelDataSheet ................................................................................................................................................. 318
Attribute Summary ................................................................................................................................................................... 319
FoodLabelDataSheetRevision ........................................................................................................ 320
Creating FoodLabelDataSheetRevision ................................................................................................................................... 320
Reading FoodLabelDataSheetRevision.................................................................................................................................... 320
Updating FoodLabelDataSheetRevision .................................................................................................................................. 320
Attribute Summary ................................................................................................................................................................... 321
FoodNutrient ................................................................................................................................ 323
Creating FoodNutrient ............................................................................................................................................................. 323
Reading FoodNutrient .............................................................................................................................................................. 323
Updating FoodNutrient ............................................................................................................................................................ 323
Deleting FoodNutrient ............................................................................................................................................................. 323
Attribute Summary ................................................................................................................................................................... 324
FoodSample.................................................................................................................................. 325
Creating FoodSample ............................................................................................................................................................... 325
Reading FoodSample ................................................................................................................................................................ 325
Updating FoodSample .............................................................................................................................................................. 325
Deleting FoodSample ............................................................................................................................................................... 325
Attribute Summary ................................................................................................................................................................... 326

TABLE OF CONTENTS 16
 Centric 8 REST API DEVELOPER GUIDE

FoodSource................................................................................................................................... 328
Creating FoodSource ................................................................................................................................................................ 328
Reading FoodSource ................................................................................................................................................................. 328
Updating FoodSource ............................................................................................................................................................... 328
Deleting FoodSource ................................................................................................................................................................ 328
Attribute Summary ................................................................................................................................................................... 329
FoodSKU ....................................................................................................................................... 330
Creating FoodSKU ..................................................................................................................................................................... 330
Reading FoodSKU...................................................................................................................................................................... 330
Updating FoodSKU.................................................................................................................................................................... 330
Deleting FoodSKU ..................................................................................................................................................................... 330
Attribute Summary ................................................................................................................................................................... 331
FoodSupplierItem ......................................................................................................................... 332
Creating FoodSupplierItem ...................................................................................................................................................... 332
Reading FoodSupplierItem....................................................................................................................................................... 332
Updating FoodSupplierItem ..................................................................................................................................................... 332
Deleting FoodSupplierItem ...................................................................................................................................................... 332
Attribute Summary ................................................................................................................................................................... 333
FormulatedMaterial ..................................................................................................................... 334
Creating FormulatedMaterial .................................................................................................................................................. 334
Reading FormulatedMaterial ................................................................................................................................................... 334
Updating FormulatedMaterial ................................................................................................................................................. 334
Deleting FormulatedMaterial .................................................................................................................................................. 334
Attribute Summary ................................................................................................................................................................... 335
FPItem.......................................................................................................................................... 337
Creating FPItem ........................................................................................................................................................................ 337
Reading FPItem ......................................................................................................................................................................... 337
Updating FPItem ....................................................................................................................................................................... 337
Deleting FPItem ........................................................................................................................................................................ 337
Attribute Summary ................................................................................................................................................................... 338
Group ........................................................................................................................................... 339
Creating Group.......................................................................................................................................................................... 339
Reading Group .......................................................................................................................................................................... 339
Updating Group ........................................................................................................................................................................ 339
Deleting Group.......................................................................................................................................................................... 339
Attribute List of Group ............................................................................................................................................................. 340
Holiday ......................................................................................................................................... 341
Creating Holiday ....................................................................................................................................................................... 341
Reading Holiday ........................................................................................................................................................................ 341
Updating Holiday ...................................................................................................................................................................... 341
Deleting Holiday........................................................................................................................................................................ 341
Attribute List of Holiday ........................................................................................................................................................... 342
HolidayCalendar ........................................................................................................................... 343
Creating HolidayCalendar ........................................................................................................................................................ 343
Reading HolidayCalendar ......................................................................................................................................................... 343
Updating HolidayCalendar ....................................................................................................................................................... 343
Deleting HolidayCalendar ........................................................................................................................................................ 343
Attribute List of HolidayCalendar ............................................................................................................................................ 344
Image ........................................................................................................................................... 345
Creating and uploading Image ................................................................................................................................................. 345
Reading Image .......................................................................................................................................................................... 345
Updating Image......................................................................................................................................................................... 346

TABLE OF CONTENTS 17
 Centric 8 REST API DEVELOPER GUIDE

Deleting Image .......................................................................................................................................................................... 346

Attribute List of Image.............................................................................................................................................................. 347
List of Objects containing Image (Centric Version 6.6 and higher datamodel).................................................................... 347
ImageDataSheet........................................................................................................................... 348
Creating ImageDataSheet ........................................................................................................................................................ 348
Reading ImageDataSheet ......................................................................................................................................................... 348
Updating ImageDataSheet ....................................................................................................................................................... 348
Deleting ImageDataSheet ........................................................................................................................................................ 348
Attribute List of ImageDataSheet ............................................................................................................................................ 349
ImageDataSheetRevision .............................................................................................................. 350
Creating ImageDataSheetRevision .......................................................................................................................................... 350
Reading ImageDataSheetRevision ........................................................................................................................................... 350
Updating ImageDataSheetRevision ......................................................................................................................................... 350
Method: DELETE unsupported ................................................................................................................................................ 350
Attribute List of ImageDataSheetRevision .............................................................................................................................. 351
ImpactedItem ............................................................................................................................... 352
Reading ImpactedItem ............................................................................................................................................................. 352
Attribute Summary ................................................................................................................................................................... 352
Increment..................................................................................................................................... 353
Creating Increment ................................................................................................................................................................... 353
Reading Increment ................................................................................................................................................................... 353
Updating Increment ................................................................................................................................................................. 353
Deleting Increment ................................................................................................................................................................... 353
Attribute List of Increment ...................................................................................................................................................... 354
IncrementDimension..................................................................................................................... 355
Creating IncrementDimension................................................................................................................................................. 355
Reading IncrementDimension ................................................................................................................................................. 355
Updating IncrementDimension ............................................................................................................................................... 355
Deleting IncrementDimension ................................................................................................................................................. 355
Attribute List of IncrementDimension .................................................................................................................................... 356
IncrementSize ............................................................................................................................... 357
Creating IncrementSize ............................................................................................................................................................ 357
Reading IncrementSize ............................................................................................................................................................. 357
Updating IncrementSize ........................................................................................................................................................... 357
Deleting IncrementSize ............................................................................................................................................................ 357
Attribute List of IncrementSize ................................................................................................................................................ 358
IngredientItem.............................................................................................................................. 359
Creating IngredientItem ........................................................................................................................................................... 359
Reading IngredientItem ........................................................................................................................................................... 359
Updating IngredientItem.......................................................................................................................................................... 359
Deleting IngredientItem ........................................................................................................................................................... 359
Attribute Summary ................................................................................................................................................................... 360
InspectionErrorType...................................................................................................................... 361
Creating InspectionErrorType .................................................................................................................................................. 361
Reading InspectionErrorType .................................................................................................................................................. 361
Updating InspectionErrorType................................................................................................................................................. 361
Deleting InspectionErrorType .................................................................................................................................................. 361
Attribute List of InspectionErrorType...................................................................................................................................... 362
InspectionTestSpec ....................................................................................................................... 363
Creating InspectionTestSpec.................................................................................................................................................... 363
Reading InspectionTestSpec .................................................................................................................................................... 363
Updating InspectionTestSpec .................................................................................................................................................. 363

TABLE OF CONTENTS 18
 Centric 8 REST API DEVELOPER GUIDE

Deleting InspectionTestSpec.................................................................................................................................................... 363

Attribute List of InspectionTestSpec ....................................................................................................................................... 364
InspectionTestSpecRevision .......................................................................................................... 365
Creating InspectionTestSpecRevision ..................................................................................................................................... 365
Reading InspectionTestSpecRevision ...................................................................................................................................... 365
Updating InspectionTestSpecRevision .................................................................................................................................... 365
Method: DELETE unsupported ................................................................................................................................................ 365
Attribute List of InspectionTestSpecRevision ......................................................................................................................... 366
Issue ............................................................................................................................................. 367
Creating Issue............................................................................................................................................................................ 367
Reading Issue ............................................................................................................................................................................ 367
Updating Issue .......................................................................................................................................................................... 368
Deleting Issue ............................................................................................................................................................................ 368
Attribute List of Issue ............................................................................................................................................................... 369
Language ..................................................................................................................................... 370
Creating Language .................................................................................................................................................................... 370
Reading Language..................................................................................................................................................................... 370
Updating Language ................................................................................................................................................................... 370
Deleting Language .................................................................................................................................................................... 370
Attribute List of Language ........................................................................................................................................................ 371
LibColorSpecification .................................................................................................................... 372
Creating LibColorSpecification................................................................................................................................................. 372
Reading LibColorSpecification ................................................................................................................................................. 372
Updating LibColorSpecification ............................................................................................................................................... 372
Deleting LibColorSpecification ................................................................................................................................................. 372
Attribute List of LibColorSpecification .................................................................................................................................... 373
LibMaterial ................................................................................................................................... 374
Creating LibMaterial ................................................................................................................................................................. 374
Reading LibMaterial.................................................................................................................................................................. 374
Updating LibMaterial................................................................................................................................................................ 374
Deleting LibMaterial ................................................................................................................................................................. 374
Attribute List of LibMaterial..................................................................................................................................................... 375
LibPrintDesign .............................................................................................................................. 376
Reading LibPrintDesign ............................................................................................................................................................ 376
Attribute List of LibSizeLabel ................................................................................................................................................... 376
LibSizeLabel .................................................................................................................................. 377
Creating LibSizeLabel................................................................................................................................................................ 377
Reading LibSizeLabel ................................................................................................................................................................ 377
Updating LibSizeLabel .............................................................................................................................................................. 377
Deleting LibSizeLabel ................................................................................................................................................................ 377
Attribute List of LibSizeLabel ................................................................................................................................................... 378
Locale........................................................................................................................................... 379
Reading Locale .......................................................................................................................................................................... 379
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 379
Attribute List of Locale ............................................................................................................................................................. 379
Localization .................................................................................................................................. 380
Reading Localizable Class name information ......................................................................................................................... 380
Attribute list of Localizable Class name information ............................................................................................................. 380
Reading Localizable Class name, locale and attribute information ...................................................................................... 381
Attribute List of Localizable Class Name, Locale and Attribute Information ....................................................................... 381
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 381
LookupItem .................................................................................................................................. 382

TABLE OF CONTENTS 19
 Centric 8 REST API DEVELOPER GUIDE

Creating LookupItem ................................................................................................................................................................ 382

Reading LookupItem................................................................................................................................................................. 382
Updating LookupItem............................................................................................................................................................... 382
Deleting LookupItem ................................................................................................................................................................ 382
Attribute List of LookupItem .................................................................................................................................................... 383
LookupItemSubtype ...................................................................................................................... 386
Reading LookupItemSubtype ................................................................................................................................................... 386
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 386
Attribute List of LookupItemSubtype ...................................................................................................................................... 386
MarketingCollection ..................................................................................................................... 387
Creating MarketingCollection .................................................................................................................................................. 387
Reading MarketingCollection .................................................................................................................................................. 387
Updating MarketingCollection................................................................................................................................................. 387
Deleting MarketingCollection .................................................................................................................................................. 387
Attribute List of MarketingCollection...................................................................................................................................... 388
MarketingLook ............................................................................................................................. 389
Creating MarketingLook ........................................................................................................................................................... 389
Reading MarketingLook ........................................................................................................................................................... 389
Updating MarketingLook ......................................................................................................................................................... 389
Deleting MarketingLook ........................................................................................................................................................... 389
Attribute List of MarketingLook .............................................................................................................................................. 390
MarketingSegment....................................................................................................................... 391
Reading MarketingSegment .................................................................................................................................................... 391
Updating MarketingSegment................................................................................................................................................... 391
Deleting MarketingSegment .................................................................................................................................................... 391
Method: POST unsupported .................................................................................................................................................... 391
Attribute List of MarketingSegment........................................................................................................................................ 392
MarketingTool.............................................................................................................................. 393
Creating MarketingTool ........................................................................................................................................................... 393
Reading MarketingTool ............................................................................................................................................................ 393
Updating MarketingTool .......................................................................................................................................................... 393
Deleting MarketingTool ........................................................................................................................................................... 393
Attribute List of MarketingTool ............................................................................................................................................... 394
Material ....................................................................................................................................... 395
Creating Material ...................................................................................................................................................................... 395
Reading Material ...................................................................................................................................................................... 395
Updating Material..................................................................................................................................................................... 395
Updating the ProductSize of the Material .............................................................................................................................. 395
Deleting Material ...................................................................................................................................................................... 396
Attribute Value Considerations ............................................................................................................................................... 396
Attribute List of Material.......................................................................................................................................................... 396
MaterialBOM ............................................................................................................................... 399
Creating MaterialBOM ............................................................................................................................................................. 399
Reading MaterialBOM .............................................................................................................................................................. 399
Updating MaterialBOM ............................................................................................................................................................ 399
Deleting MaterialBOM ............................................................................................................................................................. 399
Attribute List of MaterialBOM ................................................................................................................................................. 400
MaterialBOMRevision................................................................................................................... 401
Creating MaterialBOMRevision ............................................................................................................................................... 401
Reading MaterialBOMRevision................................................................................................................................................ 401
Updating MaterialBOMRevision .............................................................................................................................................. 401
Method: Delete Unsupported ................................................................................................................................................. 401

TABLE OF CONTENTS 20
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialBOMRevision ................................................................................................................................... 402

MaterialBOMSubtype ................................................................................................................... 403
Creating MaterialBOMSubtype ............................................................................................................................................... 403
Reading MaterialBOMSubtype ................................................................................................................................................ 403
Updating MaterialBOMSubtype .............................................................................................................................................. 403
Deleting MaterialBOMSubtype................................................................................................................................................ 403
Attribute List of MaterialBOMSubtype ................................................................................................................................... 404
MaterialComposition .................................................................................................................... 405
Creating MaterialComposition ................................................................................................................................................ 405
Reading MaterialComposition ................................................................................................................................................. 405
Updating MaterialComposition ............................................................................................................................................... 405
Deleting MaterialComposition ................................................................................................................................................ 406
Attribute list of MaterialComposition ..................................................................................................................................... 406
MaterialDataSheet ....................................................................................................................... 407
Creating MaterialDataSheet .................................................................................................................................................... 407
Reading MaterialDataSheet ..................................................................................................................................................... 407
Updating MaterialDataSheet ................................................................................................................................................... 407
Deleting MaterialDataSheet .................................................................................................................................................... 407
Attribute List of MaterialDataSheet ........................................................................................................................................ 408
MaterialDataSheetRevision .......................................................................................................... 409
Creating MaterialDataSheetRevision ...................................................................................................................................... 409
Reading MaterialDataSheetRevision ....................................................................................................................................... 409
Updating MaterialDataSheetRevision ..................................................................................................................................... 409
Method: DELETE unsupported ................................................................................................................................................ 409
Attribute List of MaterialDataSheetRevision .......................................................................................................................... 410
MaterialPlanPlacement ................................................................................................................ 411
Creating MaterialPlanPlacement............................................................................................................................................. 411
Reading MaterialPlanPlacement ............................................................................................................................................. 411
Updating MaterialPlanPlacement ........................................................................................................................................... 411
Deleting MaterialPlanPlacement ............................................................................................................................................. 411
Attribute List of MaterialPlanPlacement ................................................................................................................................ 412
MaterialPlanPlacementColorway.................................................................................................. 413
Reading MaterialPlanPlacementColorway ............................................................................................................................. 413
Updating MaterialPlanPlacementColorway ........................................................................................................................... 413
Method: POST and DELETE are unsupported ......................................................................................................................... 413
Attribute List of MaterialPlanPlacementColorway ................................................................................................................ 414
MaterialSample ............................................................................................................................ 415
Creating MaterialSample ......................................................................................................................................................... 415
Reading MaterialSample .......................................................................................................................................................... 415
Updating MaterialSample ........................................................................................................................................................ 415
Deleting MaterialSample ......................................................................................................................................................... 415
Attribute List of MaterialSample ............................................................................................................................................. 416
MaterialSecurityGroup ................................................................................................................. 417
Creating MaterialSecurityGroup.............................................................................................................................................. 417
Reading MaterialSecurityGroup .............................................................................................................................................. 417
Updating MaterialSecurityGroup ............................................................................................................................................ 417
Deleting MaterialSecurityGroup.............................................................................................................................................. 417
Attribute List of MaterialSecurityGroup ................................................................................................................................. 418
MaterialType ................................................................................................................................ 419
Creating MaterialType .............................................................................................................................................................. 419
Reading MaterialType .............................................................................................................................................................. 419
Updating MaterialType ............................................................................................................................................................ 419

TABLE OF CONTENTS 21
 Centric 8 REST API DEVELOPER GUIDE

Deleting MaterialType .............................................................................................................................................................. 419

Attribute List of MaterialType ................................................................................................................................................. 420
MCMaterial .................................................................................................................................. 421
Creating MCMaterial ................................................................................................................................................................ 421
Reading MCMaterial ................................................................................................................................................................. 421
Updating MCMaterial ............................................................................................................................................................... 421
Deleting MCMaterial ................................................................................................................................................................ 421
Attribute List of MCMaterial .................................................................................................................................................... 422
MCMaterialColor .......................................................................................................................... 423
Reading MCMaterialColor........................................................................................................................................................ 423
Updating MCMaterialColor ...................................................................................................................................................... 423
Method: POST & DELETE are unsupported ............................................................................................................................ 423
Attribute List of MCMaterialColor ........................................................................................................................................... 424
MCProduct ................................................................................................................................... 425
Creating MCProduct ................................................................................................................................................................. 425
Reading MCProduct .................................................................................................................................................................. 425
Updating MCProduct ................................................................................................................................................................ 425
Deleting MCProduct ................................................................................................................................................................. 425
Attribute List of MCProduct ..................................................................................................................................................... 426
MCProductColor ........................................................................................................................... 428
Creating MCProductColor ........................................................................................................................................................ 428
Reading MCProductColor ......................................................................................................................................................... 428
Updating MCProductColor ....................................................................................................................................................... 428
Deleting MCProductColor ........................................................................................................................................................ 428
Attribute List of MCProductColor ............................................................................................................................................ 429
MCProductSKU ............................................................................................................................. 430
Creating MCProductSKU .......................................................................................................................................................... 430
Reading MCProductSKU ........................................................................................................................................................... 430
Updating MCProductSKU ......................................................................................................................................................... 430
Deleting MCProductSKU .......................................................................................................................................................... 430
Attribute List of MCProductSKU .............................................................................................................................................. 431
MerchCollection ........................................................................................................................... 432
Creating MerchCollection ........................................................................................................................................................ 432
Reading MerchCollection ......................................................................................................................................................... 432
Updating MerchCollection ....................................................................................................................................................... 432
Deleting MerchCollection ........................................................................................................................................................ 432
Attribute Summary ................................................................................................................................................................... 433
MerchFolder ................................................................................................................................. 434
Creating MerchFolder .............................................................................................................................................................. 434
Reading MerchFolder ............................................................................................................................................................... 434
Updating MerchFolder ............................................................................................................................................................. 434
Deleting MerchFolder .............................................................................................................................................................. 434
Attribute Summary ................................................................................................................................................................... 435
MerchLevel ................................................................................................................................... 436
Creating MerchPlan and MerchLevel ...................................................................................................................................... 436
Reading Merchandise related objects..................................................................................................................................... 436
Updating MerchLevel ............................................................................................................................................................... 437
Deleting MerchLevel................................................................................................................................................................. 437
Attribute List of MerchLevel .................................................................................................................................................... 438
MerchLevelSubtype ...................................................................................................................... 439
Creating MerchLevelSubtype................................................................................................................................................... 439
Reading MerchLevelSubtype ................................................................................................................................................... 439

TABLE OF CONTENTS 22
 Centric 8 REST API DEVELOPER GUIDE

Updating MerchLevelSubtype ................................................................................................................................................. 440

Deleting MerchLevelSubtype ................................................................................................................................................... 440
Attribute List of MerchLevelSubtype ...................................................................................................................................... 441
MerchOption ................................................................................................................................ 445
Creating MerchOption.............................................................................................................................................................. 445
Reading MerchOption .............................................................................................................................................................. 445
Updating MerchOption ............................................................................................................................................................ 445
Deleting MerchOption.............................................................................................................................................................. 445
Attribute Summary ................................................................................................................................................................... 446
MerchPlan .................................................................................................................................... 447
Creating MerchPlan .................................................................................................................................................................. 447
Reading MerchPlan................................................................................................................................................................... 447
Updating MerchPlan................................................................................................................................................................. 447
Deleting MerchPlan .................................................................................................................................................................. 447
Attribute Summary ................................................................................................................................................................... 448
MerchProduct............................................................................................................................... 449
Creating MerchProduct ............................................................................................................................................................ 449
Reading MerchProduct ............................................................................................................................................................ 449
Updating MerchProduct........................................................................................................................................................... 449
Deleting MerchProduct ............................................................................................................................................................ 449
Attribute Summary ................................................................................................................................................................... 450
MerchSeason................................................................................................................................ 451
Creating MerchSeason ............................................................................................................................................................. 451
Reading MerchSeason .............................................................................................................................................................. 451
Updating MerchSeason ............................................................................................................................................................ 451
Deleting MerchSeason ............................................................................................................................................................. 451
Attribute Summary ................................................................................................................................................................... 452
MerchSecondary........................................................................................................................... 453
Reading MerchSecondary ........................................................................................................................................................ 453
Updating MerchSecondary ...................................................................................................................................................... 453
Deleting MerchSecondary........................................................................................................................................................ 453
Attribute Summary ................................................................................................................................................................... 454
MerchVersion ............................................................................................................................... 455
Creating MerchVersion ............................................................................................................................................................ 455
Reading MerchVersion ............................................................................................................................................................. 455
Updating MerchVersion ........................................................................................................................................................... 455
Deleting MerchVersion ............................................................................................................................................................ 455
Attribute List of MerchVersion ................................................................................................................................................ 456
NutrientItem................................................................................................................................. 457
Creating NutrientItem .............................................................................................................................................................. 457
Reading NutrientItem............................................................................................................................................................... 457
Updating NutrientItem ............................................................................................................................................................. 457
Deleting NutrientItem .............................................................................................................................................................. 457
Attribute Summary ................................................................................................................................................................... 458
OnlineCrew................................................................................................................................... 459
Creating OnlineCrew ................................................................................................................................................................ 459
Reading OnlineCrew ................................................................................................................................................................. 459
Updating OnlineCrew ............................................................................................................................................................... 459
Method: DELETE unsupported ................................................................................................................................................ 459
Attribute List of OnlineCrew .................................................................................................................................................... 460
Order............................................................................................................................................ 461
Creating Order .......................................................................................................................................................................... 461

TABLE OF CONTENTS 23
 Centric 8 REST API DEVELOPER GUIDE

Reading Order ........................................................................................................................................................................... 461

Updating Order ......................................................................................................................................................................... 461
Deleting Order .......................................................................................................................................................................... 461
Attribute List of Order .............................................................................................................................................................. 462
OrderTableSpanner ...................................................................................................................... 463
Creating OrderTableSpanner ................................................................................................................................................... 463
Reading OrderTableSpanner.................................................................................................................................................... 463
Updating OrderTableSpanner .................................................................................................................................................. 464
Deleting OrderTableSpanner ................................................................................................................................................... 464
Attribute List of OrderTableSpanner ....................................................................................................................................... 464
ORQuestion .................................................................................................................................. 465
Reading ORQuestion ................................................................................................................................................................ 465
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 465
Attribute List of ORQuestion ................................................................................................................................................... 466
ORQuestionSection ....................................................................................................................... 467
Reading ORQuestionSection .................................................................................................................................................... 467
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 467
Attribute List of ORQuestionSection ....................................................................................................................................... 468
ORQuestionSubsection ................................................................................................................. 469
Reading ORQuestionSection .................................................................................................................................................... 469
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 469
Attribute List of ORQuestionSubsection ................................................................................................................................. 470
ORSubQuestion ............................................................................................................................ 471
Reading ORSubQuestion .......................................................................................................................................................... 471
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 471
Attribute List of ORSubQuestion ............................................................................................................................................. 471
PackList ........................................................................................................................................ 472
Creating PackList....................................................................................................................................................................... 472
Reading PackList ....................................................................................................................................................................... 472
Updating PackList ..................................................................................................................................................................... 472
Deleting PackList ....................................................................................................................................................................... 472
Attribute Summary ................................................................................................................................................................... 473
PackListCarton.............................................................................................................................. 474
Reading PackListCarton ............................................................................................................................................................ 474
Updating PackListCarton .......................................................................................................................................................... 474
Method: POST and DELETE unsupported ............................................................................................................................... 474
Attribute List of PackListCarton ............................................................................................................................................... 474
PackListItem ................................................................................................................................. 475
Creating PackListItem ............................................................................................................................................................... 475
Reading PackListItem ............................................................................................................................................................... 475
Updating PackListItem.............................................................................................................................................................. 475
Deleting PackListItem ............................................................................................................................................................... 475
Attribute Summary ................................................................................................................................................................... 476
PartMaterial (v2 Deprecated, use v3 instead) ............................................................................... 477
Creating PartMaterial ............................................................................................................................................................... 477
Reading PartMaterial ............................................................................................................................................................... 477
Updating PartMaterial.............................................................................................................................................................. 477
Deleting PartMaterial ............................................................................................................................................................... 477
Attribute List of PartMaterial................................................................................................................................................... 478
Attribute Value Considerations ............................................................................................................................................... 480
PartMaterial................................................................................................................................. 481
Creating PartMaterial ............................................................................................................................................................... 481

TABLE OF CONTENTS 24
 Centric 8 REST API DEVELOPER GUIDE

Reading PartMaterial ............................................................................................................................................................... 481

Updating PartMaterial.............................................................................................................................................................. 482
Deleting PartMaterial ............................................................................................................................................................... 482
Attribute List of PartMaterial................................................................................................................................................... 483
PartMaterialColor......................................................................................................................... 486
Reading PartMaterialColor ...................................................................................................................................................... 486
Updating PartMaterialColor..................................................................................................................................................... 486
Method: POST & DELETE unsupported ................................................................................................................................... 486
Attribute List of PartMaterialColor.......................................................................................................................................... 487
PartMaterialQuantity ................................................................................................................... 488
Reading PartMaterialQuantity................................................................................................................................................. 488
Creating PartMaterialQuantity ................................................................................................................................................ 488
Deleting PartMaterialQuantity ................................................................................................................................................ 488
Method: PUT is not supported ................................................................................................................................................ 488
Attribute List of PartMaterialQuantity .................................................................................................................................... 489
PartMaterialSize........................................................................................................................... 490
Reading PartMaterialSize ......................................................................................................................................................... 490
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 490
Attribute List of PartMaterialSize ............................................................................................................................................ 490
PartMaterialSizeSpec.................................................................................................................... 491
Reading PartMaterialSizeSpec ................................................................................................................................................. 491
Creating PartMaterialSizeSpec ................................................................................................................................................ 491
Deleting PartMaterialSizeSpec ................................................................................................................................................ 491
Method: PUT is unsupported................................................................................................................................................... 491
Attribute List of PartMaterialSizeSpec .................................................................................................................................... 492
PartMaterialVariation .................................................................................................................. 493
Creating PartMaterialVariation ............................................................................................................................................... 493
Reading PartMaterialVariation ................................................................................................................................................ 493
Updating PartMaterialVariation .............................................................................................................................................. 493
Deleting PartMaterialVariation ............................................................................................................................................... 493
Attribute List of PartMaterialVariation ................................................................................................................................... 494
Attribute Value Considerations ............................................................................................................................................... 494
PBCLineItem ................................................................................................................................. 495
Creating PBCLineItem ............................................................................................................................................................... 495
Reading PBCLineItem ............................................................................................................................................................... 495
Updating PBCLineItem ............................................................................................................................................................. 495
Deleting PBCLineItem ............................................................................................................................................................... 495
Attribute List of PBCLineItem .................................................................................................................................................. 496
Placement .................................................................................................................................... 497
Creating Placement .................................................................................................................................................................. 497
Reading Placement ................................................................................................................................................................... 497
Updating Placement ................................................................................................................................................................. 497
Deleting Placement .................................................................................................................................................................. 497
Attribute List of Placement ...................................................................................................................................................... 498
Price ............................................................................................................................................. 499
Reading Price ............................................................................................................................................................................ 499
Updating Price........................................................................................................................................................................... 499
Deleting Price ............................................................................................................................................................................ 499
Method: POST is unsupported................................................................................................................................................. 499
Attribute List of Price................................................................................................................................................................ 500
PriceList........................................................................................................................................ 501
Creating PriceList ...................................................................................................................................................................... 501

TABLE OF CONTENTS 25
 Centric 8 REST API DEVELOPER GUIDE

Reading PriceList....................................................................................................................................................................... 501

Updating PriceList ..................................................................................................................................................................... 501
Deleting PriceList ...................................................................................................................................................................... 501
Attribute List of Pricellist.......................................................................................................................................................... 502
PriceListRevision ........................................................................................................................... 503
Creating PriceListRevision ........................................................................................................................................................ 503
Reading PriceListRevision......................................................................................................................................................... 503
Updating PriceListRevision....................................................................................................................................................... 503
Method: DELETE unsupported ................................................................................................................................................ 503
Attribute List of PriceListRevision............................................................................................................................................ 504
PrintDesign................................................................................................................................... 505
Creating PrintDesign ................................................................................................................................................................. 505
Reading PrintDesign ................................................................................................................................................................. 505
Updating PrintDesign ............................................................................................................................................................... 505
Deleting PrintDesign ................................................................................................................................................................. 505
Attribute List of PrintDesign .................................................................................................................................................... 506
PrintDesignColor........................................................................................................................... 507
Creating PrintDesignColor ........................................................................................................................................................ 507
Reading PrintDesignColor ........................................................................................................................................................ 507
Updating PrintDesignColor ...................................................................................................................................................... 507
Deleting PrintDesignColor ........................................................................................................................................................ 507
Attribute List of PrintDesignColor ........................................................................................................................................... 508
PrintDesignRevision ...................................................................................................................... 509
Creating PrintDesignRevision................................................................................................................................................... 509
Reading PrintDesignRevision ................................................................................................................................................... 509
Updating PrintDesignRevision ................................................................................................................................................. 509
Method: DELETE Unsupported ................................................................................................................................................ 509
Attribute List of PrintDesignRevision ...................................................................................................................................... 510
PrintPosition ................................................................................................................................. 511
Creating PrintPosition .............................................................................................................................................................. 511
Reading PrintPosition ............................................................................................................................................................... 511
Updating PrintPosition ............................................................................................................................................................. 511
Deleting PrintPosition .............................................................................................................................................................. 511
Attribute List of PrintPosition .................................................................................................................................................. 512
PrintPositionColor......................................................................................................................... 513
Reading PrintPositionColor ...................................................................................................................................................... 513
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 513
Attribute List of PrintPositionColor ......................................................................................................................................... 514
ProductAlternative ....................................................................................................................... 515
Creating ProductAlternative .................................................................................................................................................... 515
Reading ProductAlternative ..................................................................................................................................................... 515
Updating ProductAlternative ................................................................................................................................................... 515
Deleting ProductAlternative .................................................................................................................................................... 515
Attribute List of ProductAlternative ........................................................................................................................................ 516
ProductAlternativeSpecification .................................................................................................... 517
Creating ProductAlternativeSpecification............................................................................................................................... 517
Reading ProductAlternativeSpecification ............................................................................................................................... 517
Updating ProductAlternativeSpecification ............................................................................................................................. 517
Deleting ProductAlternativeSpecification............................................................................................................................... 517
Attribute List of ProductAlternativeSpecification .................................................................................................................. 518
ProductBlendedCost ..................................................................................................................... 519
Creating ProductBlendedCost.................................................................................................................................................. 519

TABLE OF CONTENTS 26
 Centric 8 REST API DEVELOPER GUIDE

Reading ProductBlendedCost .................................................................................................................................................. 519

Updating ProductBlendedCost ................................................................................................................................................ 519
Deleting ProductBlendedCost.................................................................................................................................................. 520
Attribute List of ProductBlendedCost ..................................................................................................................................... 520
ProductColorShipment .................................................................................................................. 521
Reading ProductColorShipment .............................................................................................................................................. 521
Updating ProductColorShipment ............................................................................................................................................ 521
Method: POST, DELETE unsupported...................................................................................................................................... 521
Attribute List of ProductColorShipment ................................................................................................................................. 521
ProductGroup ............................................................................................................................... 522
Creating ProductGroup ............................................................................................................................................................ 522
Reading ProductGroup ............................................................................................................................................................. 522
Updating ProductGroup ........................................................................................................................................................... 522
Deleting ProductGroup ............................................................................................................................................................ 522
Attribute List of ProductGroup ................................................................................................................................................ 523
ProductGroupDimension............................................................................................................... 524
Creating ProductGroupDimension .......................................................................................................................................... 524
Reading ProductGroupDimension ........................................................................................................................................... 524
Updating ProductGroupDimension ......................................................................................................................................... 524
Deleting ProductGroupDimension .......................................................................................................................................... 524
Attribute List of ProductGroupDimension .............................................................................................................................. 525
ProductSalesRegion ...................................................................................................................... 526
Creating ProductSalesRegion................................................................................................................................................... 526
Reading ProductSalesRegion ................................................................................................................................................... 526
Updating ProductSalesRegion ................................................................................................................................................. 526
Deleting ProductSalesRegion ................................................................................................................................................... 526
Attribute List of ProductSalesRegion ...................................................................................................................................... 527
ProductSalesRegionSpec ............................................................................................................... 528
Reading ProductSalesRegionSpec ........................................................................................................................................... 528
Method: POST, PUT & DELETE unsupported .......................................................................................................................... 528
Attribute List of ProductSalesRegionSpec .............................................................................................................................. 528
ProductShipment .......................................................................................................................... 529
Creating ProductShipment....................................................................................................................................................... 529
Reading ProductShipment ....................................................................................................................................................... 529
Updating ProductShipment ..................................................................................................................................................... 529
Method: DELETE unsupported ................................................................................................................................................ 529
Attribute List of ProductShipment .......................................................................................................................................... 530
ProductSize................................................................................................................................... 531
Creating ProductSize ................................................................................................................................................................ 531
Reading ProductSize ................................................................................................................................................................. 531
Updating ProductSize ............................................................................................................................................................... 531
Deleting ProductSize ................................................................................................................................................................ 532
Attribute List of ProductSize .................................................................................................................................................... 532
ProductSource .............................................................................................................................. 533
Creating ProductSource ........................................................................................................................................................... 533
Reading ProductSource ............................................................................................................................................................ 533
Updating ProductSource .......................................................................................................................................................... 533
Deleting ProductSource ........................................................................................................................................................... 534
Attribute List of ProductSource ............................................................................................................................................... 534
ProductPresentation ..................................................................................................................... 535
Reading ProductPresentation .................................................................................................................................................. 535
Attribute List of ProductPresentation ..................................................................................................................................... 535

TABLE OF CONTENTS 27
 Centric 8 REST API DEVELOPER GUIDE

ProductPresentationLayout .......................................................................................................... 537

Reading ProductPresentationLayout ...................................................................................................................................... 537
Attribute List of ProductPresentationLayout ......................................................................................................................... 537
ProductPresentationSet ................................................................................................................ 538
Reading ProductPresentationSet ............................................................................................................................................ 538
Attribute List of ProductPresentationSet................................................................................................................................ 538
ProductSymbol ............................................................................................................................. 539
Creating ProductSymbol .......................................................................................................................................................... 539
Reading ProductSymbol ........................................................................................................................................................... 539
Updating ProductSymbol ......................................................................................................................................................... 539
Deleting ProductSymbol........................................................................................................................................................... 539
Attribute List of ProductSymbol .............................................................................................................................................. 540
Project.......................................................................................................................................... 541
Creating Project ........................................................................................................................................................................ 541
Reading Project ......................................................................................................................................................................... 541
Updating Project ....................................................................................................................................................................... 541
Deleting Project ........................................................................................................................................................................ 541
Attribute Summary ................................................................................................................................................................... 542
ProjectLineItem ............................................................................................................................ 543
Creating ProjectLineItem ......................................................................................................................................................... 543
Reading ProjectLineItem .......................................................................................................................................................... 543
Updating ProjectLineItem ........................................................................................................................................................ 543
Deleting ProjectLineItem ......................................................................................................................................................... 543
Attribute Summary ................................................................................................................................................................... 544
PropertiesDataSheet..................................................................................................................... 545
Creating PropertiesDataSheet ................................................................................................................................................. 545
Reading PropertiesDataSheet .................................................................................................................................................. 545
Updating PropertiesDataSheet ................................................................................................................................................ 545
Deleting PropertiesDataSheet ................................................................................................................................................. 545
Attribute List of PropertiesDataSheet ..................................................................................................................................... 546
PropertiesDataSheetRevision ........................................................................................................ 547
Creating PropertiesDataSheetRevision ................................................................................................................................... 547
Reading PropertiesDataSheetRevision.................................................................................................................................... 547
Updating PropertiesDataSheetRevision.................................................................................................................................. 547
Method: DELETE unsupported ................................................................................................................................................ 547
Attribute List of PropertiesDataSheetRevision....................................................................................................................... 548
ProvinceState ............................................................................................................................... 549
Creating ProvinceState ............................................................................................................................................................. 549
Reading ProvinceState ............................................................................................................................................................. 549
Updating ProvinceState ........................................................................................................................................................... 549
Deleting ProvinceState ............................................................................................................................................................. 549
Attribute List of ProvinceState ................................................................................................................................................ 550
PurchaseOrder.............................................................................................................................. 551
Creating PurchaseOrder ........................................................................................................................................................... 551
Reading PurchaseOrder ........................................................................................................................................................... 551
Updating PurchaseOrder.......................................................................................................................................................... 551
Deleting PurchaseOrder ........................................................................................................................................................... 551
Attribute List of PurchaseOrder............................................................................................................................................... 552
PurchaseOrderColor ..................................................................................................................... 554
Reading PurchaseOrderColor .................................................................................................................................................. 554
Updating PurchaseOrderColor................................................................................................................................................. 554
Method: POST & DELETE unsupported ................................................................................................................................... 554

TABLE OF CONTENTS 28
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PurchaseOrderColor...................................................................................................................................... 555

PurchaseOrderProduct.................................................................................................................. 556
Reading PurchaseOrderProduct .............................................................................................................................................. 556
Updating PurchaseOrderProduct ............................................................................................................................................ 556
Method: POST, DELETE unsupported...................................................................................................................................... 556
Attribute List of PurchaseOrderProduct ................................................................................................................................. 557
Question....................................................................................................................................... 558
Creating Question ..................................................................................................................................................................... 558
Reading Question ..................................................................................................................................................................... 558
Updating Question ................................................................................................................................................................... 558
Deleting Question ..................................................................................................................................................................... 558
Attribute List of Question......................................................................................................................................................... 559
QuestionRevision .......................................................................................................................... 560
Creating QuestionRevision....................................................................................................................................................... 560
Reading QuestionRevision ....................................................................................................................................................... 560
Updating QuestionRevision ..................................................................................................................................................... 560
Method: DELETE Unsupported ................................................................................................................................................ 560
Attribute List of QuestionRevision .......................................................................................................................................... 561
QuestionSubsection ...................................................................................................................... 562
Creating QuestionSubsection .................................................................................................................................................. 562
Reading QuestionSubsection ................................................................................................................................................... 562
Updating QuestionSubsection ................................................................................................................................................. 562
Deleting QuestionSubsection .................................................................................................................................................. 562
Attribute List of QuestionSubsection ...................................................................................................................................... 563
RecipeDataSheetRevision ............................................................................................................. 564
Reading RecipeDataSheetRevision .......................................................................................................................................... 564
Attribute Summary ................................................................................................................................................................... 564
ReviewColorway ........................................................................................................................... 567
Creating ReviewColorway ........................................................................................................................................................ 567
Reading ReviewColorway ......................................................................................................................................................... 567
Updating ReviewColorway ....................................................................................................................................................... 567
Deleting ReviewColorway ........................................................................................................................................................ 567
Attribute List of ReviewColorway ............................................................................................................................................ 568
ReviewColorwayRevision .............................................................................................................. 569
Creating ReviewColorwayRevision .......................................................................................................................................... 569
Reading ReviewColorwayRevision........................................................................................................................................... 569
Updating ReviewColorwayRevision ......................................................................................................................................... 569
Method: DELETE unsupported ................................................................................................................................................ 569
Attribute List of ReviewColorwayRevision .............................................................................................................................. 570
ReviewSKU ................................................................................................................................... 571
Creating ReviewSKU ................................................................................................................................................................. 571
Reading ReviewSKU .................................................................................................................................................................. 571
Updating ReviewSKU ................................................................................................................................................................ 571
Deleting ReviewSKU ................................................................................................................................................................. 571
Attribute List of ReviewSKU ..................................................................................................................................................... 572
ReviewSKURevision....................................................................................................................... 573
Creating ReviewSKURevision ................................................................................................................................................... 573
Reading ReviewSKURevision.................................................................................................................................................... 573
Updating ReviewSKURevision .................................................................................................................................................. 573
Method: DELETE unsupported ................................................................................................................................................ 573
Attribute List of ReviewSKURevision ....................................................................................................................................... 574
ReviewStyle .................................................................................................................................. 575

TABLE OF CONTENTS 29
 Centric 8 REST API DEVELOPER GUIDE

Creating ReviewStyle ................................................................................................................................................................ 575

Reading ReviewStyle ................................................................................................................................................................ 575
Updating ReviewStyle .............................................................................................................................................................. 575
Deleting ReviewStyle ................................................................................................................................................................ 575
Attribute List of ReviewStyle ................................................................................................................................................... 576
ReviewStyleRevision ..................................................................................................................... 577
Creating ReviewStyleRevision.................................................................................................................................................. 577
Reading ReviewStyleRevision .................................................................................................................................................. 577
Updating ReviewStyleRevision ................................................................................................................................................ 577
Method: DELETE unsupported ................................................................................................................................................ 577
Attribute List of ReviewStyleRevision ..................................................................................................................................... 578
Role .............................................................................................................................................. 579
Creating Role ............................................................................................................................................................................. 579
Reading Role ............................................................................................................................................................................. 579
Updating Role ........................................................................................................................................................................... 579
Deleting Role ............................................................................................................................................................................. 579
Attribute List of Role ................................................................................................................................................................ 580
Routing ........................................................................................................................................ 581
Creating Routing ....................................................................................................................................................................... 581
Reading Routing........................................................................................................................................................................ 581
Updating Routing ...................................................................................................................................................................... 581
Deleting Routing ....................................................................................................................................................................... 581
Attribute List of Routing ........................................................................................................................................................... 582
RoutingGroup ............................................................................................................................... 583
Creating RoutingGroup ............................................................................................................................................................ 583
Reading RoutingGroup ............................................................................................................................................................. 583
Updating RoutingGroup ........................................................................................................................................................... 583
Deleting RoutingGroup............................................................................................................................................................. 583
Attribute List of RoutingGroup ................................................................................................................................................ 584
RoutingItem ................................................................................................................................. 585
Creating RoutingItem ............................................................................................................................................................... 585
Reading RoutingItem ................................................................................................................................................................ 585
Updating RoutingItem .............................................................................................................................................................. 585
Deleting RoutingItem ............................................................................................................................................................... 585
Attribute List of RoutingItem ................................................................................................................................................... 586
RoutingRevision............................................................................................................................ 587
Creating RoutingRevision ......................................................................................................................................................... 587
Reading RoutingRevision.......................................................................................................................................................... 587
Updating RoutingRevision........................................................................................................................................................ 587
Method: DELETE unsupported ................................................................................................................................................ 587
Attribute List of RoutingRevision............................................................................................................................................. 588
SalesDivision................................................................................................................................. 589
Creating SalesDivision .............................................................................................................................................................. 589
Reading SalesDivision ............................................................................................................................................................... 589
Updating SalesDivision ............................................................................................................................................................. 589
Deleting SalesDivision .............................................................................................................................................................. 589
Attribute List of SalesDivision .................................................................................................................................................. 590
SalesMarket ................................................................................................................................. 591
Creating SalesMarket ............................................................................................................................................................... 591
Reading SalesMarket ................................................................................................................................................................ 591
Updating SalesMarket .............................................................................................................................................................. 591
Deleting SalesMarket ............................................................................................................................................................... 591

TABLE OF CONTENTS 30
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesMarket ................................................................................................................................................... 592

SalesOrder .................................................................................................................................... 593
Creating SalesOrder.................................................................................................................................................................. 593
Reading SalesOrder .................................................................................................................................................................. 593
Updating SalesOrder ................................................................................................................................................................ 593
Deleting SalesOrder .................................................................................................................................................................. 593
Attribute List of SalesOrder ..................................................................................................................................................... 594
SalesOrderLineItem ...................................................................................................................... 596
Creating SalesOrderLineItem ................................................................................................................................................... 596
Reading SalesOrderLineItem.................................................................................................................................................... 596
Updating SalesOrderLineItem.................................................................................................................................................. 596
Deleting SalesOrderLineItem ................................................................................................................................................... 596
Attribute List of SalesOrderLineItem....................................................................................................................................... 597
SalesOrderLineItemSKU ................................................................................................................ 598
Creating SalesOrderLineItemSKU ............................................................................................................................................ 598
Reading SalesOrderLineItemSKU ............................................................................................................................................. 598
Updating SalesOrderLineItemSKU ........................................................................................................................................... 598
Deleting SalesOrderLineItemSKU ............................................................................................................................................ 598
Attribute List of SalesOrderLineItemSKU ................................................................................................................................ 599
Sample ......................................................................................................................................... 600
Creating Sample ........................................................................................................................................................................ 600
Reading Sample ........................................................................................................................................................................ 600
Updating Sample ...................................................................................................................................................................... 600
Deleting Sample ........................................................................................................................................................................ 600
Attribute List of Sample ........................................................................................................................................................... 601
SamplingPlan ............................................................................................................................... 602
Creating SamplingPlan ............................................................................................................................................................. 602
Reading SamplingPlan .............................................................................................................................................................. 602
Updating SamplingPlan ............................................................................................................................................................ 602
Deleting SamplingPlan.............................................................................................................................................................. 602
Attribute List of SamplingPlan ................................................................................................................................................. 603
SamplingPlanItem ........................................................................................................................ 604
Creating SamplingPlanItem...................................................................................................................................................... 604
Reading SamplingPlanItem ...................................................................................................................................................... 604
Updating SamplingPlanItem .................................................................................................................................................... 604
Deleting SamplingPlanItem ...................................................................................................................................................... 604
Attribute List of SamplingPlanItem ......................................................................................................................................... 605
Season.......................................................................................................................................... 606
Creating Season ........................................................................................................................................................................ 606
Reading Season ......................................................................................................................................................................... 606
Updating Season ....................................................................................................................................................................... 606
Deleting Season ........................................................................................................................................................................ 606
Attribute List of Season ............................................................................................................................................................ 607
SelectSet....................................................................................................................................... 608
Creating SelectSet ..................................................................................................................................................................... 608
Reading SelectSet ..................................................................................................................................................................... 608
Updating SelectSet ................................................................................................................................................................... 608
Deleting SelectSet ..................................................................................................................................................................... 609
Attribute List of SelectSet ........................................................................................................................................................ 609
SelectSetItem................................................................................................................................ 610
Creating SelectSetItem ............................................................................................................................................................. 610
Reading SelectSetItem ............................................................................................................................................................. 610

TABLE OF CONTENTS 31
 Centric 8 REST API DEVELOPER GUIDE

Updating SelectSetItem............................................................................................................................................................ 610

Deleting SelectSetItem ............................................................................................................................................................. 610
Attribute List of SelectSetItem................................................................................................................................................. 611
SelectSetSubtype .......................................................................................................................... 612
Reading SelectSetSubtype ....................................................................................................................................................... 612
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 612
Attribute List of SelectSetSubtype........................................................................................................................................... 612
Shape ........................................................................................................................................... 613
Creating Shape .......................................................................................................................................................................... 613
Reading Shape .......................................................................................................................................................................... 613
Updating Shape......................................................................................................................................................................... 613
Deleting Shape .......................................................................................................................................................................... 613
Attribute list of Shape .............................................................................................................................................................. 614
ShapeMaster ................................................................................................................................ 615
Creating ShapeMaster .............................................................................................................................................................. 615
Reading ShapeMaster .............................................................................................................................................................. 615
Updating ShapeMaster ............................................................................................................................................................ 615
Method: DELETE is Unsupported ............................................................................................................................................ 615
Attribute List of ShapeMaster ................................................................................................................................................. 616
ShapeSecurityGroup ..................................................................................................................... 617
Creating ShapeSecurityGroup.................................................................................................................................................. 617
Reading ShapeSecurityGroup .................................................................................................................................................. 617
Updating ShapeSecurityGroup ................................................................................................................................................ 617
Deleting ShapeSecurityGroup.................................................................................................................................................. 617
Attribute List of ShapeSecurityGroup ..................................................................................................................................... 618
SharedCrew .................................................................................................................................. 619
Reading SharedCrew ................................................................................................................................................................ 619
Updating SharedCrew .............................................................................................................................................................. 619
Method: POST, DELETE are Unsupported ............................................................................................................................... 619
Attribute List of SharedCrew ................................................................................................................................................... 619
SharedTeam ................................................................................................................................. 620
Creating SharedTeam ............................................................................................................................................................... 620
Reading SharedTeam................................................................................................................................................................ 620
Updating SharedTeam .............................................................................................................................................................. 620
Deleting SharedTeam ............................................................................................................................................................... 620
Attribute List of SharedTeam ................................................................................................................................................... 621
Shipment ...................................................................................................................................... 622
Creating Shipment .................................................................................................................................................................... 622
Reading Shipment..................................................................................................................................................................... 622
Updating Shipment ................................................................................................................................................................... 622
Deleting Shipment .................................................................................................................................................................... 622
Attribute List of Shipment ........................................................................................................................................................ 623
ShipmentQCIssue.......................................................................................................................... 624
Creating ShipmentQCIssue ...................................................................................................................................................... 624
Reading ShipmentQCIssue ....................................................................................................................................................... 624
Updating ShipmentQCIssue ..................................................................................................................................................... 624
Deleting ShipmentQCIssue ...................................................................................................................................................... 624
Attribute List of ShipmentQCIssue .......................................................................................................................................... 625
ShipmentTerm .............................................................................................................................. 626
Creating ShipmentTerm ........................................................................................................................................................... 626
Reading ShipmentTerm ............................................................................................................................................................ 626
Updating ShipmentTerm .......................................................................................................................................................... 626

TABLE OF CONTENTS 32
 Centric 8 REST API DEVELOPER GUIDE

Deleting ShipmentTerm ........................................................................................................................................................... 626

Attribute List of ShipmentTerm ............................................................................................................................................... 627
ShippingContainer ........................................................................................................................ 629
Creating ShippingContainer ..................................................................................................................................................... 629
Reading ShippingContainer...................................................................................................................................................... 629
Updating ShippingContainer .................................................................................................................................................... 629
Deleting ShippingContainer ..................................................................................................................................................... 629
Attribute List of ShippingContainer ......................................................................................................................................... 630
ShippingPort................................................................................................................................. 631
Creating ShippingPort .............................................................................................................................................................. 631
Reading ShippingPort ............................................................................................................................................................... 631
Updating ShippingPort ............................................................................................................................................................. 631
Deleting ShippingPort............................................................................................................................................................... 631
Attribute List of ShippingPort .................................................................................................................................................. 632
ShippingRate ................................................................................................................................ 633
Creating ShippingRate .............................................................................................................................................................. 633
Reading ShippingRate............................................................................................................................................................... 633
Updating ShippingRate............................................................................................................................................................. 633
Deleting ShippingRate .............................................................................................................................................................. 633
Attribute List of ShippingRate.................................................................................................................................................. 634
SizeChart ...................................................................................................................................... 635
Creating SizeChart .................................................................................................................................................................... 635
Reading SizeChart ..................................................................................................................................................................... 635
Updating SizeChart ................................................................................................................................................................... 635
Deleting SizeChart .................................................................................................................................................................... 635
Attribute List of SizeChart ........................................................................................................................................................ 636
SizeChartDimension ...................................................................................................................... 637
Creating SizeChartDimension .................................................................................................................................................. 637
Reading SizeChartDimension ................................................................................................................................................... 637
Updating SizeChartDimension ................................................................................................................................................. 637
Deleting SizeChartDimension .................................................................................................................................................. 637
Attribute List of SizeChartDimension ...................................................................................................................................... 638
SizeChartReview ........................................................................................................................... 639
Creating SizeChartReview ........................................................................................................................................................ 639
Reading SizeChartReview ......................................................................................................................................................... 639
Updating SizeChartReview ....................................................................................................................................................... 639
Deleting SizeChartReview ........................................................................................................................................................ 640
Attribute List of SizeChartReview ............................................................................................................................................ 640
SizeChartReviewDimension ........................................................................................................... 641
Reading SizeChartReviewDimension ....................................................................................................................................... 641
Method: POST, PUT, DELETE unsupported ............................................................................................................................. 641
Attribute List of SizeChartReviewDimension .......................................................................................................................... 641
SizeChartReviewRevision .............................................................................................................. 642
Reading SizeChartReviewRevision........................................................................................................................................... 642
Method: POST, PUT, DELETE unsupported ............................................................................................................................. 642
Attribute List of SizeChartReviewRevision .............................................................................................................................. 643
SizeChartReviewSize ..................................................................................................................... 644
Reading SizeChartReviewSize .................................................................................................................................................. 644
Method: POST, PUT, DELETE unsupported ............................................................................................................................. 644
Attribute List of SizeChartReviewSize ..................................................................................................................................... 644
SizeChartRevision ......................................................................................................................... 645
Creating SizeChartRevision ...................................................................................................................................................... 645

TABLE OF CONTENTS 33
 Centric 8 REST API DEVELOPER GUIDE

Reading SizeChartRevision ....................................................................................................................................................... 645

Updating SizeChartRevision ..................................................................................................................................................... 645
Method: DELETE is Unsupported ............................................................................................................................................ 645
Attribute List of SizeChartRevision .......................................................................................................................................... 646
SizeChartSubtype.......................................................................................................................... 648
Creating SizeChartSubtype....................................................................................................................................................... 648
Reading SizeChartSubtype ....................................................................................................................................................... 648
Updating SizeChartSubtype ..................................................................................................................................................... 648
Deleting SizeChartSubtype....................................................................................................................................................... 648
Attribute List of SizeChartSubtype .......................................................................................................................................... 649
SizeCurve ...................................................................................................................................... 650
Creating SizeCurve .................................................................................................................................................................... 650
Reading SizeCurve .................................................................................................................................................................... 650
Updating SizeCurve................................................................................................................................................................... 650
Deleting SizeCurve .................................................................................................................................................................... 650
Attribute List of SizeCurve........................................................................................................................................................ 651
SizeLabel ...................................................................................................................................... 652
Creating SizeLabel..................................................................................................................................................................... 652
Reading SizeLabel ..................................................................................................................................................................... 652
Updating SizeLabel ................................................................................................................................................................... 652
Deleting SizeLabel ..................................................................................................................................................................... 652
Attribute List of SizeLabel ........................................................................................................................................................ 652
SizeLabelSize ................................................................................................................................ 654
Creating SizeLabelSize .............................................................................................................................................................. 654
Reading SizeLabelSize............................................................................................................................................................... 654
Updating SizeLabelSize ............................................................................................................................................................. 654
Deleting SizeLabelSize .............................................................................................................................................................. 654
Attribute List of SizeLabelSize .................................................................................................................................................. 655
SizeMap ....................................................................................................................................... 656
Creating SizeMap ...................................................................................................................................................................... 656
Reading SizeMap....................................................................................................................................................................... 656
Updating SizeMap..................................................................................................................................................................... 656
Deleting SizeMap ...................................................................................................................................................................... 656
Attribute List of SizeMap.......................................................................................................................................................... 657
SizeMapSize ................................................................................................................................. 658
Creating SizeMapSize ............................................................................................................................................................... 658
Reading SizeMapSize ................................................................................................................................................................ 658
Updating SizeMapSize .............................................................................................................................................................. 658
Deleting SizeMapSize ............................................................................................................................................................... 658
Attribute List of SizeMapSize ................................................................................................................................................... 659
SizeRange ..................................................................................................................................... 660
Creating SizeRange ................................................................................................................................................................... 660
Reading SizeRange .................................................................................................................................................................... 660
Updating SizeRange .................................................................................................................................................................. 660
Deleting SizeRange ................................................................................................................................................................... 660
Attribute List of SizeRange ....................................................................................................................................................... 661
SizeSpec........................................................................................................................................ 662
Creating SizeSpec...................................................................................................................................................................... 662
Reading SizeSpec ...................................................................................................................................................................... 662
Updating SizeSpec .................................................................................................................................................................... 662
Deleting SizeSpec ...................................................................................................................................................................... 662
Attribute List of SizeSpec ......................................................................................................................................................... 663

TABLE OF CONTENTS 34
 Centric 8 REST API DEVELOPER GUIDE

SKU .............................................................................................................................................. 664

Creating SKU ............................................................................................................................................................................. 664
Reading SKU .............................................................................................................................................................................. 664
Updating SKU ............................................................................................................................................................................ 664
Deleting SKU.............................................................................................................................................................................. 664
Attribute List of SKU ................................................................................................................................................................. 665
SKUMaterial ................................................................................................................................. 666
Creating SKUMaterial ............................................................................................................................................................... 666
Reading SKUMaterial................................................................................................................................................................ 666
Updating SKUMaterial .............................................................................................................................................................. 666
Deleting SKUMaterial ............................................................................................................................................................... 666
Attribute List of SKUMaterial ................................................................................................................................................... 667
SKUMaterialSource....................................................................................................................... 668
Reading SKUMaterialSource .................................................................................................................................................... 668
Updating SKUMaterialSource .................................................................................................................................................. 668
Method: POST & DELETE unsupported ................................................................................................................................... 668
Attribute List of SKUMaterialSource ....................................................................................................................................... 668
SKUSource .................................................................................................................................... 669
Reading SKUSource................................................................................................................................................................... 669
Updating SKUSource................................................................................................................................................................. 669
Method: POST & DELETE unsupported ................................................................................................................................... 669
Attribute List of SKUSource...................................................................................................................................................... 669
SMProduct.................................................................................................................................... 670
Reading SMProduct .................................................................................................................................................................. 670
Updating SMProduct ................................................................................................................................................................ 670
Deleting SMProduct ................................................................................................................................................................. 670
Method: POST is unsupported................................................................................................................................................. 670
Attribute List of SMProduct ..................................................................................................................................................... 670
SMProductColor ........................................................................................................................... 673
Reading SMProductColor ......................................................................................................................................................... 673
Updating SMProductColor ....................................................................................................................................................... 673
Deleting SMProductColor ........................................................................................................................................................ 673
Method: POST is unsupported................................................................................................................................................. 673
Attribute List of SMProductColor ............................................................................................................................................ 674
SMProductSKU ............................................................................................................................. 675
Reading SMProductSKU ........................................................................................................................................................... 675
Updating SMProductSKU ......................................................................................................................................................... 675
Method: POST & DELETE are unsupported ............................................................................................................................ 675
Attribute List of SMProductSKU .............................................................................................................................................. 676
SourcingCapability........................................................................................................................ 677
Creating SourcingCapability ..................................................................................................................................................... 677
Reading SourcingCapability ..................................................................................................................................................... 677
Updating SourcingCapability.................................................................................................................................................... 677
Deleting SourcingCapability ..................................................................................................................................................... 677
Attribute List of SourcingCapability......................................................................................................................................... 678
SpecDataSheetSubtype ................................................................................................................. 679
Creating SpecDataSheetSubtype ............................................................................................................................................. 679
Reading SpecDataSheetSubtype ............................................................................................................................................. 679
Updating SpecDataSheetSubtype............................................................................................................................................ 679
Deleting SpecDataSheetSubtype ............................................................................................................................................. 679
Attribute List of SpecDataSheetSubtype................................................................................................................................. 680
SpecificationDataSheet................................................................................................................. 681

TABLE OF CONTENTS 35
 Centric 8 REST API DEVELOPER GUIDE

Creating SpecificationDataSheet ............................................................................................................................................. 681

Reading SpecificationDataSheet.............................................................................................................................................. 681
Updating SpecificationDataSheet ............................................................................................................................................ 681
Deleting SpecificationDataSheet ............................................................................................................................................. 682
Attribute List of SpecificationDataSheet ................................................................................................................................. 682
SpecificationDataSheetItem.......................................................................................................... 683
Reading SpecificationDataSheetItem ...................................................................................................................................... 683
Updating SpecificationDataSheetItem .................................................................................................................................... 683
Deleting SpecificationDataSheetItem ..................................................................................................................................... 683
Method: POST is unsupported................................................................................................................................................. 683
Attribute List of SpecificationDataSheetItem ......................................................................................................................... 684
SpecificationDataSheetResponseItem ........................................................................................... 685
Reading SpecificationDataSheetResponseItem...................................................................................................................... 685
Updating SpecificationDataSheetResponseItem.................................................................................................................... 685
Method: POST & DELETE unsupported ................................................................................................................................... 685
Attribute List of SpecificationDataSheetResponseItem......................................................................................................... 686
SpecificationDataSheetRevision .................................................................................................... 687
Creating SpecificationDataSheetRevision ............................................................................................................................... 687
Reading SpecificationDataSheetRevision ............................................................................................................................... 687
Updating SpecificationDataSheetRevision.............................................................................................................................. 687
Method: DELETE is unsupported ............................................................................................................................................. 687
Attribute List of SpecificationDataSheetRevision................................................................................................................... 688
SpecificationDataSheetSupplierResponse...................................................................................... 689
Reading SpecificationDataSheetSupplierResponse ............................................................................................................... 689
Updating SpecificationDataSheetSupplierResponse.............................................................................................................. 689
Method: POST & DELETE unsupported ................................................................................................................................... 689
Attribute List of SpecificationDataSheetResponseItem......................................................................................................... 690
SpecificationDataSheetSupplierResponseRevision ......................................................................... 691
Creating SpecificationDataSheetSupplierResponseRevision ................................................................................................. 691
Reading SpecificationDataSheetSupplierResponseRevision ................................................................................................. 691
Updating SpecificationDataSheetSupplierResponseRevision ............................................................................................... 691
Method: DELETE is unsupported ............................................................................................................................................. 692
Attribute List of SpecificationDataSheetRevision................................................................................................................... 692
SpecificationItemDefinition........................................................................................................... 693
Creating SpecificationItemDefinition ...................................................................................................................................... 693
Reading SpecificationItemDefinition....................................................................................................................................... 693
Updating SpecificationItemDefinition ..................................................................................................................................... 693
Deleting SpecificationItemDefinition ...................................................................................................................................... 693
Attribute List of SpecificationItemDefinition .......................................................................................................................... 694
SpecificationSection...................................................................................................................... 695
Creating SprecificationSection................................................................................................................................................. 695
Reading SpecificationSection................................................................................................................................................... 695
Updating SpecificationSection ................................................................................................................................................. 695
Deleting SpecificationSection .................................................................................................................................................. 695
Attribute List of SpecificationSection ...................................................................................................................................... 696
SpecificationSectionDefinition....................................................................................................... 697
Creating SpecificationSectionDefinition ................................................................................................................................. 697
Reading SpecificationSectionDefinition .................................................................................................................................. 697
Updating SpecificationSectionDefinition ................................................................................................................................ 697
Deleting SpecificationSectionDefinition ................................................................................................................................. 697
Attribute List of SpecificationSectionDefinition ..................................................................................................................... 698
SpecificationSectionItem............................................................................................................... 699

TABLE OF CONTENTS 36
 Centric 8 REST API DEVELOPER GUIDE

Creating SpecificationSectionItem .......................................................................................................................................... 699

Reading SpecificationSectionItem ........................................................................................................................................... 699
Updating SpecificationSectionItem ......................................................................................................................................... 699
Deleting SpecificationSectionItem .......................................................................................................................................... 699
Attribute List of SpecificationSectionItem .............................................................................................................................. 700
SpecLibraryItem Deprecated ......................................................................................................... 701
Creating SpecLibraryItem ......................................................................................................................................................... 701
Reading SpecLibraryItem ......................................................................................................................................................... 701
Updating SpecLibraryItem ....................................................................................................................................................... 701
Deleting SpecLibraryItem ......................................................................................................................................................... 701
Attribute List of SpecLibraryItem ............................................................................................................................................ 702
SRLineItem ................................................................................................................................... 703
Creating SRLineItem ................................................................................................................................................................. 703
Reading SRLineItem .................................................................................................................................................................. 703
Updating SRLineItem ................................................................................................................................................................ 703
Deleting SRLineItem ................................................................................................................................................................. 703
Attribute List of SRLineItem ..................................................................................................................................................... 704
Stock Order................................................................................................................................... 705
Creating StockOrder ................................................................................................................................................................. 705
Reading StockOrder.................................................................................................................................................................. 705
Updating StockOrder ................................................................................................................................................................ 705
Deleting StockOrder ................................................................................................................................................................. 705
Attribute List of StockOrder ..................................................................................................................................................... 706
Style ............................................................................................................................................. 707
Creating or Copying a Style ...................................................................................................................................................... 707
Copying a Colorway to a Style ................................................................................................................................................. 707
Reading Style............................................................................................................................................................................. 708
Updating/moving Style............................................................................................................................................................. 708
Deleting Style ............................................................................................................................................................................ 709
Attribute List of Style ................................................................................................................................................................ 709
Attribute Value Considerations ............................................................................................................................................... 711
StyleCopyOption ........................................................................................................................... 712
Reading StyleType .................................................................................................................................................................... 712
Method: POST, PUT, DELETE unsupported ............................................................................................................................. 712
Attribute List of StyleCopyOption............................................................................................................................................ 712
StyleType ...................................................................................................................................... 713
Creating StyleType .................................................................................................................................................................... 713
Reading StyleType .................................................................................................................................................................... 713
Updating StyleType................................................................................................................................................................... 713
Deleting StyleType .................................................................................................................................................................... 713
Attribute List of StyleType........................................................................................................................................................ 714
StyleSupplierAttributes ................................................................................................................. 715
Reading StyleSupplierAttributes.............................................................................................................................................. 715
Updating StyleSupplierAttributes ............................................................................................................................................ 715
Method: POST, DELETE are Unsupported ............................................................................................................................... 715
Attribute List of StyleSupplierAttributes ................................................................................................................................. 715
SubQuestion ................................................................................................................................. 716
Creating SubQuestion............................................................................................................................................................... 716
Reading SubQuestion ............................................................................................................................................................... 716
Updating SubQuestion ............................................................................................................................................................. 716
Deleting SubQuestion............................................................................................................................................................... 716
Attribute List of SubQuestion .................................................................................................................................................. 717

TABLE OF CONTENTS 37
 Centric 8 REST API DEVELOPER GUIDE

SubRouting ................................................................................................................................... 718

Creating SubRouting ................................................................................................................................................................. 718
Reading SubRouting ................................................................................................................................................................. 718
Updating SubRouting ............................................................................................................................................................... 718
Deleting SubRouting ................................................................................................................................................................. 718
Attribute List of SubRouting .................................................................................................................................................... 719
SubRoutingItem............................................................................................................................ 720
Creating SubRoutingItem ......................................................................................................................................................... 720
Reading SubRoutingItem.......................................................................................................................................................... 720
Updating SubRoutingItem........................................................................................................................................................ 720
Deleting SubRoutingItem ......................................................................................................................................................... 720
Attribute List of SubRoutingItem............................................................................................................................................. 721
SubRoutingRevision ...................................................................................................................... 722
Creating SubRoutingRevision................................................................................................................................................... 722
Reading SubRoutingRevision ................................................................................................................................................... 722
Updating SubRoutingRevision ................................................................................................................................................. 722
Method: DELETE is unsupported ............................................................................................................................................. 722
Attribute List of SubRoutingRevision ...................................................................................................................................... 723
Supplier ........................................................................................................................................ 724
Creating Supplier ...................................................................................................................................................................... 724
Reading Supplier ....................................................................................................................................................................... 724
Updating Supplier ..................................................................................................................................................................... 724
Deleting Supplier ...................................................................................................................................................................... 724
Attribute List of Supplier .......................................................................................................................................................... 725
SupplierContractualDocument ...................................................................................................... 727
Creating SupplierContractualDocument ................................................................................................................................. 727
Reading SupplierContractualDocument ................................................................................................................................. 727
Updating SupplierContractualDocument................................................................................................................................ 727
Deleting SupplierContractualDocument ................................................................................................................................. 727
Attribute List of SupplierContractualDocument..................................................................................................................... 728
SupplierDiscount........................................................................................................................... 729
Creating SupplierDiscount ....................................................................................................................................................... 729
Reading SupplierDiscount ........................................................................................................................................................ 729
Updating SupplierDiscount ...................................................................................................................................................... 729
Deleting SupplierDiscount........................................................................................................................................................ 729
Attribute List of SupplierDiscount ........................................................................................................................................... 730
SupplierItem ................................................................................................................................. 731
Creating SupplierItem .............................................................................................................................................................. 731
Reading SupplierItem ............................................................................................................................................................... 731
Updating SupplierItem ............................................................................................................................................................. 731
Deleting SupplierItem............................................................................................................................................................... 731
Attribute List of SupplierItem .................................................................................................................................................. 732
SupplierItemRevision .................................................................................................................... 733
Creating revision for SupplierItemRevision ............................................................................................................................ 733
Reading SupplierItemRevision ................................................................................................................................................. 733
Updating SupplierItemRevision ............................................................................................................................................... 733
Method: DELETE is unsupported ............................................................................................................................................. 733
Attribute List of SupplierItemRevision .................................................................................................................................... 734
SupplierRequest............................................................................................................................ 737
Creating SupplierRequest......................................................................................................................................................... 737
Reading SupplierRequest ......................................................................................................................................................... 737
Updating SupplierRequest ....................................................................................................................................................... 737

TABLE OF CONTENTS 38
 Centric 8 REST API DEVELOPER GUIDE

Deleting SupplierRequest......................................................................................................................................................... 737

Attribute Value Considerations ............................................................................................................................................... 737
Attribute List of SupplierRequest ............................................................................................................................................ 738
SupplierRequestTemplate ............................................................................................................. 739
Creating SupplierRequestTemplate ........................................................................................................................................ 739
Reading SupplierRequestTemplate ......................................................................................................................................... 739
Updating SupplierRequestTemplate ....................................................................................................................................... 739
Deleting SupplierRequestTemplate......................................................................................................................................... 739
Attribute List of SupplierRequestTemplate ............................................................................................................................ 740
SupplierReview ............................................................................................................................. 741
Creating SupplierReview .......................................................................................................................................................... 741
Reading SupplierReview ........................................................................................................................................................... 741
Updating SupplierReview ......................................................................................................................................................... 741
Deleting SupplierReview .......................................................................................................................................................... 741
Attribute List of SupplierReview .............................................................................................................................................. 742
Test .............................................................................................................................................. 743
Creating Test ............................................................................................................................................................................. 743
Reading Test .............................................................................................................................................................................. 743
Updating Test ............................................................................................................................................................................ 743
Deleting Test ............................................................................................................................................................................. 743
Attribute List of Test ................................................................................................................................................................. 744
TestRun ........................................................................................................................................ 745
Creating TestRun ...................................................................................................................................................................... 745
Reading TestRun ....................................................................................................................................................................... 745
Updating TestRun ..................................................................................................................................................................... 745
Deleting TestRun....................................................................................................................................................................... 746
Attribute List of TestRun .......................................................................................................................................................... 746
TestRunRevision ........................................................................................................................... 747
Creating TestRunRevision ........................................................................................................................................................ 747
Reading TestRunRevision ......................................................................................................................................................... 747
Updating TestRunRevision ....................................................................................................................................................... 747
Method: DELETE is Unsupported ............................................................................................................................................ 747
Attribute List of TestRunRevision ............................................................................................................................................ 748
TestRunSection ............................................................................................................................. 750
Reading TestRunSection........................................................................................................................................................... 750
Method: POST, PUT, DELETE are Unsupported ...................................................................................................................... 750
Attribute List of TestRunSection.............................................................................................................................................. 751
TestSpec ....................................................................................................................................... 752
Creating TestSpec ..................................................................................................................................................................... 752
Reading TestSpec ...................................................................................................................................................................... 752
Updating TestSpec .................................................................................................................................................................... 752
Deleting TestSpec ..................................................................................................................................................................... 752
Attribute List of TestSpec ......................................................................................................................................................... 753
TestSpecGroup ............................................................................................................................. 754
Creating TestSpecGroup........................................................................................................................................................... 754
Reading TestSpecGroup ........................................................................................................................................................... 754
Updating TestSpecGroup ......................................................................................................................................................... 754
Deleting TestSpecGroup........................................................................................................................................................... 754
Attribute List of TestSpecGroup .............................................................................................................................................. 755
TestSpecRevision .......................................................................................................................... 756
Creating TestSpecRevision ....................................................................................................................................................... 756
Reading TestSpecRevision........................................................................................................................................................ 756

TABLE OF CONTENTS 39
 Centric 8 REST API DEVELOPER GUIDE

Updating TestSpecRevision ...................................................................................................................................................... 756

Method: DELETE is Unsupported ............................................................................................................................................ 756
Attribute List of TestSpecRevision........................................................................................................................................... 757
TestSpecSubtype........................................................................................................................... 758
Reading TestSpecSubtype ........................................................................................................................................................ 758
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 758
Attribute List of TestSpecSubtype ........................................................................................................................................... 759
Theme .......................................................................................................................................... 760
Creating Theme......................................................................................................................................................................... 760
Reading Theme ......................................................................................................................................................................... 760
Updating Theme ....................................................................................................................................................................... 760
Deleting Theme......................................................................................................................................................................... 760
Attribute List of Theme ............................................................................................................................................................ 761
ThemeMaster ............................................................................................................................... 762
Creating ThemeMaster ............................................................................................................................................................ 762
Reading ThemeMaster ............................................................................................................................................................. 762
Updating ThemeMaster ........................................................................................................................................................... 762
Deleting ThemeMaster............................................................................................................................................................. 762
Attribute List of ThemeMaster ................................................................................................................................................ 763
ThemeMasterSubtype................................................................................................................... 764
Creating ThemeMasterSubtype............................................................................................................................................... 764
Reading ThemeMasterSubtype ............................................................................................................................................... 764
Updating ThemeMasterSubtype ............................................................................................................................................. 764
Deleting ThemeMasterSubtype ............................................................................................................................................... 764
Attribute List of ThemeMasterSubtype .................................................................................................................................. 765
ThemeProductAlternative ............................................................................................................. 766
Creating ThemeProductAlternative ........................................................................................................................................ 766
Reading ThemeProductAlternative ......................................................................................................................................... 766
Updating ThemeProductAlternative ....................................................................................................................................... 766
Deleting ThemeProductAlternative......................................................................................................................................... 766
Attribute List of ThemeProductAlternative ............................................................................................................................ 767
ThemeSecurityGroup .................................................................................................................... 768
Creating ThemeSecurityGroup ................................................................................................................................................ 768
Reading ThemeSecurityGroup ................................................................................................................................................. 768
Updating ThemeSecurityGroup ............................................................................................................................................... 768
Deleting ThemeSecurityGroup ................................................................................................................................................ 768
Attribute List of ThemeSecurityGroup .................................................................................................................................... 769
User ............................................................................................................................................. 770
Creating User ............................................................................................................................................................................ 770
Reading User ............................................................................................................................................................................. 770
Updating User ........................................................................................................................................................................... 770
Method: DELETE is unsupported ............................................................................................................................................. 770
Attribute List of User ................................................................................................................................................................ 771
ValueAttributeDefinition............................................................................................................... 772
Reading ValueAttributeDefinition ........................................................................................................................................... 772
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 772
Attribute List of ValueAttributeDefinition .............................................................................................................................. 772
UserDefaults................................................................................................................................. 773
How to enable UserDefaults .................................................................................................................................................... 773
Reading UserDefaults ............................................................................................................................................................... 773
Updating UserDefaults ............................................................................................................................................................. 773
Deleting UserDefaults .............................................................................................................................................................. 773

TABLE OF CONTENTS 40
 Centric 8 REST API DEVELOPER GUIDE

Method: POST is unsupported................................................................................................................................................. 773

Attribute List of User ................................................................................................................................................................ 774
6. UTILITY API ................................................................................................................................... 775
Aggregate Store APIs .................................................................................................................... 775
Why Aggregate Store is needed .............................................................................................................................................. 775
Aggregate Store APIs Explanation ........................................................................................................................................... 775
API 1........................................................................................................................................................................................... 775
API 2........................................................................................................................................................................................... 777
APISearch ..................................................................................................................................... 780
Reading APISearch .................................................................................................................................................................... 780
Method: POST, PUT, and DELETE are unsupported. .............................................................................................................. 782
Usage Note ................................................................................................................................................................................ 782
To obtain a exhaustive list of C8 REST API endpoint names: ................................................................................................ 782
To obtain samples of attributes of a particular datatype: ..................................................................................................... 783
To obtain a list of parent APIs having a reference of a particular class:............................................................................... 789
ConfigUpdate ............................................................................................................................... 791
Triggering the Update-Config job ............................................................................................................................................ 791
Reading Update-Configuration Job status .............................................................................................................................. 791
Method: PUT & DELETE unsupported ..................................................................................................................................... 792
Attribute List of ConfigUpdate................................................................................................................................................. 792
Count ........................................................................................................................................... 793
Reading Count........................................................................................................................................................................... 793
URL: ObjectName in CamelCase .............................................................................................................................................. 793
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 793
Attribute List of Count .............................................................................................................................................................. 793
Email ............................................................................................................................................ 794
Creating Email ........................................................................................................................................................................... 794
Method: GET, PUT & DELETE are unsupported ...................................................................................................................... 794
Attribute List of Email............................................................................................................................................................... 794
ExportImportJob ........................................................................................................................... 795
Creating ExportImportJob and uploading Job config file....................................................................................................... 795
Reading ExportImportJob ........................................................................................................................................................ 795
Updating ExportImportJob....................................................................................................................................................... 795
Deleting ExportImportJob ........................................................................................................................................................ 795
Attribute List of ExportImportJob............................................................................................................................................ 796
Attribute details ........................................................................................................................................................................ 796
Example: using ExportImportJob ............................................................................................................................................. 797
Example: Uploading an Export/Import Job............................................................................................................................. 798
Example: Downloading an Export/Import Job........................................................................................................................ 798
Job ............................................................................................................................................... 800
Reading Jobs.............................................................................................................................................................................. 800
Updating Job ............................................................................................................................................................................. 800
Attribute List of Job .................................................................................................................................................................. 801
License ......................................................................................................................................... 802
Reading License ........................................................................................................................................................................ 802
Method: POST, PUT & DELETE are unsupported.................................................................................................................... 802
Attribute List of License............................................................................................................................................................ 802
Log ............................................................................................................................................... 803
Reading a list of Centric Log file name and details................................................................................................................. 803
Getting a Log file stream to download.................................................................................................................................... 803
Method: POST, PUT, DELETE are unsupported ...................................................................................................................... 803
Example: Downloading a specified Log file............................................................................................................................ 804

TABLE OF CONTENTS 41
 Centric 8 REST API DEVELOPER GUIDE

ObjectTree.................................................................................................................................... 805
Querying Business Object Tree ................................................................................................................................................ 805
Method: POST, PUT, DELETE are unsupported ...................................................................................................................... 805
Example 1: using ObjectTree ................................................................................................................................................... 806
Example 2: ................................................................................................................................................................................. 808
Session ......................................................................................................................................... 810
Creating a new C8 API Session (login) ..................................................................................................................................... 810
Read, Update of Session is unsupported ................................................................................................................................ 810
Deleting (invalidating) a user session (logout) ....................................................................................................................... 811
Session Create Request Attributes .......................................................................................................................................... 811
Session Create Response Attributes ....................................................................................................................................... 811
Example: AUTHENTICATING USING SESSION ........................................................................................................................ 813
Version ......................................................................................................................................... 815
Reading Version ........................................................................................................................................................................ 815
Method: POST, PUT, DELETE are unsupported ...................................................................................................................... 815
Attribute List of Version ........................................................................................................................................................... 815
ClassRelationships ........................................................................................................................ 816
Querying ClassRelationship...................................................................................................................................................... 816
Example ..................................................................................................................................................................................... 816
ClassRelationship.......................................................................................................................... 819
7. SAMPLE UTILITY CODES IN JAVA.................................................................................................... 821
Creating Time String Parameter.................................................................................................... 821
Encoding and Decoding a URI ....................................................................................................... 822
Java Program example to encode and decode URI ................................................................................................................ 822
Uploading a document using DocumentRevisions ......................................................................... 826
A Java example to show how to upload a document to Centric filevault by using DocumentRevision............................. 826
Uploading a file or a 3D Document using Documents endpoint ..................................................... 827
Uploading a file or a Centric 3D file using the Documents endpoint.................................................................................... 827
8. JAVA SAMPLE REST CLIENT CODE .................................................................................................. 830
How to Setup Development Environment ...................................................................................... 830
Calling Centric REST API using Java ............................................................................................... 831
Client Source Code - TestREST ....................................................................................................... 832
Source Code: CallREST.............................................................................................................................................................. 834
Source Code: HttpResultBean.................................................................................................................................................. 840
Source Code: C8Endpoints ....................................................................................................................................................... 844
9. FAQ .............................................................................................................................................. 846
Object Change Detection .............................................................................................................. 846
REST Session timeout .................................................................................................................... 846
Create an on-line Customers, Suppliers and SalesDivision.............................................................. 847
Assigning a role to the on-line Customers, Suppliers and SalesDivision .......................................... 849
Refset Attribute Changes .............................................................................................................. 850
Calling API in Postman .................................................................................................................. 852
How API attributes behave in Swagger ......................................................................................... 853
Legend ....................................................................................................................................................................................... 853
Attributes and its’s meaning in API definition ........................................................................................................................ 854
10. OBJECT DIAGRAM (UML) ............................................................................................................ 858
Style hierarchy .............................................................................................................................. 858
11. HTTP CODES AND MESSAGES ...................................................................................................... 859

TABLE OF CONTENTS 42
 Centric 8 REST API DEVELOPER GUIDE

12. ERROR CODES AND MESSAGES ................................................................................................... 860

13. URL ENCODED CHARACTER TABLE .............................................................................................. 863
14. CENTRIC SERVER AND REST API LOGS .......................................................................................... 865
Log Analysis.................................................................................................................................. 865
Watching a Running Log in Real Time ..................................................................................................................................... 866
Time-Serial Log Analysis Across All Logs ................................................................................................................................. 869

TABLE OF CONTENTS 43
 Centric 8 REST API DEVELOPER GUIDE

USING THIS GUIDE

This Guide provides details about the Centric 8 and High Speed Exporter REST API. There are
many Java examples and utility code snippets provided to illustrate the API usage. All REST
example codes are provided as is and are not covered by any Centric technical support.

REST API Technical Support

Customer Support is available to all registered users of Centric 8.
866-796-6218 8:00 AM-8:00 PM EST
Email: support@centricsoftware.com

USING THIS GUIDE 44

 Centric 8 REST API DEVELOPER GUIDE

1. API USAGE GUIDELINE

This section provides the guideline details for using C8 Rest APIs. C8 APIs allow for a number of
operations through Rest calls but has a high chance of being consumed for use cases that it is
not designed for. Such APIs usage may result in:

• Databases may take more time to request/response

• CPU spikes occurring during peak transaction period
• Server response times may become inconsistent depending on the number of
parallel/concurrent requests

In few cases, the horizontal scaling can help mitigate performance issues. But the horizontal
scaling comes at a cost and even after scaling horizontally there comes a point in time where
DBs behave inconsistently irrespective of traffic.

Below guidelines/strategies can help customers (SMB/Enterprise) to mitigate such scenarios

when using C8 Rest APIs.

NOTE:

C8 Rest API Development Process:

C8 follows the best practises of developing APIs.

1. Refer this guide on how to ideally use C8 APIs. Especially go through:

• “Limitations” on how C8 APIs are called.

• “HTTP Codes and Messages” on how C8 APIs handle exceptions and error scenarios. It
will help customers handle exceptions properly.

2. Look into caching of values:

• Cache frequently accessed data:

Observe common read/write data that is accessed by multiple users. Such frequently data
types can be cached.

Once there is new content, write to DB, invalidate the cache and update the cache
asynchronously.

API USAGE GUIDELINE 45

 Centric 8 REST API DEVELOPER GUIDE

For example:

There are certain scenario where you would need to perform certain GET action before
you can perform PUT/POST calls. Try caching certain library centric URL in local memory
or DB to reduce making GET calls every time.

GET call(s) related to Master Library data can be cached. For example, Currency, Size(s),
Size Range, etc.

3. Use C8 custom view formats instead of REST endpoint formats:

• Reduce the number of separate GET requests by first defining a C8 custom view
specifying all the related data you need, then issuing GET requests for the custom view
data. This allows you to retrieve data from across object domains, and just the attributes
you want to see. This both reduces the number of GET requests and eliminates the
overhead of retrieving attributes you do not need. You retrieve related matrix details
pre-assembled, having these complex relationships organized for you, based on your
custom view definition. This technique may reduce or eliminate the need for caching
values. Also significantly, there is only a single result node, irrespective of how much data
is returned. This nearly eliminates Java node cache overhead when retrieving thousands
of nodes at a time. Refer to the topic REST GET incremental updates to C8 custom views
for detailed information in the Advanced Administrator Guide – Volume II document.

4. Lookup multiple results in a single request: Instead of looking up REST endpoint data for
individual nodes by url, supply a list of urls to lookup custom view results for multiple
nodes with a single request. Refer to the topic REST GET custom view payload for a list
of nodes for detailed information in the Advanced Administrator Guide – Volume II
document.
5. Look into pagination of calls and not get bulk results: Paginating is one of the ways to
avoid loading C8 server with heavy requests. Wherever C8 provides pagination for its API
calls, try using those parameters.

For example, Rest call to get multiple placements. Use Skip and Limit parameter to avoid
getting a huge result set . Here we are saying get 10 results per rest call.

http://testserver.centricsoftware.com/csi-requesthandler/api/v2/placements?skip=0&limit=10

6. Get the count of records before fetching the total number of records. This will act as a
preliminary check to optimize your api call (via pagination)
7. Reduce query parameters on Get call. Avoid querying on attributes of an object, if
possible. Rather query on the object and parse the result.

API USAGE GUIDELINE 46

 Centric 8 REST API DEVELOPER GUIDE

For example, http://<IP address of the machine>:8080/csi-

requesthandler/api/v2/contractual_document_revisions/C3244

Here you will get the document revision based on id “C3244”.

However if you add custom query parameters to get a more specific result, it may effect
the api performance.

Avoid excessive multiple query parameters to an API.

For example, http://<IP address of the machine>:8080/csi-

requesthandler/api/v2/contractual_document_revisions?custom_param1=123&customer_param2=
abc&customer_param3=123&customer_param4=456

8. API usage is not a high throughput operation. Avoid large data load operation and use
rest calls for targeted operation

Avoid heavy usage of import/export of large files via Rest API. Rest APIs will however
functionally address these operations.

If you are considering high volume operations and throughput look into C8 products to
optimize performance. For example, Centric High Speed Exporter or Import/Export
Gateway

9. Look into Performance Tool:

• If you are facing performance issues, please look into Performance tool. It can be found
under Node Browser > Monitor > Performance.

This tool should give you a fair idea of

o How your Rest calls are performing

o Peak duration time
• Look into pi_rest.log file to see on how Rest calls are performing
• Look into Advance Admin guide for details about Performance tool.

10. Note: Every Rest call to C8 is made through a valid session token. If the session token is
expired, then Rest calls will have to be re-authenticated.
11. If any of the above guidelines are missing, then look into other products to complete
your use case.

API USAGE GUIDELINE 47

 Centric 8 REST API DEVELOPER GUIDE

If you are facing issues with rest performance consistently and have high volume
transactions, please look into other C8 products as such Centric High Speed Exporter or
Import/Export Gateway.

12. Customer can perform a search to find out what API exists in C8:

To find out if an API exists against an object, attribute, etc, you can run the API thats
under:

Node Browser > Behavior > Rest API > api_search

It has various query parameters against which you can perform the search for an API.

13. Multiple REST API login via the same credentials is discouraged:

There exists some contention when multiple parallel logins are performed via the same
user login credentials. This leads to performance issues. Each users should own their C8
login and license, and thus separate information recording their login time, etc.

14. C8 Support Scope:

Centric will support any customer issues related to Rest call failures or bugs.

Customer owns and is fully responsible for their programs (design, development, testing,
maintenance) that incorporate C8 REST API. Any further support in terms of performance
and debugging will be worked under C8 services contract (CAMS/Service Pools).

API USAGE GUIDELINE 48

 Centric 8 REST API DEVELOPER GUIDE

2. CENTRIC 8 REST API

What is the Centric 8 REST API?
Users of the Centric 8 Graphical UI will typically become familiar with a series of visual cues and
clicks to navigate a hierarchy of tabs, grid rows, and links. While visual cues can be helpful, there
are business use-cases that are better served by avoiding them.

Use-cases that benefit from avoiding the UI include very brief tasks at one extreme, also highly
repetitive tasks, and very simple tasks, which would be all the slower if they require a user to
navigate nested tabs and links. Such tasks could be automated by a small script associated with
a button or desktop link. At another extreme, they include highly complex or error-prone tasks,
which may require control by other systems, such as integration with with ERP systems,
dashboards, or even machine learning or AI based expert systems.

The Centric 8 REST API drops the visual cues of the Centric 8 UI and provides a consistent minimal
interface to shorten the access path to Centric 8 data (domain classes) resources. Using the C8
REST API, and your preferred programming language, Centric 8 can be automated, and
integrated with other enterprise systems, web, or mobile applications.

In summary, the REST API provides programmatic access to core C8 resources in tasks which will
benefit from automation, whether due to their extreme brevity, simplicity, or repetition, or, at
another extreme, because of their complexity.

A Note on Terminology
There is a term, “CRUD” that has come to be associated with REST APIs because it is an acronym
for Create, Read, Update and Delete, the operations enabled by an API. The original meaning of
“crud” in English was (and still is) dirt, filth or garbage, or something just irrelevant to the subject
under discussion. Despite the negative associations, the term “CRUD” is often used as verbal
shorthand with regard to APIs.

Our REST API is implemented in HTTP, and its most-used operations: POST, GET, PUT, and DELETE
map to the terms that pertain to “CRUD”. The HTTP-style terms, are not unique in their first
letter, but “CRUD” is, and it maps to each operation uniquely, and without the need to fully spell
out each term. It is also just easier to remember and to say.

So, one will see this term frequently in this Developer Guide and in associated documentation,
often as “full CRUD”, which means that all REST API operations are available for a given domain

CENTRIC 8 REST API 49

 Centric 8 REST API DEVELOPER GUIDE

class. Sometimes, only a subset of CRUD is allowed, such as for read-only endpoints. In those
cases, one usually sees only the applicable terms used, either from “create”, “read”, “update”
and “delete”, or their POST, GET, PUT, and DELETE counterparts.

How to access the C8 REST API

he Centric 8 REST API is based on the HTTP open standard. Using of such a standard is the key to
allowing the use of varied programming languages to automate it. One communicates by making
a standard HTTP request and getting the result back in an HTTP response.

As mentioned, the API allows CRUD operations to be performed by invoking the API using HTTP
POST, GET, PUT and DELETE request methods. The API will restrict the logged-in API user to the
CRUD operations authorized by their C8 role.

What is a Centric 8 REST URI?

The Centric 8 REST URI is a set of HTTP URLs, also known as REST endpoints, through which one
can access the data of various Centric domain classes such as "Season" or "Style".

In web terminology, the classes are called the "resources" and the data is called the
“representation”. The representation is provided in two formats: XML and JSON. CRUD
operations can be performed by calling an endpoint using various HTTP methods.

The parameters and values are passed via URL, HTTP header, and HTTP body. Web technologies
can be used to interact with the REST API including a browser to query any Centric class.

This Developer Guide provides the details necessary to use the Centric 8 REST API, as well as
various working program examples and code.

In addition, the REST API is now integrated with Shadow Tables, providing true incremental
change tracking for REST endpoints, and even incremental change tracking for C8 custom views.
Refer to topics REST GET incremental updates to REST endpoints and REST GET incremental
updates to C8 custom views in the C8 Advanced Administrator Guide – Volume II document.
Using Shadow Table integration, you may also GET a set of nodes at a time REST GET custom
view payload for a list of nodes. For information, refer to the topic REST GET custom view
payload for a list of nodes in the C8 Advanced Administrator Guide – Volume II document.

CENTRIC 8 REST API 50

 Centric 8 REST API DEVELOPER GUIDE

URI SYNTAX

The Centric 8 REST URIs have the following syntax:

http[s]://{c8server}/csi-requesthandler/api/{version}/{resource_path}

where:

▪ http[s]: Is the URI scheme, or protocol, and indicates a clear text

connection under http on port 80, or an encrypted connection under https
on port 443.
▪ {c8server}: The name of the Centric 8 server hosting the REST service. If
the port in use is not the same as the one implied by the scheme, this part
of the URI might end with a colon (“:”) followed by a port number.
▪ csi-requesthandler/api: This should be entered verbatim as it is part of
Centric 8 REST URI.
▪ {version}: The version of the Centric 8 REST APIs, such as v1, v2, v3 etc.
The current version for nearly all endpoints is v2. There are three endpoints:
ApparelBOMRevision, MaterialBOMRevision, and PartMaterial., which have
been released as v3 endpoint to support the new Centric data model.
▪ {resource_path}: A {resource_path} identifies a particular resource and
provides qualifying parameters for the specific resource.
▪ {} Braces ( or “curly brackets”) are used to identify a mandatory
parameter.
▪ [] Brackets (“square brackets”) are used to identify optional parameters.
▪ <> Angle brackets will be used to denote a term with an extended
definition.

VERSION NAMING CONVENTION

A version number such as v2 or v3 in the REST URI as shown in URI Syntax.

CENTRIC 8 REST API 51

 Centric 8 REST API DEVELOPER GUIDE

ENDPOINT EXAMPLES

Endpoint GET PUT POST DELETE

http://c8server/csi Retrieves a collection Creates a new

-requesthandler/v2 of Season resources Season using
/seasons details provided
which match the
optional search and in the POST
control parameters request body
http://c8server/csi Retrieves the details Updates a Deletes a
- of a specific C8 specific C8 specific C8
requesthandler/v2/s Season Season
Season object
easons/C2234 object object
identified by the
resource_id “C2234” identified identified by
by the the
resource_id resource_id
“C2234” “C2234”

Centric Custom Views

Recent enhancements allow for returning the results of a C8 custom view through the REST API
REST GET incremental updates to C8 custom views . This allows a request to span multiple object
domains, as C8 custom views allow for flexible assembly of data via relationships. The custom
view support offers an alternative to the traditional endpoint boundaries. It also reduces the
programming effort to handle complex structures, as the relationships are derived from the
custom view definition and the results per-assembled for you.

CENTRIC 8 REST API 52

 Centric 8 REST API DEVELOPER GUIDE

3. LIMITATIONS
Timestamps in the C8 database are exposed in the C8 REST API, but they are not guaranteed to
be posted in a strictly increasing order. So, they are not reliable for detecting changes.

The reasons are that:

• Timestamps from operations that were started objectively earlier may be more costly in
database operations and time than operations that were actually started later.
• As a result, the earlier operation may show a later date-time than timestamps that were
actually started later.
• Logic based on C8 timestamps will therefore sometimes miss detecting changes.

Adding custom attributes as export switches for REST API requires application logic (outside the
REST API) to set the switches, then follow-up logic to reset the switches after export. Extra logic
needs to be written and maintained, adding overhead to developing the interface.

Both limitations are mitigated using the C8 feature “GET incremental updates to REST
endpoints”.

LIMITATIONS 53
 Centric 8 REST API DEVELOPER GUIDE

4. REST ENDPOINT DETAILS

The Centric 8 REST URI structure is described in the example below:

For example: http://myc8server.com/csi-requesthandler/api/vn/

where “n” is the version number such as 2, 3 etc.

This URI string will prefix all actual request URIs composed from the following documentation.
The documentation uses the ./ prefix to call it out as a partial URI. For example a version 2
session endpoint URI will look like:

http://myc8server.com/csi-requesthandler/api/v2/part_material

and a version 3 call will look like:

http://myc8server.com/csi-requesthandler/api/v3/part_material

In this developer guide, the endpoint URIs are abbreviated as a short form without any
version specific context. So the above two URIs will be shown as:

./part_material

HTTP Request and Response Bodies in the C8 REST API

• One submits data using the body of the HTTP request/ response. The data payload format
can be either JSON or XML. The format being used should be specified in the Content-
Type HTTP request header.
• Centric 8 object attribute names follow the snake case convention where an underscore
character is inserted at the Upper/Lower case transition point such as “my_attribute”.
• Many Business Objects have mandatory create only fields. These are marked in the
endpoint details. If one tries to create an object without passing mandatory attributes, an
error will be presented.
• Read-only fields can not be set in either POST or PUT.
• One should not include fields with empty values in POST or PUT unless it is intended for
the value to be empty in C8.
• The response to POST and PUT always returns a GET resource. Fields with empty values
may be omitted from the GET resource response object.

REST ENDPOINT DETAILS 54

 Centric 8 REST API DEVELOPER GUIDE

Optional “link” header parameter for the ref objects

The response payload only returns the object ID for any referenced object. If passing the
optional “link” parameter in the HTTP header, the response will include an additional section
named “_links”. This section will contain the array of all the URLs of the referenced objects as
shown below.

Custom attributes in REST API

The Centric 8 REST API supports custom attributes. While defining the custom attribute for
any object in the Centric web UI, set the “REST API Exposed” check box to true to expose the
attribute.

Monitoring REST API performance via Response Header profile parameters

The Centric 8 REST API provides valuable profiling parameters in the HTTP response header.
This information can be used to profile any particular endpoint or the integration code to
determine how the query time is consumed by various parts of the Centric server. After
profiling, the information can be used to fine tune the network, CPU, database, or filesystem
for optimum performance.

REST ENDPOINT DETAILS 55

 Centric 8 REST API DEVELOPER GUIDE

The timing parameters are as follows:

Parameter name Details of the time (in millisecond)

PIRequestDBTime JDBC preparation and result parsing time
PIRequestEXTime JDBC query execution time
PIRequestPGTime Centric internal message (patch) generation time
PIRequestRSTime Centric internal Report Service time
PIRequestRXTime Centric internal Report Service execution time
PIRequestTXTime Query transaction time
PIRequestTime Total time of execution
PIReportRequest Centric internal boolean flag, not a time
PIReportService Centric internal boolean flag, not a time
PIRequestId Centric internal request count number, not a time

Custom View alternatives to REST endpoint formats

You can alternatively choose to GET data in a C8 custom view format, as opposed to a REST
endpoint format. This way, you are able to get data related from across object domain
boundaries as a unit, reducing the number of get requests. Your custom views may include
one or more matrices. You will still use REST endpoint formats for POST and PUT calls.

You may also request multiple custom view rows in a single GET call, rather than requesting
just one node at a time. Your custom views may include one or more matrices.

REST ENDPOINT DETAILS 56

 Centric 8 REST API DEVELOPER GUIDE

Authenticating Using REST API

Use the “Session” endpoint to authenticate against the Centric 8 server. This endpoint is
documented in the section Utility API. Please refer to that section for all details about its usage.

The following sequence diagram shows the high level Rest API authentication activity against
the Centric 8 server.

REST ENDPOINT DETAILS 57

 Centric 8 REST API DEVELOPER GUIDE

Fine-Tuning Queries in the C8 REST API

C8 REST API HTTP Queries are a generalized means of interacting with the C8 server. Because
they are generalized, they can be something of a blunt instrument.

REST API queries are usually fine-tuned to elicit exactly the data that is desired by either:

• making settings in configuration files

or
• passing specific extra data in the query

This section only deals with the latter: passing specific data in the query itself.

Passing Specific Extra Data in the Query

One may use any of several means to pass query-specific data into the C8 REST API. These are:

• In the URL endpoint itself: The documented endpoint (any of the endpoints contained
under Domain-Asset related APIs) may contain curly brackets (“{}”), and text referencing
a specific id. Wherever this is so, one will need to ensure that the text, including the
curly brackets, is replaced by an actual id value. An example of such replacement shown
in the second query in the subsection URI Syntax. Note that the value replacing the curly
bracketed text is always a Centric URL, sometimes also known as a CNL.
• As a URL (query) parameter: A query parameter is an optional part of a URL that comes
after the endpoint. When it does occur, it is always after a question mark, “?”, with
different parameters as name value pairs, each pair separated from the other by an
ampersand “&”. Examples are the skip and limit parameters as well as any of the filters,
as well as any <attribute_name>, <attribute_value pairs> used only with GET all queries
to filter down to a particular record or set of records. A complete list of possible
parameters present at the subsection URL (Query) Parameter.
• As an HTTP(S) header: A specific part of the query that is NOT part of the URL. Examples
include the “accept” and “content-type” headers, as well as the “cookie” security
header that is passed when doing query by query authentication. There is at least one,
and possibly more, endpoints which use specific HTTP(s) headers to pass extra data.
OnlineCrew, for example, retrieves the specified online crew for the Supplier, Customer
or SalesDivision as specified in the header parameter “class_name”, the valid values for
which are: “SupplierCrew”, “CustomerCrew”, “SalesDivisionCrew”, and also match the
<filter_parameters>.
• As part of the HTTP(S) request body: Also not part of the URL, usually a JSON or XML
statement of name value pairs.

REST ENDPOINT DETAILS 58

 Centric 8 REST API DEVELOPER GUIDE

A value that is passed in a query is quite often a special construct known as a CURL (for Centric
URL) and sometimes also known as a CNL. The Centric URL is used all throughout the Centric
C8 product to denote specific records. It may (or may not) contain characters that are special
to URL’s.

If you have been reading thoroughly and understanding, you may have noted that the Centric
URL or CURL may be contained in the query URL (either of the two bulleted instances
mentioned above the line: either in the endpoint itself, or in the URL parameters). The
important point here is that sometimes there is a URL embedded… in another URL!

And, sometimes (but not always) the CURL will contain characters that are special to URL’s in
general. In other words, the presence of these special characters can effect changes in the way
that the URL is handled by the browser. To avoid unwanted changes to the way a URL is
handled, the CURL will need to have any URL-special characters protected, or hidden from the
containing URL.

For this reason, CURL’s passed through the URL, whether are In the URL endpoint itself, or as
a URL parameter: are passed as double encoded text. For more information on double-ecoded
Centric URL’s see Encoding Data.

URL (Query) Parameter

This is the most frequently used mechanism to pass parameters in the Centric 8 REST API. It is
simple to use and works with all HTTP methods, however, it has the following limitations:

• the parameters are passed as clear text, so the parameters are not secured from
hackers,
• the number of parameters or values are limited by the HTTP URL length limitation,
• the parameters and values have to be double encoded to comply with the Centric
server standard.

The URL parameters are also referred to as query parameters. They consist of name / value
pairs separated by a logical operator such as an equal (=) sign. A question-mark separates the
first parameter from the resource_path. Additional parameter pairs are separated using an
ampersand (&) character.

REST ENDPOINT DETAILS 59

 Centric 8 REST API DEVELOPER GUIDE

List of valid URL (Query) parameters

Parameter Description Example

• Use this operator to sort in descending http://myc8server/csi-
order requesthandler/api/v2/styles?
sort=-node_name
<filter_ Use filter pamater to query a business http://myc8server/csi-
parameter> objects by passing the name of its requesthandler/api/v2/colorways?
attributes as the filter parameter except description=Arnold%20Rouge This
for the modified_at attribute. The filter will fetch all the colorway/s having
parameter must be the correct attribute
description “Arnold Rouge”. Notice
name for the business object, which is
the URL is double escaped so that
listed in the “Attribute List” table for every
endpoint. the space in “Arnold Rouge” is
replaced by %20
The logical comparison is case sensitive.
Logical operators Use the following logical operator in the Example of =:
filter parameter as described above: description=Arnold%20Rouge
in filter
“=” equals
parameter Example of =!:
“=!” not equal
description=!Arnold%20Rouge
“=ge” greater or equal*
“=gt” greater than* season_date=!2018-12-03T20:00:00Z
“=le” lesser or equal*
“=lt” lesser than* Example of =ge:
• The =ge, =gt, =le, =lt operators will a_number=ge100
only work for numeric or date searching for objects with a_number
attributes greater or equal to 100

Example of =gt:
a_number=gt100
searching for objects with a_number
greater than 100

decoded If the CNL attribute of the object contains http://myc8server/csi-

a special character, then by default GET all requesthandler/api/v2/styles?
REST endpoints returns the special decoded=true
characters encoded in the REST XML or
JSON payload. To turn this auto CNL
encoding feature off, pass decoded=true
parameter in the query.
limit a. limit=n (where 10000>=n>=1) returns http://myc8server/csi-
only n number of objects from entire requesthandler/api/v2/styles?
matching result set of the objects. limit=50 will return maximum 50
b. limit=0 (skip=0 from version 7.0 is style objects
considered invalidparameters. The
support for this parameter is
withdrawn to protect any inadvertent

REST ENDPOINT DETAILS 60

 Centric 8 REST API DEVELOPER GUIDE

Parameter Description Example

or malicious use of this parameter to
trigger large database queries and
potentially making the Centric server http://myc8server/csi-
unresponsive for all users. NOTE: requesthandler/api/v2/styles?
This was supported in pre 7.0
limit=10001 will return an error
releases. Any legacy code using the
C400 as maximum limit value is 10000.
zero parameters should be removed
to prevent errors in the 7.0 and later
REST API.
c. limit=-n (where n is an integer) is an
invalid value for the limit parameter.
It should throw an exception.
d. If no limit parameter is specified, then http://myc8server/csi-
the query will return only 10 objects. requesthandler/api/v2/styles?
In other words, default value for limit limit=0 will return an error C400 as
is 10 minimum limit value is 1.
log_perf Setting this parameter to true will add API http://myc8server/csi-
performance information in the REST API requesthandler/api/v2/styles?
log for that specific API call. log_perf=true
PIRequestTime: <Total exec time>,
PIRequestDBTime: <JDBC prep and parsing
time>,
PIRequestEXTime: <Query execution time>,
PIRequestPGTime: <Patch generation
time>,
PIRequestRSTime: <Report service time>,
PIRequestRXTime: <Report service exec
time>,
PIRequestTXTime: <Transaction time>

modified_before It limits the GET result to resources http://myc8server/csi-

modified on or before the specified time.
The parameter’s value is a date in
yyyy/dd/mmThh:mm:ss.fffZ format. The
.fff portion is optional.
modified_after This parameter’s value is a date in
yyyy/dd/mmThh:mm:ss.fffZ format. It
limits the GET result to resources modified
on or after the specified time. The .fff
portion is optional.
sort Sort the result in ascending order on the
specified attribute.
skip It controls the pagination and the starting
point of the array by skipping the specific
number of objects from the top of the
result set.
requesthandler/api/v2/colorways?
modified_before=2018-02-
21T15:23:45.203Z
http://myc8server/csi-
requesthandler/api/v2/colorways?
modified_after=2017-02-
21T15:23:45.203Z
http://myc8server/csi-
requesthandler/api/v2/styles?
sort=node_name
http://myc8server/csi-
requesthandler/api/v2/styles?
skip=10 will return a object list
starting from 11th object. Skip=0 will

REST ENDPOINT DETAILS 61

 Centric 8 REST API DEVELOPER GUIDE

Parameter Description Example

return the result from the very first
object.
validation Setting this parameter to false in any http://myc8server/csi-
endpoint call will turn off REST data requesthandler/api/v2/styles?
validation for that call. This can provide description=test&validation=false
noticable performance gain in complex
endpoints at the expense of data integrity.
Use this feature with extreme caution only
when you are ingesting high quality
validated data.
action This is a special parameter limited to only
certain endpoints to perform Centric 8
state changes for that objects via the PUT
method. The usage is documented in the
relevant endpoint details. The list of such
endpoints are shown below.

REST ENDPOINT DETAILS 62

 Centric 8 REST API DEVELOPER GUIDE

Encoding Data

Special Characters

The term “special character” is used a lot. But the precise meaning of the term can vary
depending on what is required of characters in a particular area.

In regard to the REST API, a query is always made as an HTTP request, with a URL that requires
handling by the webserver as it comes into the C8 system.

Characters such as colons (“:”), slashes (“/”), are part of the basic URL construct. When used
within URL’s, the question mark (“?”) signals the presence of URL parameters. and ampersands
(“&”) delimit the different name-value pairs when they appear.

Other characters are, such as plain spaces (“ “) are not permitted in a URL and will trigger an
error condition when present.

But sometimes these characters are passed within a URL without the meaning that they usually
have in the URL. Characters such as the question mark (“?”), the ampersand (“&”) may appear
within the data being passed. are not meant as part of the URL, because they are meant to be
consumed within C8, but are, nonetheless, special to URLs in general.

It may be oversimplifying, but generally, any character other than an upper or lower case letter
or a number could be a special characters with regard to data passed via URLs. For brevity,
let’s call these “alphanumeric”. Though some users of this term may include a space and
common punctuation marks as alphanumeric, we don’t. For our purposes, we mean this in the
strictest sense of only alphabetic and only numeric characters.

Special characters, for our purposes, are non-alphanumeric characters.

Special Characters Not Actually Used as Part of the URL Require Encoding

If a special character will be passed as extra data in the URL of a query, it must to be protected
from being “seen” by the server that handles the query.

The way that such characters are protected is by encoding them, so that within a URL, they do
not appear as the special character, but as a sequence of characters that are not special to the
handling of the URL.

When they are encoded, they are encoded by a specific encoding type called either url-
encoding. This is also called “percent-encoding”, due to the fact that a numeric sequence
representing the character is preceded by a percent sign (“%”). A table of such encodings exists

REST ENDPOINT DETAILS 63

 Centric 8 REST API DEVELOPER GUIDE

at URL Encoded Character Table (At present this table does not include anything above lower
case “o”. This is an oversight that will be addressed soon).

In a string such as ‘C0/12|Material’, encoding is obvious, because the encoding causes the
slash (“/”) to change to “%2F” and the pipe to “%7C”: 'C0%2F12%7C'.

The presence or absence of special characters depends on factors that are independent of
any discussed in this section or with the whole of this C8 REST API Programmer’s Guide:

• How the object was imported into the C8 system: importing often embeds non-
alphanumeric data.
• Whether the data allows embedded special characters. Descriptions usually allow any
characters.
• How the data may have been entered, or altered by a rule.

So, there is no controlling the data as to the special characters that may appear. This means
that any solution for handling special characters must be consistently applied.

A string may very well have been encoded, in that it actually underwent the process of
encoding, but the encoding does not cause any character to change. For example, in a string
such as “C2315”, no character is special, and even though it has been encoded, no change can
be seen. The encoded instance of this string is the same as the original: “C2315”.

For this reason, it can confuse the issue (and is incorrect) to say that this string “is not
encoded” based solely on whether it contains encoded characters. Statements about whether
a string is encoded or not are best based whether encoding is made necessary by the
circumstances, NOT on whether any encoded characters exist in the string.

Special Characters are Single-Encoded Inside C8

Apart from the requirements of the URL, special characters are encoded inside the C8 engine
when they occur inside CURLs, or CNLs. When using the C8 product via a browser, the
encoding can be seen in the location field of the browser.

Of special concern to the REST API, such Centric URLs (CURLS, or CNLs) are encoded when
they occur in the response to a REST query.

Encoding can be applied multiple times to the same string, and it turns out that there is a
practical reason for distinguishing between multiple encoding and single encoding as we will
see further on. For our purposes, we need to point out here that encoding of characters
within C8 is always single-encoding: The encoding is applied exactly once.

REST ENDPOINT DETAILS 64

 Centric 8 REST API DEVELOPER GUIDE

Centric-URLs (CNLs) occurring in a response to a query are single-encoded.

There may be situations where the encoding done by C8 is not wanted, such as in the headers
or body (payload) of a query. For such situations, there is a query parameter: decoded=true
that is used when getting the values. More explanation of this and other query parameters
exists at URL (Query) Parameter.

The Swagger Page “Helps” by Doing One Layer of Encoding

A REST API implemented using the Swagger toolkit (as ours is) uses the Swagger page is the
reference implementation. The Swagger page is simplified and optimized for ease of use.

A very common set of actions with the REST API is to use a general GET to get several objects,
copy the id value of one of them as an identifier of that particular object, and use it in another
query. The query may be a GET single on just that object, or a POST in a parent class to create
a new subordinate object.

The design of the Swagger page allows copying of the text of an id value in a response, and
pasting it into a field in the Swagger page field which then supplies that value in a query.
When the Swagger page builds a URL, the code behind the Swagger page implementation will
add a layer of encoding to the field contents. Since the CURL (or CNL) that comes out of a
previous query response is single-encoded, the layer of encoding added by the Swagger
implementation makes it double-encoded.

In one sense, the whole Swagger page operation works very smoothly with only a need for a
copy to the system clipboard, then a paste from the clipboard into a field. No intervening re-
encoding is required.

In another sense, the Swagger page operation hides a step from the user, and seems to
indicate that single-encoding is all that is required. The fact that the second layer of encoding
occurs, but is hidden from the Swagger page user, but can be verified. The Swagger page
response is to redisplay the URL that was used in the query. One will see that the encoding of
any CURL (CNL) in the redisplayed URL is different than the original in the field. It has been re-
encoded.

Do not be misled by the fact that the Swagger page adds one layer of encoding. Failing to
understand this point can lead to the misconception that only single-encoding is necessary.

Headers and Body are Unencoded

Header Parameters passed as key value pairs. The keys and values should never be encoded
and should be passed as un-encoded text.

Body (also frequently called the “payload”) passed through HTTP request or response as
plain un-encoded text in both the XML and JSON payload. If the parameter value contains any

REST ENDPOINT DETAILS 65

 Centric 8 REST API DEVELOPER GUIDE

special characters, then put the value within the CDATA section in XML payload, to prevent
any XML parsing errors. In the JSON payload, no special treatment is necessary.

How to double encode URL parameter

Encoding and decoding should performed as per UTF-8 standard (RFC 3629). Double
encoding and decoding utility program samples in java and javascript are provided in
“Encoding and Decoding a URI”.

API Header(s)

Parameter Description Example

append_images This header is applicable
to all PUT objects that
makes changes in image.
It accepts below two
values :

True : Add to existing

images in the object.
False: Default behavior,
that is, the images passed
as part of the API call will
be overwritten over the
existing ones.

Custom Expression Validation in REST API

Prior to the 7.1 release, the REST API always validated the entire payload whenever a PUT
method was called, however, the Centric web app only validates the attributes which are
actually changed and does not validate the attributes which are not changed. This subtle
difference in validation behavior between the REST API and Centric Web app was causing
errors in the REST PUT call due to custom expression validation failure. These errors were
coming up in corner cases where the custom expression validation became invalid due the
new object update, but such error never occurs in Centric Web app as that expression never
got evaluated due the web apps selective validation business logic. This issue has been
resolved in 7.1 and the REST API only validates the changed attributes in the payload.

If you encounter any such issue in Centric 7.0 or a prior version of REST API, please contact
Centric support for a service pack.

REST ENDPOINT DETAILS 66

 Centric 8 REST API DEVELOPER GUIDE

Authenticating to the Centric 8 Server

Use the “Session” endpoint to authenticate against the Centric 8 server. This endpoint is
grouped under the utility endpoints in the section Utility API. Please refer to the that section
to get all details about its usage.

REST ENDPOINT DETAILS 67

 Centric 8 REST API DEVELOPER GUIDE

Configuring the Centric Server for REST

There are few special configurations required in the Centric Server before the REST API can be
used and custom attributes can be accessed. Some of the configuration is done by Centric
Business Consultants when the Server is provisioned and others are done by the developers or
Centric Users in Centric UI configuration screen after adding new custom attributes.
The details of the configuration are given below:

Centric Server Configuration

The up to date information of the Centric 8 Server configuration is documented in the “Centric
8 Installation Guide”. Please refer to this document under the CONFIGURATION AND TESTING
chapter for details.

Custom Attribute Configuration

By default, any newly created custom attributes are not exposed and editable by the REST API.
You can, however, change the REST API accessibility through simple configuration change using
Centric 8 Web application attribute configuration page shown below:

REST ENDPOINT DETAILS 68

 Centric 8 REST API DEVELOPER GUIDE

REST ENDPOINT DETAILS 69

 Centric 8 REST API DEVELOPER GUIDE

REST access configuration options

1. Rest API Exposed
Set this flag to expose a custom attribute to the REST API. By default this flag is not
set, therefore, a newly created custom attribute will be absent in the REST GET
Payload.

2. REST Restricted
Set this flag to expose a custom attribute to the REST API. By default this flag is not set,
therefore, a newly created custom attribute will be absent in the REST GET Payload.

Error: Cannot change 'my_custom_attribute' on 'C7928'. Can't change field

'my_custom_attribute' on node 'Node(C7928)'. It is marked as read-only.

3. REST Update
Checking the REST Update flag makes the custom attribute editable by the REST API
even though it might be hidden or have restricted edit capability in Centric 8 Web UI.
This is useful to restrict the editing of the attribute from the Centric UI but want to
update the attribute programmatically through the REST API.

Rest Restricted and REST Update are mutually exclusive, which

means both flags cannot be set at the same time. If both are set, the
Centric 8 Web interface will present an error.

Wild-Card Search
With 7.3 release (backported to 7.2), API users are able to perform the following kind of
searches against attributes that are directly associated with the object. This kind of search
also works against domain object attributes from its child classes. The attributes against
which such a search would not work are usually those attributes whose relationship is
ref(reference) with the object:
Wild-Card Search
Case-Insensitive Search
Partial Match Search
The syntax to execute the search is:
▪ GET: API URL?parameter_name:wcm=*value*
▪ This kind of search is only available for GET method.

REST ENDPOINT DETAILS 70

 Centric 8 REST API DEVELOPER GUIDE

Below are the use cases that help users understand the various ways such searches work in a
GET call:

API Call Kind of Search Performed

https://demo.centricsoftware.com/csi-
requesthandler/api/v2/seasons?skip=0&limit=1
0&node_name:wcm=*win*
https://demo.centricsoftware.com/csi-
requesthandler/api/v2/seasons?skip=0&limit=1
0&node_name:wcm=04*
https://demo.centricsoftware.com/csi-
requesthandler/api/v2/seasons?skip=0&limit=1
0&node_name:wcm=02*8
https://demo.centricsoftware.com/csi-
requesthandler/api/v2/seasons?skip=0&limit=1
0&node_name:wcm=02 – Summer 2018
• Returns all season that contains the word
“win“ word in it.
• The results are case insensitive
• Returns all season starting with word “04”
• The results are case insensitive
• Returns all the seasons starting with 02 and
ending with 8
• The results are case insensitive
• Returns an exact match of the season

There are two limitations to perform wildcard search:

1. The search would not work on attributes that is two level below the class. Example
“documents” for Style endpoint. Its two levels path:
“Style:DocumentsAndComments:Documents”

A specific error message has been added for such cases.

Example: “Query parameter name: 'documents:wcm'. Parameter value: 'C%8'. Cannot

perform wcm search more than one
level:Child:DocumentsAndComments/Attribute:Documents”
The attribute relationship should not be a ref(reference) against the object which user is
making the wildcard search call.

Users can find this error in pi_rest.log.

REST API Log

The REST API logs all activity in a log file. Depending on the Centric Server deployment type,
this log file name and location varies.

Centric REST Log file name Located at

Deployment
Type
Standard large pi_rest.log Centric 8 log folder. Check Server
deployment installation guide for details.
SMB deployment

REST ENDPOINT DETAILS 71

 Centric 8 REST API DEVELOPER GUIDE

The default log format is as follows:

[YYYY-MM-DD HH:MM:SS,Milisecond] [LogLevel] [REST (RequestId)] – LogDetails

The RequestId is the unique identifier of a particular REST API request. The RequestId is used
to identify log entries belonging to the same request. It is helpful because usually the log has
interleaved entries from different requests running in parallel.

Some examples are given below:

[2019-11-12 14:42:50,654] [INFO ] [REST (121)] -- REST API call to 'https://

centric8/csi-requesthandler/api/v2/color_materials/centric%3A%2F%2FAPPAREL%2
FColorMaterial%2FAccessory1%2F1/data_sheets/color_data_sheets' using POST me
thod
[2019-11-12 14:42:50,716] [ERROR] [REST (121)] -- Error code: C100. Attribu
te 'subtype' is required. Field 'subtype' must be set to create a new instan
ce.: com.centricsoftware.pi.rest.api.exception.AttributeRequiredException: E
rror code: C100. Attribute 'subtype' is required. Field 'subtype' must be s
et to create a new instance.

How to log API execution time

The add log_perf=true parameter can be added while invoking a REST endpoint to log
timing information for that specific call. The timing parameter details are as follows:

Parameter name Details of the time (in millisecond)

PIRequestDBTime JDBC preparation and result parsing time
PIRequestEXTime JDBC query execution time
PIRequestPGTime Centric internal message (patch) generation time
PIRequestRSTime Centric internal Report Service time
PIRequestRXTime Centric internal Report Service execution time
PIRequestTXTime Query transaction time
PIRequestTime Total time of execution
PIReportRequest Centric internal boolean flag, not a time
PIReportService Centric internal boolean flag, not a time
PIRequestId Centric internal request count number, not a time

Should any of these timers go very high, one will know where to start looking deeper in order
to understand the underlying performance issue.

It is important to understand that these are just a high-level summary to give that first cut of
where an issue is, or is not. If the application server itself is running slow, it can cloud the values
since they are all elapsed time, not CPU time, so it is just a guide for where to look next.

REST ENDPOINT DETAILS 72

 Centric 8 REST API DEVELOPER GUIDE

Example:

To see how much time the Colorway endpoint takes to retrieve a specific Colorway object
with CNL c1234:
https://centric8/csi-requesthandler/api/v2/colorways/c1234?log_perf=true

It will log something like this:

[2019-11-13 14:39:13,537] [INFO ] [REST (176)] -- REST API call to 'https://

centric8/csi-requesthandler/api/v2/colorways/centric%3A%2F%2FAPPAREL%2FColor
way%2F1_2?log_perf=true' using GET method. Processing time: PIRequestRXTime
: 0, PIRequestTime: 1, PIRequestTXTime: 0, PIRequestPGTime: 0, PIRequestRSTi
me: 0, PIRequestVLTime: 0, PIRequestDBTime: 0, PIRequestEXTime: 0

Since a single Colorway instance has been fetched, the response will be very fast, and most
parameters will be rounded to zero as they are very small. However, if a bigger result-set is
fetched, then positive values will be visible in the timing parameter representing the time
taken in milliseconds:

[2019-11-13 15:18:32,279] [INFO ] [REST (602)] -- REST API call to 'https://

centric8/csi-requesthandler/api/v2/colorways?log_perf=true' using GET method
. Processing time: PIRequestRXTime: 0, PIRequestTime: 77, PIRequestTXTime:
0, PIRequestPGTime: 0, PIRequestRSTime: 0, PIRequestVLTime: 0, PIRequestDBTi
me: 71, PIRequestEXTime: 65

How to enable Splunk and LaaS compatible log

The REST API log by default is in the Centric log format. To change the format to a Key:Value
pair, the following http header parameter needs to be added to every REST API call. The
Key:Value format makes it easier for LaaS (Logging as a Service) like Splunk to parse the REST
API logs.

Header Parameter: logformat = keyvalue

If no log format header parameter is passed, the REST call will be logged in default Centric Log
format.

Log levels in keyvalue format

Log level = INFO
message, endpoint_class, method (REST API method: GET, PUT, etc.), node_type, node_cnl,
node_name, parent_node_cnl, parent_node_name, attribute_id, user_id, user_name with
every REST API call (could be more than one message per call)

REST ENDPOINT DETAILS 73

 Centric 8 REST API DEVELOPER GUIDE

NOTE: If a value is “null” or “” then the info will not be available for that log message.
Log level = DEBUG
payload and node’s attributes (“node_attributes”) will be also logged. Payload will be stored
in key=’value’ format. Attribute will be in “Attribute(ID=<attribute name>, Value=<attribute
value>),” format, for an example: “Attribute(ID=DocumentsAndComments,
Value=Node(C3404)), “

REST Interaction with Centric FileVault

Digital drawings, pdf, Word, Excel, text, 3D meshes or other types of digital assets can be
uploaded to certain business objects in Centric 8. These business objects (Style, Material, etc)
have been enabled to support Docs & Comments. The upload happens from the user’s local
filesystem to the Centric server and the file is streamed via TCP/IP over https protocol. If the
user is using the Centric web application, then the browser sends the file to the Centric server
as multipart payload. When using the REST API to upload a file, the process remains the same,
a multi part payload has to be built to upload file/s and stream the file to the REST API endpoint.

Filevault
The uploaded digital asset binaries are stored in a folder named “Filevault” of a Direct Attached
or Network Attached file system. The Centric Server strips out the file name and mime type of
the digital asset and replaces it with a GUID in the filevault. This provides additional security
from unauthorized filevault folder access as the accessor will have no idea about the file
content by looking at those GUIDs. When the file is downloaded via the Centric web application
or the REST API, the Centric server provides the proper filename and mime type while
streaming it back to the client machine.

Concept of Document Revision

Docs & Comments enabled objects can have multiple documents and each of them may have
multiple revisions. To support this model, the Centric server creates a new Document Revision
object to track each and every uploaded digital asset. For example, if a PDF file is uploaded to
a Style, the Centric Server creates a new DocumentRevision object for that style and then stores
the metadata of the PDF file in the DocumentRevision object attribute. If you upload another
version of that PDF file, the Centric server creates another DocumentRevision object and stores
the second PDF metadata in this new DocumentRevision object.

Centric digital asset persistence does not preserve the original file
permission or creation date time stamp. The downloaded file date
time stamp will reflect the date and time when the file was saved in
the file vault.

REST ENDPOINT DETAILS 74

 Centric 8 REST API DEVELOPER GUIDE

Running Same Validation Rules for REST and UI Calls

If the user wants to run the same validation rule against nodes for REST and UI call, make sure
that the validation rules assigned to REST Validation and Default group are the same:

Both “Default” and “REST Validation” groups are OOTB validation

groups that allow to run validation rules against node from UI and
REST calls, respectively.

For example,
If the user requires that a Style node is created and description is mandatory for both UI and
REST calls.
1. Create the validation rule under Style object. Assign the rule to “Default” validation
group.

2. Go to Validation Group tab , create the REST Validation group and assign the same rule
to the REST Validation group.

REST ENDPOINT DETAILS 75

 Centric 8 REST API DEVELOPER GUIDE

3. Follow the same process for the Default validation group.

REST ENDPOINT DETAILS 76

 Centric 8 REST API DEVELOPER GUIDE

5. DOMAIN-ASSET RELATED APIs

AcceptanceLimit
Creating AcceptanceLimit
Method: POST
URI Relative Path Comments

./acceptance_limits Creates a new AcceptanceLimit Object.

Reading AcceptanceLimit
Method: GET
URI Relative Path Comments

./acceptance_limits/{acceptance_ Retrieves the specified AcceptanceLimit object.

limit_id}

./acceptance_limits[?[skip=m][[& Retrieves the AcceptanceLimit objects which match the

]limit=n][[&<filter_parameters>] <filter_parameters>
..]

Updating AcceptanceLimit
Method: PUT
URI Relative Path Comments

./acceptance_limits/{ Updates the specified AcceptanceLimit object.

acceptance_limit_id}

Deleting AcceptanceLimit
Method: DELETE
URI Relative Path Comments

./acceptance_limits/{ Deletes the specified AcceptanceLimit object.

acceptance_limit_id}

DOMAIN-ASSET RELATED APIs 77

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of AcceptanceLimit

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
sort_order Integer integer R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 78

 Centric 8 REST API DEVELOPER GUIDE

AffectedItem
Creating AffectedItem
Method:POST
URI Relative Path Comments

./engineering_changes/{engineer Creates a new AffectedItem object as a child of

ing_change_id}/affected_items EngineeringChange.

Reading AffectedItem
Method:GET
URI Relative Path Comments

./engineering_changes/{engineeri Retrieves the AffectedItem objects referenced by

ng_change_id}/affected_items[?[s EngineeringChange which match filter parameters specified
kip=m][[&]limit=n][&...]] as query string values.

./affected_items/{affected_item_ Retrieves the specified AffectedItem object.

id}

./affected_items[?[skip=m][[&]li Retrieves the AffectedItem objects which match <filter

mit=n][&...] parameters> specified as query string values

Updating AffectedItem
Method:PUT
URI Relative Path Comments

./affected_items/{affected_item_id} Updates the specified AffectedItem object.

Deleting AffectedItem
Method:DELETE
URI Relative Path Comments

./affected_items/{affected_item_id} Deletes the specified AffectedItem object.

DOMAIN-ASSET RELATED APIs 79

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
cnt_documents integer R/O
item_type enum R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
affected_specs refset AffectedSpec R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
comments reflist Comment R/O
documents reflist Document R/O
impacted_items refset ImpactedIte R/O This attribute requires module:
m EngineeringChange to be
installed. Otherwise, it is
ignored.
modified_by ref User R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
next_level_impacted_ refset ImpactedIte R/O This attribute requires module:
items m EngineeringChange to be
installed. Otherwise, it is
ignored.
recent_child_comment refvector Comment R/O
s
recent_comments refvector Comment R/O
affected_colors refset Colorway; R/W This attribute requires module:
ColorMaterial EngineeringChange to be
installed. Otherwise, it is
ignored.
affected_issues refset Issue R/W This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
affected_skus refset SKUMaterial; R/W This attribute requires module:
SKU EngineeringChange to be
installed. Otherwise, it is
ignored.
item_product ref Shape; Style; R/W This attribute requires module:
Material EngineeringChange to be
installed. Otherwise, it is
ignored.
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 80

 Centric 8 REST API DEVELOPER GUIDE

AffectedSpec
Creating AffectedSpec
Method:POST
URI Relative Path Comments

./affected_items/{affected_item Creates a new AffectedSpec object as a child of AffectedItem.

_id}/affected_specs

Reading AffectedSpec
Method:GET
URI Relative Path Comments

./affected_items/{affected_item_ Retrieves the AffectedSpec objects referenced by

id}/affected_specs[?[skip=m][[&] AffectedItem which match filter parameters specified as
limit=n][&...]] query string values.

./affected_specs/{affected_spec_ Retrieves the specified AffectedSpec object.

id}

./affected_specs[?[skip=m][[&]li Retrieves the AffectedSpec objects which match <filter

mit=n][&...]] parameters> specified as query string values.

Updating AffectedSpec
Method:PUT
URI Relative Path Comments

./affected_specs[?[skip=m][[&]limit=n Updates the specified AffectedSpec object.

][&...]]

Deleting AffectedSpec
Method:DELETE
URI Relative Path Comments

./affected_specs/{affected_spec_id} Deletes the specified AffectedSpec object.

DOMAIN-ASSET RELATED APIs 81

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the
object.
cnt_documents integer R/O
history string R/O This attribute requires
module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
last_child_commen time R/O
t_date
last_comment_date time R/O
next_release_vers string R/O
ion_name
next_revision_nam string R/O
e
affected_specs refset AffectedSpec R/O This attribute requires
module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
comments reflist Comment R/O
current_revision ref AffectedSpecRevision R/O
documents reflist Document R/O
latest_revision ref AffectedSpecRevision R/O
modified_by ref User R/O This attribute requires
module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
phase_current_rev refmap AffectedSpecRevision R/O
isions
recent_child_comm refvector Comment R/O
ents
recent_comments refvector Comment R/O
revisions refvector AffectedSpecRevision R/O
spec ref Artwork; R/O This attribute requires
FactoryReviewTemplate module:
; SizeChart; EngineeringChange to be
ApparelBOM; installed. Otherwise, it is
AffectedSpec; ignored.
MaterialBOM;
PrintDesign; Document;
CollectionMaterial;
FoodLabelDataSheet;

DOMAIN-ASSET RELATED APIs 82

 Centric 8 REST API DEVELOPER GUIDE

ReviewColorway;
ReviewSKU;
PropertiesDataSheet;
ColorDataSheet;
CollectionMatrix;
ReviewStyle; TestRun;
ReviewCollection;
Question; PriceList;
SupplierContractualDoc
ument;
CareAndComposition;
SubRouting;
FoodSupplierItem;
FactoryComplianceItem;
Routing; Workflow;
ImageDataSheet;
CamundaProcessDefinit
ion;
ContractualDocument;
MaterialSchedule;
ReviewFood;
InspectionTestSpec;
TestSpec;
DataSheetSizeLabel;
MaterialDataSheet;
SizeChartReview;
SpecificationDataSheet;
CollectionColor;
SpecificationDataSheet
SupplierResponse;
SupplierItem
spec_type enum C/O This attribute requires
module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
referenced_docume reflist Document R/W
nts
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 83

 Centric 8 REST API DEVELOPER GUIDE

ApparelBOM
Creating ApparelBOM
Method:POST
URI Comments

./styles/{style_id}/data_sheets Creates a new ApparelBOM as a child of Style.

/apparel_boms

/apparel_bom/copy/{apparel_bom_ Allows to create a BOM from a BOM template.

id} NOTE: For this API, apparel_bom_id is the ApparelBOM id that
does not have a parent.

Reading ApparelBOM
Method:GET
URI Comments

./styles/{style_id}/data_sheets/ Retrieves the ApparelBOM objects referenced by Style which

apparel_boms[?[skip=m][[&]limit= match the <filter_parameters>
n][& <filter_parameters>]..]

./apparel_boms/{apparel_bom_id} Retrieves the specified ApparelBOM object.

./apparel_boms[?[skip=m][[&]limi Retrieves the ApparelBOM objects which match the

t=n] <filter_parameters>

[[&<filter_parameters>]..]

Updating ApparelBOM
Method:PUT
URI Comments

./apparel_boms/{apparel_bom_id} Updates the specified ApparelBOM object.

Deleting ApparelBOM
Method:DELETE
URI Comments

./apparel_boms/{apparel_bom_id} Deletes the specified ApparelBOM object.

DOMAIN-ASSET RELATED APIs 84

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ApparelBOM

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
is_sample_bom Boolean boolean R/O
current_revision String ref R/O
data_sheet_samples List<String> reflist R/O
images List<String> reflist R/O
latest_revision String ref R/O
revisions List<String> refvector R/O
can_track_by_calendar Boolean boolean R/W
description String string R/W
final_inspection_relev Boolean boolean R/W This attribute requires
ant module: AQL to be installed.
Otherwise, it is ignored.
match_colors Boolean boolean R/W
subtype String ref R/W BOM Subtype is not needed when
(ApparelBOMSubtype) creating a BOM via BOM template if
ApparelBOMSubtype is not defined
in C8.

It is mandatory, however, if the user

wants to create a BOM via BOM
template if ApparelBOMSubtype is
defined in C8.
for_product_source ref ProductS R/W
ource
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 85

 Centric 8 REST API DEVELOPER GUIDE

ApparelBOMRevision

Prior to the 7.0 release, use version V2 of these APIs. If the user is
using Centric 8 version 7.0 and above, then use version V3 of these
APIs.

Creating ApparelBOMRevision
Method:POST
URI Comments

./apparel_bom_revisions/{apparel_bom Creates a new revision for the specified

_revision_id} ApparelBOMRevision.
/revise

Reading ApparelBOMRevision
Method:GET
URI Comments

./apparel_bom_revisions/{apparel_bom Retrieves the specified ApparelBOMRevision object.

_revision_id}

./apparel_bom_revisions[?[skip=m][[& Retrieves the ApparelBOMRevision objects which

]limit=n] match the <filter_parameters>

[[&<filter_parameters>]..]

Updating ApparelBOMRevision
Method:PUT
URI Comments

./apparel_bom_revisions/{apparel_bom_ Updates the specified ApparelBOMRevision object.

revision_id}
./apparel_bom_revisions/{apparel_bom_
revision_id}?action={action_name}
Updates the specified ApparelBOMRevision object and
changes the revision state based on the actions enum
list: APPROVED, ABANDONED, FREEZE, REOPEN,
REVIEW, PURGEREVISION, PURGERESETREVISION

DELETE unsupported

ApparelBOMRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 86

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ApparelBOMRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
bom_main_material_co Integer integer R/O
unt
clarification_number Integer integer R/O
is_current Boolean boolean R/O
pdf String url R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
validation_status String enum R/O
validation_time String time R/O
approver String ref R/O
bom_main_materials List<String> refset R/O
bom_materials List<String> refset R/O
items List<String> refvector R/O
modified_by String ref R/O
pending_2_user String ref R/O
pending_user String ref R/O
phase String ref R/O
revert_user String ref R/O
review_user String ref R/O
state_change_user String ref R/O
all_sections List<String> refvector R/W
description String string R/W
enable_material_sche Boolean boolean R/W
dule
main_materials String string R/W
revision_comment String string R/W
bom_product_colors List<String> refvector R/W
bom_product_sizes List<String> refvector R/W
composition List<String> refvector R/W
_url_base_template String string R/O File (image, pdf, document) retrieval
URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 87

 Centric 8 REST API DEVELOPER GUIDE

ApparelBOMSubtype
Creating ApparelBOMSubtype
Method:POST
URI Comments

./apparel_bom_subtypes Creates a new ApparelBOMSubtype object.

Reading ApparelBOMSubtype
Method:GET
URI Comments

./apparel_bom_subtypes/{apparel_bom_ Retrieves the specified ApparelBOMSubtype object.

subtype_id}

./apparel_bom_subtypes[?[skip=m][[&] Retrieves the ApparelBOMSubtype objects which

limit=n] match the <filter_parameters>

[[&<filter_parameters>]..]

Updating ApparelBOMSubtype
Method:PUT
URI Comments

./apparel_bom_subtypes/{apparel_bom_s Updates the specified ApparelBOMSubtype object.

ubtype_id}

Deleting ApparelBOMSubtype
Method:DELETE
URI Comments

./apparel_bom_subtypes/{apparel_bom_ Deletes the specified ApparelBOMSubtype object.

subtype_id}

DOMAIN-ASSET RELATED APIs 88

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ApparelBOMSubtype

Attribute Data Ref. Type Read Only Description

Type
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string C/O Display name for the object.
applied_on String time R/O
published Boolean boolean R/O
modified_by String Ref R/O
(User)
active Boolean boolean R/O
is_automatic_placem Boolean boolean R/O
ent_tracking
expose_bom_supplier Boolean boolean R/O
_attributes
lock_theme_placemen Boolean boolean R/O
t_list
validate_bom Boolean boolean R/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory create only attribute.

DOMAIN-ASSET RELATED APIs 89

 Centric 8 REST API DEVELOPER GUIDE

ApparelDimension
Creating ApparelDimension
Method:POST
URI Comments

./apparel_dimensions Creates a new ApparelDimension object.

Reading ApparelDimension
Method:GET
URI Comments

./apparel_dimensions/{apparel_dimensions_ Retrieve the specified ApparelDimension object.

id}
./apparel_dimensions[?[skip=m][[&]limit=n Retrieves the ApparelDimension objects which
][[&<filter_parameters>]..] match the <filter_parameters>

Updating ApparelDimension
Method:PUT
URI Comments

./apparel_dimensions/{apparel_dimensions_ Updates the specified ApparelDimension object.

id}

Deleting ApparelDimension
Method:DELETE
URI Comments

./apparel_dimensions/{apparel_dimensions_ Deletes the specified ApparelDimension object.

id}

DOMAIN-ASSET RELATED APIs 90

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ApparelDimension

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
images Map<String, String> refmap R/W
modified_by String ref R/O
active Boolean boolean R/W
description String string R/W
dim_desc_alt_1 String string R/W
dimension_depende Set<String> enumset R/W
ncies
final_inspection_ Boolean boolean R/W This attribute requires
relevant module: AQL to be installed.
Otherwise, it is ignored.
grainline String enum R/W
tags List<String> stringvector R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 91

 Centric 8 REST API DEVELOPER GUIDE

Artwork
Creating Artwork
Method:POST
URI Comments

./styles/{style_id}/data_sheets/artworks Creates a new Artwork as a child of

Style.

Reading Artwork
Method:GET
URI Comments

./styles/{style_id}/data_sheets/artworks Retrieves the Artwork objects referenced by Style

[?[skip=m][[&]limit=n]
[[&<filter_parameters>]..]
./artworks/{artwork_id}
./artworks[?[skip=m][[&]limit=n]
[[&<filter_parameters>]..]
which match the <filter_parameters>
Retrieves the specified Artwork object.
Retrieves the Artwork objects which match the
<filter_parameters>

Updating Artwork
Method:PUT
URI Comments

./artworks/{artwork_id} Updates the specified Artwork object.

Deleting Artwork
Method:DELETE
URI Comments

./artworks/{artwork_id} Deletes the specified Artwork object.

DOMAIN-ASSET RELATED APIs 92

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Artwork

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
current_revision String ref R/O
latest_revision String ref R/O
modified_by String ref R/O
phase_current_revi Map<String, refmap R/O
sions String>
can_track_by_calen Boolean boolean R/W
dar
description String string R/W
sub_type String enum R/W
subtype String ref C/O
for_product_source ref ProductSo R/W
urce
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents create only attribute which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 93

 Centric 8 REST API DEVELOPER GUIDE

ArtworkRevision
Creating ArtworkRevision
Method:POST
URI Comments

./artwork_revisions/{artwork_revision_id}/revise Creates a new revision for the

specified ArtworkRevision object.

Reading ArtworkRevision
Method:GET
URI Comments

./artwork_revisions/{artwork_revision_id} Retrieves the specified ArtworkRevision object.

./artwork_revisions[?[skip=m][[&]limit=n] Retrieves the ArtworkRevision objects which

[[&<filter_parameters>]..] match the <filter_parameters>

Updating ArtworkRevision
Method:PUT
URI Comments

./artwork_revisions/{artwork_revision Updates the specified ArtworkRevision object.

_id}
./artwork_revisions/{artwork_revision Update the specified ArtworkRevision object and
_id} changes the revision state based on the actions enum
?action={action_name} list: APPROVED, ABANDONED, FREEZE, REOPEN,
REVIEW, PURGEREVISION, PURGERESETREVISION

DELETE unsupported

ArtworkRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 94

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ArtworkRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
is_current Boolean boolean R/O
pdf String url R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
modified_by String ref R/O
pending_2_user String ref R/O
pending_user String ref R/O
revert_user String ref R/O
review_user String ref R/O
state_change_user String ref R/O
description String string R/W
revision_comment String string R/W
colorways List<String> reflist R/W
_url_base_template String string R/O File (image, pdf, document)
retrieval URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 95

 Centric 8 REST API DEVELOPER GUIDE

AuthenticationType
Reading AuthenticationType
Method: GET
URI Comments

./authentication_types/{authenticat Retrieves the specified AuthenticationType object.

ion_type_id}
./authentication_types Retrieves the AuthenticationType objects which
[?[skip=m][[&]limit=n][[&<filter_pa match the <filter_parameters>
rameters>]..]

Method: POST, PUT & DELETE are unsupported

Attribute List of authentication_types

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 96

 Centric 8 REST API DEVELOPER GUIDE

Avatar
Creating Avatar
Method:POST
URI Relative Path Comments

./avatars Creates a new Avatar object.

Reading Avatar
Method:GET
URI Relative Path Comments

./avatars/{avatar_id} Retrieves the specified Avatar object.

./avatars[?[skip=m][[&]limit=n][&...]] Retrieves the Avatar objects which match <filter

parameters> specified as query string values.

Updating Avatar
Method:PUT
URI Relative Path Comments

./avatars/{avatar_id} Updates the specified Avatar object.

Deleting Avatar
Method:DELETE
URI Relative Path Comments

./avatars/{avatar_id} Deletes the specified Avatar object.

DOMAIN-ASSET RELATED APIs 97

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
comments reflist Comment R/O
documents reflist Document R/O
libraries refset AvatarLibrary R/O
modified_by ref User R/O

recent_child_comm refvector Comment R/O

ents
recent_comments refvector Comment R/O
description string R/W

avatar_sub_size_r refvector SubSizeRange R/W

anges
default_3d_viewab ref Document R/W
le
images refmap Image R/W
referenced_docume reflist Document R/W
nts
size_ranges reflist SizeRange R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 98

 Centric 8 REST API DEVELOPER GUIDE

AvatarLibrary
Creating AvatarLibrary
Method:POST
URI Relative Path Comments

./avatar_libraries Creates a new AvatarLibrary object.

Reading AvatarLibrary
Method:GET
URI Relative Path Comments

./avatar_libraries/{avatar_library_id} Retrieves the specified AvatarLibrary object.

./avatar_libraries[?[skip=m][[&]limit= Retrieves the AvatarLibrary objects which match

n][&...]] <filter parameters> specified as query string values.

Updating AvatarLibrary
Method:PUT
URI Relative Path Comments

./avatar_libraries/{avatar_library_id Updates the specified AvatarLibrary object.

}

Deleting AvatarLibrary
Method:DELETE
URI Relative Path Comments

./avatar_libraries/{avatar_library_id Deletes the specified AvatarLibrary object.

}

DOMAIN-ASSET RELATED APIs 99

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
avatars reflist Avatar R/W
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 100

 Centric 8 REST API DEVELOPER GUIDE

BOMSectionDefinition
Creating BOMSectionDefinition
Method:POST
URI Comments

./material_bom_revisions/{material_bom_revisio Creates a new BOMSectionDefinition as

n_id}/owned_sections/bom_section_definition
./apparel_bom_revisions/{apparel_bom_revision_
id}/owned_sections/bom_section_definition
a child of MaterialBOMRevision.
NOTE: Use version V3 of this API if the
user is using Centric 8 version 7.5 and
above.
Creates a new BOMSectionDefinition as
a child of ApparelBOMRevision.
NOTE: Use version V3 of this API if the
user is using Centric 8 version 7.5 and
above.

Reading BOMSectionDefinition
Method:GET
URI Comments

./bom_section_definitions/{bom_section Retrieve the specified BOMSectionDefinition object.

_definition_id}
./bom_section_definitions Retrieves the BOMSectionDefinition objects which
[?[skip=m][[&]limit=n][[&<filter_param match the <filter_parameters>
eters>]..]

Updating BOMSectionDefinition
Method:PUT
URI Comments

./bom_section_definitions/{ Updates the specified BOMSectionDefinition object.

bom_section_definition_id}

Deleting BOMSectionDefinition
Method:DELETE
URI Comments

./bom_section_definitions/{ Deletes the specified BOMSectionDefinition object.

bom_section_definition_id}

DOMAIN-ASSET RELATED APIs 101

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of BOMSectionDefinition

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
ad_hoc Boolean boolean R/O
bom_product_type String enum R/O
modified_by String ref R/O
active Boolean boolean R/W
localized_name Map stringmap R/W
<String, String>
placement_product_ String enum R/W
type
sort_order Integer integer R/O
bom_product_types List reflist R/W
<String>
placement_product_ List reflist R/W
types <String>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 102

 Centric 8 REST API DEVELOPER GUIDE

BOMSupplierAttributes
Reading BOMSupplierAttributes
Method:GET
URI Comments

./product_sources/{product_source_id}/bo Retrieves the BOMSupplierAttributes objects

m_supplier_attributes[?[skip=m][[&]limit referenced by ProductSource which match filter
=n][& ][[& <filter_parameters>]..]] parameters.
./bom_supplier_attributes/{bom_supplier Retrieves the specified BOMSupplierAttributes
_attributes_id} object.

./bom_supplier_attributes[?[skip=m][[&] Retrieves the BOMSupplierAttributes objects which

limit=n][& <filter_parameters>..]] match filter parameters.

Updating BOMSupplierAttributes
Method:PUT
URI Comments

./bom_supplier_attributes/{bom_supplier_ Updates the specified BOMSupplierAttributes

attributes_id} object.

Deleting BOMSupplierAttributes
Method:DELETE
URI Comments

./bom_supplier_attributes/{bom_supplier_ Deletes the specified BOMSupplierAttributes

attributes_id} object.

Method:POST unsupported

BOMSupplierAttributes does not support POST method.

DOMAIN-ASSET RELATED APIs 103

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of BOMSupplierAttributes

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
description String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.

DOMAIN-ASSET RELATED APIs 104

 Centric 8 REST API DEVELOPER GUIDE

BusinessObject
Reading BusinessObject
Method:GET
URI Relative Path Comments

./business_objects/{business_object_id} Retrieves the specified BusinessObject object.

./business_objects[?[skip=m][[&]limit=n Retrieves the BusinessObject objects which match

][&...]] <filter parameters> specified as query string values.

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
applied_on time R/O
modified boolean R/O
related_class_names stringset R/O
root_class_name string R/O
modified_by ref User R/O
modules reflist Module R/O
enabled boolean R/W
notes string R/W
configurable_attrib refmap CustomAttribute; R/W
utes BuildInAttribute
create_form_definit ref CreateFormDefiniti R/W
ion on
image_labels_enum_l ref EnumList R/W
ist
validation_rule_gro reflist ConfigurableValidat R/W
ups ionRuleGroup
validation_rules reflist ConfigurableValidat R/W
ionRule
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 105

 Centric 8 REST API DEVELOPER GUIDE

CalendarTrackingType
Reading CalendarTrackingType
Method:GET
URI Relative Path Comments

./calendar_tracking_types/{calendar_trac Retrieves the specified CalendarTrackingType

king_type_id} object.
./calendar_tracking_types[?[skip=m][[&] Retrieves the CalendarTrackingType objects which
limit=n][&...]] match <filter parameters> specified as query string
values.

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
modified_by ref User R/O This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
sub_type string R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
tracking_states enumlist R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
tracking_level ref CalendarLevel R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
tracking_phases refvector _CS_Phase R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 106

 Centric 8 REST API DEVELOPER GUIDE

CamundaGlobal
Reading CamundaGlobal
Method:GET
URI Comments

./camunda_globals/{camunda_global_id} Retrieves the specified CamundaGlobal object.

./camunda_globals[?[skip=m][[&] Retrieves the CamundaGlobal objects which match the

<filter_parameters>
limit=n][[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

CamundaGlobal is a read-only endpoint. It does not

support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 107

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaGlobal

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
number_of_running_ integer R/O This attribute requires
instances module: Camunda to be installed.
Otherwise, it is ignored.
number_of_running_ integer R/O This attribute requires
user_tasks module: Camunda to be installed.
Otherwise, it is ignored.
number_of_tasks_ integer R/O This attribute requires
with_issues module: Camunda to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 108

 Centric 8 REST API DEVELOPER GUIDE

CamundaProcessDefinition
Reading CamundaProcessDefinition
Method:GET
URI Comments

./camunda_process_definitions/ Retrieves the specified CamundaProcessDefinition

object.
{camunda_process_definition_id}

./camunda_process_definitions Retrieves the CamundaProcessDefinition objects

which match the <filter_parameters>
[?[skip=m][[&]limit=n]

[[&<filter_parameters>]..]

POST, PUT & DELETE unsupported

CamundaProcessDefinition is a read-only endpoint. It does

not support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 109

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaProcessDefinition

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
key string R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
number_of_runnin integer R/O This attribute requires
g_instances module: Camunda to be installed.
Otherwise, it is ignored.
number_of_runnin integer R/O This attribute requires
g_user_tasks module: Camunda to be installed.
Otherwise, it is ignored.
current_revision ref CamundaProcessDefinitionRevision R/O
latest_revision ref CamundaProcessDefinitionRevision R/O
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
primary_subtype ref MerchSecondarySubtype; R/O This attribute requires
ReviewCollectionSubtype; module: Camunda to be installed.
MaterialDataSheetSubtype; Otherwise, it is ignored.
MerchCollectionSubtype;
SelectSetSubtype;
ApparelBOMSubtype;
ContractualDocumentSubtype;
RoutingSubtype; ArtworkSubtype;
ThemeMasterSubtype;
LookupItemSubtype;
ReviewStyleSubtype;
MerchFolderSubtype;
FinalInspectionSectionSubtype;
SpecificationDataSheetSubtype;
MerchDetailsSubtype;
ReviewSKUSubtype;
CareAndCompositionSubtype;
TestRunSubtype;
DataSheetSizeLabelSubtype;
MaterialBOMSubtype;
CollectionMatrixSubtype;
MerchSecondaryPlanSubtype;
SupplierContractualDocumentSubty
pe; ColorDataSheetSubtype;
PriceListSubtype;
MerchPlanSubtype;
PropertiesDataSheetSubtype;
SizeChartSubtype;
MerchOptionSubtype;
MerchProductSubtype;
TestSpecSubtype; FactorySubtype;
SupplierSubtype;
ReviewColorwaySubtype;
SubRoutingSubtype;
SupplierItemSubtype;
ImageDataSheetSubtype;
DocumentSubtype
revisions refvector CamundaProcessDefinitionRevision R/O
primary_type string R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 110

 Centric 8 REST API DEVELOPER GUIDE

CamundaProcessDefinitionRevision
Reading CamundaProcessDefinitionRevision
Method:GET
URI Comments

./camunda_process_definition_revisions/ Retrieves the specified

CamundaProcessDefinitionRevision object.
{camunda_process_definition_revision_id}

./camunda_process_definition_revisions Retrieves the CamundaProcessDefinitionRevision

objects which match the <filter_parameters>
[?[skip=m][[&]limit=n]

[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

CamundaProcessDefinitionRevision is a read-only endpoint. It

does not support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 111

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaProcessDefinitionRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_numb integer R/O
er
is_current boolean R/O
number_of_running_ integer R/O This attribute requires
instances module: Camunda to be installed.
Otherwise, it is ignored.
number_of_running_ integer R/O This attribute requires
user_tasks module: Camunda to be installed.
Otherwise, it is ignored.
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
version integer R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
approver ref User R/O
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
tasks reflist CamundaTaskDefinition R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
description string R/W
revision_comment string R/W
current_revision ref CamundaProcessDefinitionRevi R/W
sion
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 112

 Centric 8 REST API DEVELOPER GUIDE

CamundaProcessInstance
Reading CamundaProcessInstance
Method:GET
URI Comments

./camunda_process_instances/ Retrieves the specified CamundaProcessInstance object.

{camunda_process_instance_id}

./camunda_process_instances Retrieves the CamundaProcessInstance objects which match

the <filter_parameters>
[?[skip=m][[&]limit=n]

[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

CamundaProcessInstance is a read-only endpoint. It does

not support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 113

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaProcessInstance

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
active boolean R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
end_date time R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
number_of_tasks_wi integer R/O This attribute requires
th_issues module: Camunda to be installed.
Otherwise, it is ignored.
start_date time R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
trigger string R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
process_definition ref CamundaProcessDefinitionRevision R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
tasks reflist CamundaTask R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
__parent__ ref ProductShipment; R/O This attribute requires
ShippingContainer; module: Camunda to be installed.
CompetitiveStyle; Customer; Otherwise, it is ignored.
CustomerOrder; SalesOrderGroup;
ShipmentQCIssue;
ContractualDocumentGroup;
Document; DigitalCatalogLookItem;
Category2; Category1;
ColorDataSheet;
MarketingCollection;
MerchOptionVersion;
MerchSecondary; TestRun;
MCMaterialColor; SMProductSKU;
DataPackage; PurchasedOrder;
MerchCollectionVersion;
ORQuestion; FinalInspection;
SMProductColor;
MerchProductVersion;
SalesDivision;
ColorColorwayContext;
TestRunSection;
CurrencyExchangeTable;
MCProduct; DataSheetSizeLabel;
ProductAlternative; ScorecardItem;
PurchasedOrderProduct;
SOLineItem; SamplingPlanItem;
ProductSource; Shape; Artwork;
SizeChart; FactoryReviewEvent;
SalesMarket; MerchProduct;
ColorMaterial; ApparelBOM;
SpecificationSectionDefinition;
MaterialBOM;
CustomSalesCollection;
ReviewSKU; ProductSalesRegion;

DOMAIN-ASSET RELATED APIs 114

 Centric 8 REST API DEVELOPER GUIDE

PropertiesDataSheet; SKUMaterial;
Style; Defect; Supplier; Question;
StockOrder; MerchSeason; Season;
TestSpecGroup;
SupplierContractualDocument;
QuestionSubsection;
PrintDesignColor; SubQuestion;
Routing; MerchFolderVersion;
ContractualDocument; MCMaterial;
MarketingSegment;
FinalInspectionBatch;
MCProductSKU;
MaterialDataSheet; ShapeMaster;
MerchFolder; Theme;
DigitalCatalog; SizeChartReview;
SpecificationDataSheet;
SupplierItem; AcceptanceLimit;
Issue; SMProduct; LookupItem;
PrintDesign; SelectSet; Colorway;
SKUMaterialSource;
PurchasedOrderGroup;
ReviewCollection; SalesOrder;
CareAndComposition; SubRouting;
Order; ProductSalesRegionSpec;
MaterialSample;
FactoryComplianceItem;
InformationEvent; Shipment;
MerchPlan; ImageDataSheet;
MerchSecondaryVersion;
PurchasedOrderColor;
FactoryReview; RoutingGroup;
Collection; SamplingPlan;
SampleStorage;
ThemeProductAlternative;
OperationsIssue;
ORQuestionSubsection;
MerchDetails;
MerchSecondaryPlan;
DocumentGroup; Factory;
SpecificationSection;
SpecificationItemDefinition;
ProductColorShipment;
SupplierReview;
DigitalCatalogLook; SelectSetItem;
ReviewColorway;
ContractualDocumentPackage;
ShipmentTerms; ReviewStyle;
Increment; SampleDimensions;
CostScenario; SampleMaterialSpec;
Scorecard; PriceList;
MCProductColor; SalesLook;
CustomerPurchaseOrder;
QuestionSection; Sample;
MerchCollection; SalesCollection;
Material; ThemeMaster; Contact;
SalesPromo; SupplierRequest;
TestSpec; SKUSource;
ORSubQuestion; MarketingLook;
SupplierReviewEvent; SKU;
MerchOption; ORQuestionSection;
MarketingTool; ProductStructure
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 115

 Centric 8 REST API DEVELOPER GUIDE

CamundaTask
Reading CamundaTask
Method:GET
URI Comments

./camunda_tasks/{camunda_task_id} Retrieves the specified CamundaTask object.

./camunda_tasks[?[skip=m][[&]limit=n] Retrieves the CamundaTask objects which match

the <filter_parameters>
[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

CamundaTask is a read-only endpoint. It does not support

POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 116

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaTask

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
active boolean R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
assignee_context ref R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
end_date time R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
has_issues boolean R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
iteration integer R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
start_date time R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
assignee_role ref Role; Group R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
c8_instance ref ProductShipment; R/O This attribute requires
ShippingContainer; module: Camunda to be installed.
CompetitiveStyle; Customer; Otherwise, it is ignored.
CustomerOrder;
SalesOrderGroup;
ShipmentQCIssue;
ContractualDocumentGroup;
Document;
DigitalCatalogLookItem;
Category2; Category1;
ColorDataSheet;
MarketingCollection;
MerchOptionVersion;
MerchSecondary; TestRun;
MCMaterialColor;
SMProductSKU; DataPackage;
PurchasedOrder;
MerchCollectionVersion;
ORQuestion; FinalInspection;
SMProductColor;
MerchProductVersion;
SalesDivision;
ColorColorwayContext;
TestRunSection;
CurrencyExchangeTable;
MCProduct;
DataSheetSizeLabel;
ProductAlternative;
ScorecardItem;
PurchasedOrderProduct;
SOLineItem; SamplingPlanItem;
ProductSource; Shape; Artwork;
SizeChart; FactoryReviewEvent;
SalesMarket; MerchProduct;
ColorMaterial; ApparelBOM;
SpecificationSectionDefinition;
MaterialBOM;
CustomSalesCollection;

DOMAIN-ASSET RELATED APIs 117

 Centric 8 REST API DEVELOPER GUIDE

ReviewSKU;
ProductSalesRegion;
PropertiesDataSheet;
SKUMaterial; Style; Defect;
Supplier; Question; StockOrder;
MerchSeason; Season;
TestSpecGroup;
SupplierContractualDocument;
QuestionSubsection;
PrintDesignColor; SubQuestion;
Routing; MerchFolderVersion;
ContractualDocument;
MCMaterial; MarketingSegment;
FinalInspectionBatch;
MCProductSKU;
MaterialDataSheet;
ShapeMaster; MerchFolder;
Theme; DigitalCatalog;
SizeChartReview;
SpecificationDataSheet;
SupplierItem; AcceptanceLimit;
Issue; SMProduct; LookupItem;
PrintDesign; SelectSet;
Colorway; SKUMaterialSource;
PurchasedOrderGroup;
ReviewCollection; SalesOrder;
CareAndComposition;
SubRouting; Order;
ProductSalesRegionSpec;
MaterialSample;
FactoryComplianceItem;
InformationEvent; Shipment;
MerchPlan; ImageDataSheet;
MerchSecondaryVersion;
PurchasedOrderColor;
FactoryReview; RoutingGroup;
Collection; SamplingPlan;
SampleStorage;
ThemeProductAlternative;
OperationsIssue;
ORQuestionSubsection;
MerchDetails;
MerchSecondaryPlan;
DocumentGroup; Factory;
SpecificationSection;
SpecificationItemDefinition;
ProductColorShipment;
SupplierReview;
DigitalCatalogLook;
SelectSetItem;
ReviewColorway;
ContractualDocumentPackage;
ShipmentTerms; ReviewStyle;
Increment; SampleDimensions;
CostScenario;
SampleMaterialSpec;
Scorecard; PriceList;
MCProductColor; SalesLook;
CustomerPurchaseOrder;
QuestionSection; Sample;
MerchCollection;
SalesCollection; Material;
ThemeMaster; Contact;
SalesPromo; SupplierRequest;
TestSpec; SKUSource;
ORSubQuestion;
MarketingLook;
SupplierReviewEvent; SKU;
MerchOption;
ORQuestionSection;

DOMAIN-ASSET RELATED APIs 118

 Centric 8 REST API DEVELOPER GUIDE

MarketingTool; ProductStructure
candidate_groups refset Role; Group R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
candidate_users refset User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
process_definition ref CamundaProcessDefinitionRevi R/O This attribute requires
sion module: Camunda to be installed.
Otherwise, it is ignored.
task_definition ref CamundaTaskDefinition R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
comments string R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
due_date time R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
priority enum R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
user_response string R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
assignee ref User R/W This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 119

 Centric 8 REST API DEVELOPER GUIDE

CamundaTaskDefinition
Reading CamundaTaskDefinition
Method:GET
URI Comments

./camunda_task_definitions/{camunda_task_ Retrieves the specified CamundaTaskDefinition

definition_id} object.
./camunda_task_definitions[?[skip=m][[&]l Retrieves the CamundaTaskDefinition objects
imit=n] which match the <filter_parameters>

[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

CamundaTaskDefinition is a read-only endpoint. It does

not support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 120

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CamundaTaskDefinition

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
id string R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
info stringma R/O This attribute requires
p module: Camunda to be installed.
Otherwise, it is ignored.
task_role string R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
type enum R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
view_definition_pa string R/O This attribute requires
th module: Camunda to be installed.
Otherwise, it is ignored.
view_portal enum R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
view_store_id string R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
action_group ref CamundaTaskActionGroup R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
action_settings refmap CamundaTaskDefinitionActionS R/O This attribute requires
ettings module: Camunda to be installed.
Otherwise, it is ignored.
custom_view ref _CS_PreferenceView R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Camunda to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 121

 Centric 8 REST API DEVELOPER GUIDE

CanvasTemplate
Creating CanvasTemplate
Method:POST
URI Comments

./canvas_templates Creates a new CanvasTemplate object.

Reading CanvasTemplate
Method:GET
URI Comments

./canvas_templates/{canvas_template_id} Retrieves the specified CanvasTemplate object.

./canvas_templates[?[skip=m][[&]limit=n] Retrieves the CanvasTemplate objects which

[[& <filter_parameters>]..] match the <filter_parameters>

Updating CanvasTemplate
Method:PUT
URI Comments

./canvas_templates/{canvas_template_id} Updates the specified CanvasTemplate object.

Deleting CanvasTemplate
Method:DELETE
URI Comments

./canvas_templates/{canvas_template_id} Deletes the specified CanvasTemplate object.

DOMAIN-ASSET RELATED APIs 122

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CanvasTemplate

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
pdf url R/O
modified_by ref User R/O
pdf_requests reflist PDFRequest R/O
pages refvector DataSheetPage R/O
active boolean R/W
datasheet_type enum C/O
description string R/W
notes_orientation enum C/O
paper_orientation enum C/O
paper_size enum C/O
canvas_images reflist Image R/W
datasheet_subtype ref MerchSecondarySubtyp R/W
e;
ReviewCollectionSubtyp
e;
MaterialDataSheetSubt
ype;
MerchCollectionSubtyp
e; SelectSetSubtype;
ApparelBOMSubtype;
ContractualDocumentS
ubtype;
RoutingSubtype;
ArtworkSubtype;
ThemeMasterSubtype;
LookupItemSubtype;
ReviewStyleSubtype;
MerchFolderSubtype;
FinalInspectionSectionS
ubtype;
SpecificationDataSheet
Subtype;
MerchDetailsSubtype;
ReviewSKUSubtype;
CareAndCompositionSu
btype; TestRunSubtype;
DataSheetSizeLabelSu
btype;
MaterialBOMSubtype;
CollectionMatrixSubtype
;
MerchSecondaryPlanSu
btype;
SupplierContractualDoc
umentSubtype;
ColorDataSheetSubtype
; PriceListSubtype;

DOMAIN-ASSET RELATED APIs 123

 Centric 8 REST API DEVELOPER GUIDE

MerchPlanSubtype;
PropertiesDataSheetSu
btype;
SizeChartSubtype;
MerchOptionSubtype;
MerchProductSubtype;
TestSpecSubtype;
FactorySubtype;
SupplierSubtype;
ReviewColorwaySubtyp
e; SubRoutingSubtype;
SupplierItemSubtype;
ImageDataSheetSubtyp
e; DocumentSubtype
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents create only mandatory attribute.

DOMAIN-ASSET RELATED APIs 124

 Centric 8 REST API DEVELOPER GUIDE

CareAndComposition
Creating CareAndComposition
Method:POST
URI Comments

./styles/{style_id}/data_sheets/ Creates a new CareAndComposition as a child of Style.

care_and_compositions

Reading CareAndComposition
Method:GET
URI Comments

./styles/{style_id}/data_sheets/ Retrieves the CareAndComposition objects

care_and_compositions[?[skip=m]
[[&]limit=n][&...]]
./care_and_compositions/{
care_and_composition_id}
./care_and_compositions[?[skip=m][[&]
limit=n][[& <filter_parameters>]..]
owned by Style which match the
<filter_parameters>
Retrieves the specified CareAndComposition
object.
Retrieves the CareAndComposition objects
which match the <filter_parameters>

Updating CareAndComposition
Method:PUT
URI Comments

./care_and_compositions/ Updates the specified CareAndComposition object.

{care_and_composition_id}

Deleting CareAndComposition
Method:DELETE
URI Comments

./care_and_compositions/ Deletes the specified CareAndComposition object.

{care_and_composition_id}

DOMAIN-ASSET RELATED APIs 125

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CareAndComposition

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
current_revision String ref R/O
data_sheet_samples List<String> reflist R/O
latest_revision String ref R/O
modified_by String ref R/O
phase_current_revisions Map<String, refmap R/O
String>
can_track_by_calendar Boolean boolean R/W
description String string R/W
bom String ref R/W
colorways List<String> reflist R/W
for_product_source ref Product R/W
Source
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 126

 Centric 8 REST API DEVELOPER GUIDE

CareAndCompositionRevision
Creating CareAndCompositionRevision
Method:POST
URI Comments

./care_and_composition_revisions/ Creates a new revision of the

{care_and_composition_revision_id}/revise CareAndComposition object.

Reading CareAndCompositionRevision
Method:GET
URI Comments

./care_and_composition_revisions/ Retrieves the specified CareAndCompositionRevision

object.
{
care_and_composition_revision_id}

./care_and_composition_revisions Retrieves the CareAndCompositionRevision objects which

match the <filter_parameters>
[?[skip=m][[&]limit=n][[&
<filter_parameters>]..]

Updating CareAndCompositionRevision
Method:PUT
URI Comments

./care_and_composition_revisions/ Updates the specified CareAndCompositionRevision

{ object.
care_and_composition_revision_id}
./care_and_composition_revisions/ Update the specified CareAndCompositionRevision object
{ and changes the revision state based on the actions enum
care_and_composition_revision_id} list APPROVED, ABANDONED, FREEZE, REOPEN, REVIEW,
?action={action_name} PURGEREVISION, PURGERESETREVISION

Method: DELETE unsupported

CareAndCompositionRevision does not support DELETE

method.

DOMAIN-ASSET RELATED APIs 127

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CareAndCompositionRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_number Integer integer R/O
is_current Boolean boolean R/O
pdf String url R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
care_icons List<String> refvector R/O
modified_by String ref R/O
description String string R/W
revision_comment String string R/W
care_instructions List<String> refvector R/W
_url_base_template String string R/O File (image, pdf, document) retrieval
URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 128

 Centric 8 REST API DEVELOPER GUIDE

CareSymbol
Creating CareSymbol
Method:POST
URI Comments

./care_symbols Creates a new CareSymbol object.

Reading CareSymbol
Method:GET
URI Comments

./care_symbols/{care_symbol_id} Retrieves the specified CareSymbol object.

./care_symbols[?[skip=m][[&]limit=n][[& Retrieves the CareSymbol objects which match

<filter_parameters>]..] the <filter_parameters>

Updating CareSymbol
Method:PUT
URI Comments

./care_symbols/{care_symbol_id} Updates the specified CareSymbol object.

Deleting CareSymbol
Method:DELETE
URI Comments

./care_symbols/{care_symbol_id} Deletes the specified CareSymbol object.

DOMAIN-ASSET RELATED APIs 129

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CareSymbol

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator ID.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
libraries List<String> refset R/O
modified_by String ref R/O
active Boolean boolean R/W
description String string R/W
languages Map<String, String> stringmap R/W
purpose String enum R/W
rank Integer integer R/W
symbol_type String enum R/W
tags List<String> stringvect R/W
or
images Map<String, String> refmap R/W
Language_icons Map<String, String> refmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 130

 Centric 8 REST API DEVELOPER GUIDE

Category1
Creating Category1
Method:POST
URI Comments

./seasons/{season_id}/hierarchy Creates a new Category1 as a child of Season

Reading Category1
Method:GET
URI Comments

./seasons/{season_id}/hierarchy[?[skip=m] Retrieves the Category1 objects owned by

[[&]limit=n][& <filter_parameters>]..] Season which match the <filter_parameters>
./category1s/{category1_id} Retrieves the specified Category1 object.

./category1s[?[skip=m][[&]limit=n][[& Retrieves the Category1 objects which match the

<filter_parameters>]..] <filter_parameters>

Updating Category1
Method:PUT
URI Comments

./category1s/{category1_id} Updates the specified Category1 object.

Deleting Category1
Method:DELETE
URI Comments

./category1s/{category1_id} Deletes the specified Category1 object.

DOMAIN-ASSET RELATED APIs 131

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Category1

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator ID.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_colorway integer R/O
cnt_style integer R/O
hierarchy reflist Category2 R/O
issues reflist Issue; R/O
Operation
sIssue
modified_by ref User R/O
parent_season ref Season R/O
code string R/W
description string R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 132

 Centric 8 REST API DEVELOPER GUIDE

Category2
Creating Category2
Method:POST
URI Comments

./category1s/{category1_id}/hierarchy Creates a new Category2 object as a child of

Category1.

Reading Category2
Method:GET
URI Comments

./category1s/{category1_id}/hierarchy[?[skip Retrieves the Category2 objects owned by

=m][[&]limit=n][[& <filter_parameters>]..] Category1 which match
<filter_parameters>
./category2s/{category2_id} Retrieves the specified Category2 object.

./category2s[?[skip=m][[&]limit=n][[& Retrieves the Category2 objects which

<filter_parameters>]..] match the <filter_parameters>

Updating Category2
Method:PUT
URI Comments

./category2s/{category2_id} Updates the specified Category2 object.

Deleting Category2
Method:DELETE
URI Comments

./category2s/{category2_id} Deletes the specified Category2 object.

DOMAIN-ASSET RELATED APIs 133

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Category2

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator ID.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_colorway integer R/O
cnt_style integer R/O
category_1 ref Category1 R/O
hierarchy reflist Collection R/O
issues reflist Issue; R/O
Operation
sIssue
modified_by ref User R/O
parent_season ref Season R/O
code string R/W
description string R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 134

 Centric 8 REST API DEVELOPER GUIDE

ClaimItem
Creating ClaimItem
Method:POST
URI Relative Path Comments

./food_label_data_sheet_revisions/{food_la Creates a new ClaimItem object as a child of

bel_data_sheet_revision_id}/claims FoodLabelDataSheetRevision.

Reading ClaimItem
Method:GET
URI Relative Path Comments

./food_label_data_sheet_revisions/{food_labe Retrieves the ClaimItem objects referenced

l_data_sheet_revision_id}/claims[?[skip=m][[
&]limit=n][&...]]
./claim_items/{claim_item_id}
./claim_items[?[skip=m][[&]limit=n][&...]]
by FoodLabelDataSheetRevision which
match filter parameters specified as query
string values.
Retrieves the specified ClaimItem object.
Retrieves the ClaimItem objects which
match <filter parameters> specified as
query string values.

Updating ClaimItem
Method:PUT
URI Relative Path Comments

./claim_items/{claim_item_id} Updates the specified ClaimItem object.

Deleting ClaimItem
Method:DELETE
URI Relative Path Comments

./claim_items/{claim_item_id} Deletes the specified ClaimItem object.

DOMAIN-ASSET RELATED APIs 135

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
library_item ref FoodClai R/W This attribute requires
m module: FormulatedProduct to be
installed. Otherwise, it is ignored.
only_for_produ refset ProductSa R/W This attribute requires
ct_sales_regio lesRegion module: FormulatedProduct to be
ns installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 136

 Centric 8 REST API DEVELOPER GUIDE

Classifier0
Creating Classifier0
Method:POST
URI Comments

./classifier0s Creates a new Classifier0 object.

Reading Classifier0
Method:GET
URI Comments

./classifier0s/{classifier0_id} Retrieves the specified Classifier0 object.

./classifier0s[?[skip=m][[&]limit=n][[& Retrieves the Classifier0 objects which match the
<filter_parameters>]..] <filter_parameters>

Updating Classifier0
Method:PUT
URI Comments

./classifier0s/{classifier0_id} Updates the specified Classifier0 object.

Deleting Classifier0
Method:DELETE
URI Comments

./classifier0s/{classifier0_id} Deletes the specified Classifier0 object.

DOMAIN-ASSET RELATED APIs 137

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Classifier0

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator ID.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
classification List<String> reflist R/O
_hierarchy
code String string R/W
description String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 138

 Centric 8 REST API DEVELOPER GUIDE

Classifier1
Creating Classifier1
Method:POST
URI Comments

./classifier0s/{classifier0_id}/hierarchy Creates a new Classifier1 object as a child of

Classifier0

Reading Classifier1
Method:GET
URI Comments

./classifier0s/{classifier0_id}/hierarchy[?[ Retrieves the Classification1 objects owned

skip=m][[&]limit=n][[& by Classification0 which match the
<filter_parameters>]..] <filter_parameters>
./classifier1s/{classifier1_id} Retrieves the specified Classifier1 object.
./classifier1s[?[skip=m][[&]limit=n][[& Retrieves the Classifier1 objects which
<filter_parameters>]..] match the <filter_parameters>

Updating Classifier1
Method:PUT
URI Comments

./classifier1s/{classifier1_id} Updates the specified Classifier1 object.

Deleting Classifier1
Method:DELETE
URI Comments

./classifier1s/{classifier1_id} Deletes the specified Classifier1 object.

DOMAIN-ASSET RELATED APIs 139

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Classifier1

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator ID.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
classification List<String> reflist R/O
_hierarchy
modified_by String ref R/O
code String string R/W
description String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 140

 Centric 8 REST API DEVELOPER GUIDE

Classifier2
Creating Classifier2
Method:POST
URI Comments

./classifier1s/{classifier1_id}/hierarchy Creates a new Classifier2 object as a child of

Classifier1

Reading Classifier2
Method:GET
URI Comments

./classifier1s/{classifier1_id}/hierarchy[?[ Retrieves the Classification2 objects owned

skip=m][[&]limit=n][[& by Classification1 which match the
<filter_parameters>]..] <filter_parameters>
./classifier2s/{classifier2_id} Retrieves the specified Classifier2 object.
./classifier2s[?[skip=m][[&]limit=n][[& Retrieves the Classifier2 objects which
<filter_parameters>]..] match the <filter_parameters>

Updating Classifier2
Method:PUT
URI Comments

./classifier2s/{classifier2_id} Updates the specified Classifier2 object.

Deleting Classifier2
Method:DELETE
URI Comments

./classifier2s/{classifier2_id} Deletes the specified Classifier2 object.

DOMAIN-ASSET RELATED APIs 141

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Classifier2

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator ID.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
classification List<String> reflist R/O
_hierarchy
modified_by String ref R/O
code String string R/W
description String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 142

 Centric 8 REST API DEVELOPER GUIDE

Classifier3
Creating Classifier3
Method:POST
URI Comments

./classifier2s/{classifier2_id}/hierarchy Creates a new Classifier3 object as a child of

Classifier2

Reading Classifier3
Method:GET
URI Comments

./classifier2s/{classifier2_id}/hierarchy[?[ Retrieves the Classification3 objects owned

skip=m][[&]limit=n][[& by Classification2 which match the
<filter_parameters>]..] <filter_parameters>
./classifier3s/{classifier3_id} Retrieves the specified Classifier3 object.
./classifier3s[?[skip=m][[&]limit=n][[& Retrieves the Classifier3 objects which
<filter_parameters>]..] match the <filter_parameters>

Updating Classifier3
Method:PUT
URI Comments

./classifier3s/{classifier3_id} Updates the specified Classifier3 object.

Deleting Classifier3
Method:DELETE
URI Comments

./classifier3s/{classifier3_id} Deletes the specified Classifier3 object.

DOMAIN-ASSET RELATED APIs 143

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Classifier3

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
active Boolean boolean R/W
code String string R/W
description String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.

DOMAIN-ASSET RELATED APIs 144

 Centric 8 REST API DEVELOPER GUIDE

Collection
Creating Collection
Method:POST
URI Comments

./category2s/{category2_id}/hierarchy Creates a new Collection object as a child of

Category2.

Reading Collection
Method:GET
URI Comments

./category2s/{category2_id}/hierarchy[?[skip=m Retrieves the Collection objects owned

][[&]limit=n][[& <filter_parameters>]..]
./collections/{collection_id}
./collections[?[skip=m][[&]limit=n][[&
<filter_parameters>]..]
by Category2 which match the
<filter_parameters>
Retrieves the specified Collection
object.
Retrieves the Collection objects which
match the <filter_parameters>

Updating Collection
Method:PUT
URI Comments

./collections/{collection_id} Updates the specified Collection object.

Deleting Collection
Method:DELETE
URI Comments

./collections/{collection_id} Deletes the specified Collection object.

DOMAIN-ASSET RELATED APIs 145

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Collection

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_colorway integer R/O
cnt_style integer R/O
category_1 ref Category1 R/O
category_2 ref Category2 R/O
hierarchy reflist Style R/O
issues reflist Issue; R/O
Operation
sIssue
modified_by ref User R/O
parent_season ref Season R/O
code string R/W
description string R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.
• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 146

 Centric 8 REST API DEVELOPER GUIDE

ColorColorwayContext
Creating ColorColorwayContext
Method:POST
URI Comments

./themes/{theme_id}/color_colorways Creates a new ColorColorwayContext object as a

child of Theme.

Reading ColorColorwayContext
Method:GET
URI Comments

./themes/{theme_id}/color_colorway[?[skip=m][[ Retrieves the ColorColorwayContext

&]limit=n][[& <filter_parameters>]..]
./color_colorway_contexts/{color_colorway_con
texts_id}
./color_colorway_contexts[?[skip=m][[&]limit=
n][[& <filter_parameters>]..]
objects referenced in theme which
match the <filter_parameters>
Retrieves the specified
ColorColorwayContext object.
Retrieves the ColorColorwayContext
objects which match the
<filter_parameters>

Updating ColorColorwayContext
Method:PUT
URI Comments

./color_colorway_contexts/{color_colo Updates the specified ColorColorwayContext object.

rway_contexts_id}

Deleting ColorColorwayContext
Method:DELETE
URI Comments

./color_colorway_contexts/{color_colo Deletes the specified ColorColorwayContext object.

rway_contexts_id}

DOMAIN-ASSET RELATED APIs 147

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ColorColorwayContext

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
original String ref R/O
available Boolean boolean R/W
carry_over Boolean boolean R/W
actual String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.

DOMAIN-ASSET RELATED APIs 148


ColorDataSheet
Creating ColorDataSheet
Method:POST
URI
./color_materials/{color_material_id}/data
_sheets/color_data_sheet
Reading ColorDataSheet
Method:GET
URI
./color_materials/{color_material_id}/
data_sheets/color_data_sheet[?[skip=m]
[[&]limit=n][& <filter_parameters>]..]
./color_data_sheets/{color_data_sheet_id}
./color_data_sheets[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
Updating ColorDataSheet
Method:PUT
URI
./color_data_sheets/{color_data_sheet_id}
Deleting ColorDataSheet
Method:DELETE
URI
./color_data_sheets/{color_data_sheet_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new ColorDataSheet object as a
child of ColorMaterial.
Comments
Retrieves the ColorDataSheet objects
referenced by ColorMaterial which match
the <filter_parameters>
Retrieves the specified ColorDataSheet
object.
Retrieves the ColorDataSheet objects
which match the <filter_parameters>
Comments
Updates the specified ColorDataSheet
object.
Comments
Deletes the specified ColorDataSheet
object.
149
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ColorDataSheet

Attribute Data Type Ref. Read Only Description

Type

id CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
current_revision ref ColorData R/O
SheetRevi
sion
latest_revision ref ColorData R/O
SheetRevi
sion
modified_by ref User R/O
revisions refvector ColorData R/O
SheetRevi
sion
can_track_by_calenda boolean R/W
r
code string R/W
description string R/W
due_date time R/W
requested_by string R/W
status enum R/W
sub_type enum R/W
subtype ref ColorData C/O
SheetSub
type
for_product_source ref ProductS R/W
ource
links (_links) refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.
• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 150

 Centric 8 REST API DEVELOPER GUIDE

ColorDataSheetRevision
Creating ColorDataSheetRevision
Method:POST
URI Comments

./color_data_sheet_revisions/ Creates a new Revision for the specified

ColorDataSheetRevision object
{color_data_sheet_revision_id}/
revise

Reading ColorDataSheetRevision
Method:GET
URI Comments

./color_data_sheet_revisions/ Retrieves the specified

{color_data_sheet_revision_id}
./color_data_sheet_revisions[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
ColorDataSheetRevision object
Retrieves the ColorDataSheetRevision
objects which match the filter parameters.

Updating ColorDataSheetRevision
Method:PUT
URI Comments

./color_data_sheet_revisions/ Updates the specified

{color_data_sheet_revision_id}
./color_data_sheet_revisions/
{color_data_sheet_revision_id}?action={act
ion_name}
ColorDataSheetRevision object.
Update the specified
ColorDataSheetRevision object and
changes the revision state based on the
actions enum list APPROVED,
ABANDONED, FREEZE, REOPEN,
REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

ColorDataSheetRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 151

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ColorDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref ColorDataSheet R/O
Revision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 152


ColoInPalette
Creating ColorInPalette
Method:POST
URI
./color_palettes/{color_palette_id}/elemen
ts
./styles/{style_id}/color_specification
./materials/{material_id}/color_specificat
ion
Reading ColorInPalette
Method:GET
URI
./color_palettes/{color_palette_id}/elemen
ts[?[skip=m][[&]limit=n][&...]]
./styles/{style_id}/color_specification[?[
skip=m][[&]limit=n][&...]]
./materials/{material_id}/color_specificat
ion[?[skip=m][[&]limit=n][&...]]
./color_in_palettes/{color_in_palette_id}
./color_in_palettes[?[skip=m][[&]limit=n][
&...]]
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new ColorInPalette object as a
child of ColorPalette.
Create a new ColorInPalette object as a
child of Style.
Create a new ColorInPalette object as a
child of Material.
Comments
Retrieve the ColorInPalette objects
referenced by ColorPalette which match
filter parameters specified as query string
values.
Retrieve the ColorInPalette objects
referenced by Style which match filter
parameters specified as query string
values.
Retrieve the ColorInPalette objects
referenced by Material which match filter
parameters specified as query string
values.
Retrieve the specified ColorInPalette
object.
Retrieve the ColorInPalette objects which
match <filter parameters> specified as
query string values.
153
 Centric 8 REST API DEVELOPER GUIDE

Updating ColorInPalette
Method:PUT
URI Comments

./color_in_palettes/{color_in_palette_id} Update the specified ColorInPalette object.

Deleting ColorInPalette
Method:DELETE
URI Comments

./color_in_palettes/{color_in_palette_id} Delete the specified ColorInPalette object.

Attribute Summary

Attribute Type Oject Read Description

Only@

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
sys_id string R/O
actual ref PrintDesignCol R/O
or;
ColorInPalette;
ColorSpecifica
tion
libraries refset LibColorSpecif R/O
ication
merged_to ref ColorInPalette R/O
modified_by ref User R/O
recent_child_comments refvector Comment R/O
recent_comments refvector Comment R/O
active boolean R/W
code string R/W
description string R/W
ok_for_material boolean R/W
ok_for_style boolean R/W
color_specification ref PrintDesignColo C/O
r;
ColorInPalette;
ColorSpecificati
on
documents reflist Document R/W

DOMAIN-ASSET RELATED APIs 154

 Centric 8 REST API DEVELOPER GUIDE

images refmap Image R/W

referenced_documents reflist Document R/W
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

@ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 155

 Centric 8 REST API DEVELOPER GUIDE

ColorMaterial
Creating ColorMaterial
Method:POST
URI Comments

./materials/{material_id}/product_colors Creates a new ColorMaterial object as a

child of Material.

Reading ColorMaterial
Method:GET
URI Comments

./materials/{material_id}/product_colors[? Retrieves the ColorMaterial objects owned

[skip=m][[&]limit=n][&
<filter_parameters>]..]
./color_materials/{color_material_id}
./color_materials[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
by Material which match the
<filter_parameters>
Retrieves the specified ColorMaterial
object.
Retrieves the ColorMaterial objects which
match the <filter_parameters>

Updating ColorMaterial
Method:PUT
URI Comments

./color_materials/{color_material_id} Updates the specified ColorMaterial object.

Deleting ColorMaterial
Method:DELETE
URI Comments

./color_materials/{color_material_id} Deletes the specified ColorMaterial object.

DOMAIN-ASSET RELATED APIs 156

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ColorMaterial

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_order integer R/O
cnt_purchased_order integer R/O
earliest_target_date time R/O
status_time time R/O
total_order_volume double R/O
total_sample_volume double R/O
color_material_skus reflist SKUMater R/O
ial
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
samples reflist MateriaSa R/O
mple
cnt_documents integer R/O
active boolean R/W
description string R/W
status enum R/W
color_material_samples refmap MaterialS R/W
ample
color_specification ref ColorSpec R/W
ification
images refmap Image R/W
referenced_documents reflist Document R/W
default_3d_material ref Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 157

 Centric 8 REST API DEVELOPER GUIDE

ColorPalette
Creating ColorPalette
Method:POST
URI Comments

./color_palettes Create a new ColorPalette object.

Reading ColorPalette
Method:GET
URI Comments

./color_palettes/{color_palette_id} Update the specified ColorPalette object.

./color_palettes[?[skip=m][[&]limit=n][&.. Retrieve the ColorPalette objects which

.]] match <filter parameters> specified as
query string values.

Updating ColorPalette
Method:PUT
URI Comments

./color_palettes/{color_palette_id} Update the specified ColorPalette object.

Deleting ColorPalette
Method:DELETE
URI Comments

./color_palettes/{color_palette_id} Delete the specified ColorPalette object.

DOMAIN-ASSET RELATED APIs 158

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Oject Read Description

Only@

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
recent_comments refvector Comment R/O
category_1_names stringset C/O
category_2_names stringset C/O
code string R/W
collection_names stringset C/O
description string R/W
elements refvector ColorInPalette R/W
images refmap Image R/W
seasons refset Season C/O
subtype** ref ColorPaletteS C/O
ubtype
links (_links) refmap R/O C8 Ref to URL Lookup map.

** This attribute is required when creating a new ColorPalette object.

@ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 159

 Centric 8 REST API DEVELOPER GUIDE

ColorSpecification
Creating ColorSpecification
Method:POST
URI Comments

./lib_color_specifications/ Creates a new ColorSpecification object as

a child of LibColorSpecification.

{lib_color_specification_id}/elements

./color_specifications Creates a new ColorSpecification object.

Reading ColorSpecification
Method:GET
URI Comments

./lib_color_specifications/ Retrieves the ColorSpecification

objects referenced by
{lib_color_specification_id}/elements LibColorSpecification, which match
the <filter_parameters> included in
the resource_path.
[?[skip=m][[&]limit=n][& <filter_parameters>]..]
./color_specifications/{color_specification_id} Retrieves the specified
ColorSpecification object.
./color_specifications[?[skip=m] Retrieves the ColorSpecification
objects which match the
[[&]limit=n][& <filter_parameters>]..] <filter_parameters> included in the
resource_path.

Updating ColorSpecification
Method:PUT
URI Comments

./color_specifications/{color_specification_id} Updates the specified

ColorSpecification object.

Deleting ColorSpecification
Method:DELETE
URI Comments

./color_specifications/{color_specification_id} Deletes the specified

ColorSpecification object.

DOMAIN-ASSET RELATED APIs 160

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ColorSpecification

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
active Boolean boolean R/W
cmyk String string R/W
code String string R/W
color_model String string R/W
color_type String string R/W
description String string R/W
ok_for_material Boolean boolean R/W
ok_for_style Boolean boolean R/W
pantone String string R/W
pantone_tc String string R/W
rgb Integer integer R/W (Not: CMYK, RGBHex, RGBTriple)
rgb_hex String string R/W (Not: CMYK, RGB, RGBTriple)
rgb_triple String string R/W (Not: CMYK, RGB, RGBHex)
tags List stringvector R/W
images Map<String, refmap R/O
String>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 161

 Centric 8 REST API DEVELOPER GUIDE

Colorway
Creating Colorway
Method:POST
URI Comments

./styles/{style_id}/product_colors Creates a new Colorway object as a child

of Style.

Reading Colorway
Method:GET
URI Comments

./styles/{style_id}/product_colors[?[skip= Retrieves the Colorway objects owned by

m][[&]limit=n][& <filter_parameters>]..] Style which match the <filter_parameters>
included in the resource_path.
./colorways/{colorway_id} Retrieves the specified Colorway object.

./colorways[?[skip=m][[&]limit=n][& Retrieves the Colorway objects which

<filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating Colorway
Method:PUT

URI Comments

./colorways/{colorway_id} Updates the specified Colorway object.

Deleting Colorway
Method:DELETE
URI Comments

./colorways/{colorway_id} Deletes the specified Colorway object.

DOMAIN-ASSET RELATED APIs 162

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Colorway

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
modified_by String ref R/O
node_name String string R/W Display name for the object.
carry_over Boolean boolean R/O
cnt_customer_purchase_order Integer integer R/O Customer Purchase Order Count
cnt_order Integer integer R/O
cnt_purchased_order Integer integer R/O Purchased Order Count
customer_earliest_target_date String time R/O
customer_total_order_volume Double double R/O
earliest_target_date String time R/O
inline Boolean boolean R/O
sales_volume Integer integer R/O
sys_id String string R/O Identifier to correlate revised
entities.
total_order_volume Double double R/O
total_sample_volume Double double R/O
carried_over_from_colorways List reflist R/O
category_1 String ref R/O Containing Category1
category_2 String ref R/O Containing Category2
collection String ref R/O Containing Collection
colorway_skus List reflist R/O
copied_from String ref R/O
images Map refmap R/O [6.0] Images associated with this
Colorway
parent_season String ref R/O
samples List reflist R/O
style String ref R/O
active Boolean boolean R/W
code String string R/W Control code.
description String string R/W
development_type String enum R/W
intro_date String time R/W
production_min Integer integer R/W Production Minimum
color_specification String ref R/W Referenced by Color Specification
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 163

 Centric 8 REST API DEVELOPER GUIDE

Comment
Creating Comment
Method:POST
URI Comments

./comments Creates a new Comment object.

./comments/parent/{parent_id} Create Comment from the specified parent object. The
parent should be derived from DocAndCommentOwner
object.

Reading Comment
Method:GET
URI Comments

./comments/{comments_id} Retrieves the specified Comment object.

./comments[?[skip=m][[&]limit=n][& Retrieves the Comment objects which matches the

<filter_parameters>]..] <filter_parameters> included in the resource_path.

./comments/parent/{parent_id} Retreieve the list of Comments for the specified

parent object. The parent should be derived from
DocAndCommentOwner object.

Updating Comment
Method:PUT

URI Comments

./comments/{comments_id} Updates the specified Comment object.

Deleting Comment
Method:DELETE
URI Comments

./comments/{comments_id} Deletes the specified Comment object.

DOMAIN-ASSET RELATED APIs 164

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Comment

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
date time R/O
author ref User R/O
last_post ref Comment; R/O
Comment
Reply
modified_by ref User R/O
replies refvector Comment R/O
Reply
comment string R/W
files urlmap R/W
images reflist Image R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 165

 Centric 8 REST API DEVELOPER GUIDE

CommentReply
Creating CommentReply
Method:POST
URI Comments

./comments/{comment_id}/replies Create a CommentReply as a child of specified Comment.

Reading CommentReply
Method:GET
URI Comments

./comments/{comments_id}/replies Retrieves the CommentReplies referenced by

Comment and which match the filter parameters.
[?[skip=m][[&]limit=n]

[& <filter_parameters>]..]
./comment_replies/{comment_reply_id} Retrieves the specified CommentReply object.

./comment_replies[?[skip=m] Retrieve the list of CommentReplies which match

the filter parameters.
[[&]limit=n][& <filter_parameters>]..]

Updating CommentReply
Method:PUT

URI Comments

./comment_replies/{comment_reply_id} Updates the specified CommentReply object.

Deleting CommentReply
Method:DELETE
URI Comments

./comment_replies/{comment_reply_id} Deletes the specified CommentReply object.

DOMAIN-ASSET RELATED APIs 166

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CommentReply

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
date time R/O
author ref User R/O
modified_by ref User R/O
comment string R/W
files urlmap R/W
images reflist Image R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 167

 Centric 8 REST API DEVELOPER GUIDE

CompetitiveFood
Creating CompetitiveFood
Method:POST
URI Relative Path Comments

./competitive_foods Creates a new CompetitiveFood object.

Reading CompetitiveFood
Method:GET
URI Relative Path Comments

./competitive_foods/{competitive_food_ Retrieves the specified CompetitiveFood object.

id}
./competitive_foods[?[skip=m][[&]limit Retrieves the CompetitiveFood objects which
=n][&...]] match <filter parameters> specified as query
string values.

Updating CompetitiveFood
Method:PUT

URI Relative Path Comments

./competitive_foods/{competitive_foo Updates the specified CompetitiveFood object.

d_id}

Deleting CompetitiveFood
Method:DELETE
URI Relative Path Comments

./competitive_foods/{competitive_foo Deletes the specified CompetitiveFood object.

d_id}

DOMAIN-ASSET RELATED APIs 168

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
actual_foods reflist Food R/O This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
recent_child_comment refvector Comment R/O
s
recent_comments refvector Comment R/O
description string R/W This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
price double R/W This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
strengths string R/W This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
weaknesses string R/W This attribute requires
module: FormulatedProduct t
o be installed. Otherwise, it is
ignored.
images refmap Image R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 169

 Centric 8 REST API DEVELOPER GUIDE

CompanyInfo
Reading CompanyInfo
Method:GET
URI Comments

./company_infos/{company_info_id } Retrieves the specified CompanyInfo object.

./company_infos[?[skip=m][[&]limit=n] Retrieves the CompanyInfo objects which match

[& <filter_parameters>]..] the <filter_parameters.

Updating CompanyInfo
Method:PUT
URI Comments

./company_infos/{company_info_id } Updates the specified CompanyInfo object.

Method: POST & DELETE unsupported

CompanyInfo is a read and Update only endpoint. It does

not support POST or DELETE methods.

DOMAIN-ASSET RELATED APIs 170

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CompanyInfo

Attribute Data Ref. Read Description

Type Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last modified time.
node_name string R/W Display name for the object.
active_user_count integer R/O
total_user_count integer R/O
modified_by ref User R/O
all_day_event_display_origi boolean R/W
nal_date
allow_contact_lists boolean R/W
days_until_expiration integer R/W
default_locale string R/W
default_paper_orientation enum R/W
default_paper_size enum R/W
enable_password_expiration boolean R/W
excluded_file_extensions string R/W
exempted_file_extensions string R/W
gtin_length integer R/W
lock_out_period integer R/W
lock_out_reactivation_mode enum R/W
max_active_users integer R/W
max_composition_columns integer R/W
max_email_attachment_size int64 R/W
max_result_size integer R/W
max_table_size_view_pdf integer R/W
max_view_query_seconds integer R/W
password_expiration_period integer R/W
password_max_length integer R/W
password_min_length integer R/W
password_require_lower_case boolean R/W
password_require_numeric boolean R/W
password_require_special boolean R/W
password_require_upper_case boolean R/W
password_reset_expiration_m integer R/W
inutes
show_user_name_on_header boolean R/W
total_num_of_login_attempts integer R/W
company_icon ref Image R/W
locales refmap Locale R/W
logo ref Image R/W

DOMAIN-ASSET RELATED APIs 171

 Centric 8 REST API DEVELOPER GUIDE

links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

Composition
Creating Composition
Method:POST
URI Comments

./compositions Creates a new Composition object.

Reading Composition
Method:GET
URI Comments

./compositions/{composition_id} Retrieves the specified Composition object.

./compositions[?[skip=m][[&]limit=n] Retrieves the Composition objects which matches

[& <filter_parameters>]..] the <filter_parameters> included in the
resource_path.

Updating Composition
Method:PUT

URI Comments

./compositions/{composition_id} Updates the specified Composition object.

Deleting Composition
Method:DELETE
URI Comments

./compositions/{composition_id} Deletes the specified Composition object.

DOMAIN-ASSET RELATED APIs 172

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Composition

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
modified_by String ref R/O
node_name String string R/W Display name for the object.
languages Map<string, string> stringmap R/O [6.0] Images associated with this
Colorway
links (_links) Map refmap R/O C8 Ref to URL Lookup map.
ok_for_material Boolean R/W
ok_for_style Boolean R/W

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 173

 Centric 8 REST API DEVELOPER GUIDE

CompositionPlacement
Creating CompositionPlacement
Method:POST
URI Comments

./composition_placements Creates a new CompositionPlacement object.

Reading CompositionPlacement
Method:GET
URI Comments

./composition_placements/ Retrieves the specified CompositionPlacement

{composition_placement_id}
./composition_placements
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object.
Retrieves the CompositionPlacement objects which
matches the <filter_parameters> included in the
resource_path.

Updating CompositionPlacement
Method:PUT

URI Comments

./composition_placements/ Updates the specified CompositionPlacement

object.
{composition_placement_id}

Deleting CompositionPlacement
Method:DELETE
URI Comments

./composition_placements/ Deletes the specified CompositionPlacement

object.
{composition_placement_id}

DOMAIN-ASSET RELATED APIs 174

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CompositionPlacement

Attribute Data Type Ref. Type Read Description

Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
languages Map<string, string> stringmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 175


ConfigurableAttribute
Creating ConfigurableAttribute
Method:POST
URI Relative Path
./business_objects/{business_object
_id}/configurable_attributes
./configurable_attributes
Reading ConfigurableAttribute
Method:GET
URI Relative Path
./business_objects/{business_object_i
d}/configurable_attributes[?[skip=m][
[&]limit=n][&...]]
./create_form_definitions/{create_for
m_definition_id}/configurable_attribu
tes[?[skip=m][[&]limit=n][&...]]
./configurable_attributes/{configura
ble_attribute_id}
./configurable_attributes[?[skip=m][
[&]limit=n][&...]]
Updating ConfigurableAttribute
Method:PUT
URI Relative Path
./configurable_attributes/{configurabl
e_attribute_id}
Deleting ConfigurableAttribute
Method:DELETE
URI Relative Path
./configurable_attributes/{configurabl
e_attribute_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new ConfigurableAttribute object as a
child of BusinessObject.
Creates a new ConfigurableAttribute object.
Comments
Retrieves the ConfigurableAttribute objects
referenced by BusinessObject which match filter
parameters specified as query string values.
Retrieves the ConfigurableAttribute objects
referenced by CreateFormDefinition which match
filter parameters specified as query string values.
Retrieves the specified ConfigurableAttribute
object.
Retrieves the ConfigurableAttribute objects which
match <filter parameters> specified as query string
values.
Comments
Updates the specified ConfigurableAttribute
object.
Comments
Deletes the specified ConfigurableAttribute
object.
176
 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
applied_on time R/O
attribute_flags int64 R/O
copy_categories enummap R/O
copy_option_name string R/O
initial_value string R/O
modified boolean R/O
optional boolean R/O
value_type string R/O
attribute_groups reflist Configurable R/O
AttributeGrou
p
modified_by ref User R/O
form_only boolean R/W
create_only boolean R/W
comment_restricted boolean R/W
drag_edit_disabled boolean R/W
enabled boolean R/W
expression string R/W
expression_on_client boolean R/W
_disabled
format string R/W
notes string R/W
required boolean R/W
rest_restricted boolean R/W
rest_update boolean R/W
validation_expressio string R/W
n
viable_matrix boolean R/W
depends_on ref CustomAttrib R/W
ute;
BuildInAttribu
te
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 177

 Centric 8 REST API DEVELOPER GUIDE

Contact
Creating Contact
Method:POST

URI Comments

./customer_purchase_orders/ Create a new Contact object as a child

of CustomerPurchaseOrder.
{customer_purchase_order_id}/

po_customer_frozen_contact

./purchase_orders/{purchase_order_id}/ Create a new Contact object as a child

of PurchaseOrder.
po_factory_frozen_contact

./sales_orders/{sales_order_id}/buyer_contact Create a new Contact object as a child

_frozen of SalesOrder.

./sales_orders/{sales_order_id}/buyer_contact Create a new Contact object as a child

_frozen of SalesOrder.

./sales_orders/{sales_order_id}/buyer_ship_to Create a new Contact object as a child

_frozen of SalesOrder.

./sales_orders/{sales_order_id}/seller_contac Create a new Contact object as a child

t_frozen of SalesOrder.

./sales_orders/{sales_order_id}/seller_pay_to Create a new Contact object as a child

_frozen of SalesOrder.

./shipment_terms/{shipment_term_id}/alternati Create a new Contact object as a child

ve_stuffing_location of ShipmentTerm.

./shipping_ports/{shipping_port_id}/contacts Create a new Contact object as a child

of ShippingPort.

./suppliers/{supplier_id}/contacts Create a new Contact object as a child

of Supplier.

./factories/{factory_id}/contacts Create a new Contact object as a child

of Factory.

DOMAIN-ASSET RELATED APIs 178

 Centric 8 REST API DEVELOPER GUIDE

Reading Contact
Method:GET
URI Comments

./customer_purchase_orders/ Retrieve the Contact objects referenced by

CustomerPurchaseOrder which match query
{customer_purchase_order_id}/ string values.

po_customer_frozen_contact[?[skip=m][
[&]limit=n][&<filter_parameters>]..]
./purchase_orders/{purchase_order_id} Retrieve the Contact objects referenced by
/ PurchaseOrder which match query string values.

po_factory_frozen_contact[?[skip=m][[
&]limit=n]

[&<filter_parameters>]..]
./sales_orders/{sales_order_id}/buyer Retrieve the Contact objects referenced by
_bill_to_frozen SalesOrder which match query string values.

[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
./sales_orders/{sales_order_id}/ Retrieve the Contact objects referenced by
SalesOrder which match query string values.
buyer_contact_frozen[?[skip=m][[&]lim
it=n]

[&<filter_parameters>]..]
./sales_orders/{sales_order_id}/buyer
_ship_to_frozen
[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
./sales_orders/{sales_order_id}/selle
r_contact_frozen
[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
./sales_orders/{sales_order_id}/selle
r_pay_to_frozen
[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
./shipment_terms/{shipment_term_id}/
alternative_stuffing_location[?[skip=
m][[&]limit=n]
Retrieve the Contact objects referenced by
SalesOrder which match filter parameters
specified as query string values.
Retrieve the Contact objects referenced by
SalesOrder which match filter parameters
specified as query string values.
Retrieve the Contact objects referenced by
SalesOrder which match filter parameters
specified as query string values.
Retrieve the Contact objects referenced by
ShipmentTerm which match filter parameters
specified as query string values.

[&<filter_parameters>]..]

DOMAIN-ASSET RELATED APIs 179


./shipping_ports/{shipping_port_id}/c
ontacts
[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
./suppliers/{supplier_id}/contacts[?[
skip=m][[&]limit=n][&<filter_paramete
rs>]..]
./factories/{factory_id}/contacts[?[s
kip=m][[&]limit=n][&...]]
./contacts/{contact_id}
./contacts[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
Updating Contact
Method:PUT
URI
./contacts/{contact_id}
Deleting Contact
Method:DELETE
URI
./contacts/{contact_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Retrieve the Contact objects referenced by
ShippingPort which match filter parameters
specified as query string values.
Retrieve the Contact objects referenced by
Supplier which match filter parameters specified
as query string values.
Retrieve the Contact objects referenced by
Factory which match filter parameters specified as
query string values.
Retrieve the specified Contact object.
Retrieve the Contact objects which match <filter
parameters> specified as query string values.
Comments
Updates the specified Contact object.
Comments
Deletes the specified Contact object.
180
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Contact

Attribute Data Type Ref. Type Read Description

Write
id string CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
address string R/W
address_1 string R/W
address_2 string R/W
city string R/W
company string R/W
email string R/W
fax string R/W
job_title string R/W
language string R/W
localized_address string R/W
mobile string R/W
payment_term string R/W
phone_number string R/W
photocopy_number string R/W
postal_code string R/W
purpose string R/W
trade_term enum R/W
website string R/W
country ref Country R/W
province_state ref ProvinceState R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 181

 Centric 8 REST API DEVELOPER GUIDE

ContractualDocument
Creating ContractualDocument
Method:POST
URI Comments

./contractual_document_groups/{contractual Create a new ContractualDocument

_document_group_id}/contractual_documents object as a child of
ContractualDocumentGroup

./contractual_documents Create a new ContractualDocument

object.

Reading ContractualDocument
Method:GET
URI Comments

./contractual_document_groups/{contra Retrieve the ContractualDocument objects

ctual_document_group_id}/contractual_ referenced by ContractualDocumentGroup which
documents[?[skip=m][[&]limit=n][&...] match filter parameters specified as query string
] values.
./contractual_documents/{contractual_ Retrieve the specified ContractualDocument
document_id} object.
./contractual_documents[?[skip=m][[&] Retrieve the Contact objects referenced by
limit=n][&<filter_parameters>]..] SalesOrder which match query string values.

Updating ContractualDocument
Method:PUT
URI Comments

./contractual_documents/{contractual_ Updates the specifiedContractualDocument object.

document_id}

Deleting ContractualDocument
Method:DELETE
URI Comments

./contractual_documents/{contractual_ Deletes the specified ContractualDocument

document_id} object.

DOMAIN-ASSET RELATED APIs 182

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ContractualDocument

Attribute Data Type Ref. Type Read Write Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
kpi String enum R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
usable_for_supplier Boolean boolean R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
visible_for_supplier Boolean boolean R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
latest_revision String ref R/O
modified_by String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
revisions List<String> refvector R/O
description String string R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
required Boolean boolean R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
source_type String enum C/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
subtype String ref C/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 183

 Centric 8 REST API DEVELOPER GUIDE

ContractualDocumentGroup
Creating ContractualDocumentGroup
Method:POST
URI Comments

./contractual_document_groups Create a new ContractualDocumentGroup object

Reading ContractualDocumentGroup
Method:GET
URI Comments

./contractual_document_groups/ Retrieve the specified ContractualDocumentGroup object.

{contractual_document_group_id}
./contractual_document_groups[? Retrieve the ContractualDocumentGroup objects
[skip=m][[&]limit=n][&<filter_p referenced by ContractualDocumentGroup which match
arameters>]..] filter parameters specified as query string values.

Updating ContractualDocumentGroup
Method:PUT
URI Comments

./contractual_document_groups/ Updates the specified ContractualDocumentGroup

object.
{contractual_document_group_id}

Deleting ContractualDocumentGroup
Method:DELETE
URI Comments

./contractual_document_groups/ Deletes the specified

ContractualDocumentGroupobject.
{contractual_document_group_id}

DOMAIN-ASSET RELATED APIs 184

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ContractualDocumentGroup

Attribute Data Type Ref. Read Description

Type Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
has_usable_for_supplier_c_doc Boolean boolean R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
contractual_documents List<String> reflist R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
modified_by String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
description String string R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 185

 Centric 8 REST API DEVELOPER GUIDE

ContractualDocumentPackage
Creating ContractualDocumentPackage
Method:POST
URI Comments

./suppliers/{supplier_id}/ Create a new ContractualDocumentPackage object as

a child of Supplier.
supplier_contractual_doc_pkgs

Reading ContractualDocumentPackage
Method:GET
URI Comments

./suppliers/{supplier_id}/ Retrieve the ContractualDocumentPackage

objects referenced by Supplier, which match the
supplier_contractual_doc_pkgs filter parameter.

[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./contractual_document_packages/ Retrieve the specified
ContractualDocumentPackage object.
{contractual_document_package_id}
./contractual_document_packages Retrieve the ContractualDocumentPackage
objects which match the filter parameter.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating ContractualDocumentPackage
Method:PUT
URI Comments

./contractual_document_packages/ Updates the

specifiedContractualDocumentPackage object.
{contractual_document_package_id}

Deleting ContractualDocumentPackage
Method:DELETE
URI Comments

./contractual_document_packages/ Deletes the specified ContractualDocumentPackage

object.
{contractual_document_package_id}

DOMAIN-ASSET RELATED APIs 186

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ContractualDocumentPackage

Attribute Data Ref. Type Read Description

Type Write
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
pdf url R/O
cdp_documents reflist Document R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
package_contractual_documents refvector ContractualDocu R/O This attribute requires
ment;
SupplierContract
module: Quality to be installed.
ualDocument Otherwise, it is ignored.
description string R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
message string R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
cover_sheet_view ref _CS_Preference R/W This attribute requires
View
module: Quality to be installed.
Otherwise, it is ignored.
email_history_items reflist EmailHistoryItem R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 187

 Centric 8 REST API DEVELOPER GUIDE

ContractualDocumentRevision
Creating ContractualDocumentRevision
Method:POST
URI Comments

./contractual_document_revisions/ Creates a new revision for the specified

ContractualDocumentRevision.
{contractual_document_revision_id}/revise

Reading ContractualDocumentRevision
Method:GET
URI Comments

./contractual_document_revisions/ Retrieves the specified ContractualDocumentRevision

object.
{ contractual_document_revision_id}

./contractual_document_revisions[?[s Retrieves the ContractualDocumentRevision objects

kip=m][[&]limit=n][[&<filter_paramet which match the <filter_parameters>
ers>]..]

Updating ContractualDocumentRevision
Method:PUT
URI Comments

./contractual_document_revisions/{con Updates the specified ContractualDocumentRevision

tractual_document_revision_id}
./contractual_document_revisions/{con
tractual_document_revision_id}?action
={action_name}
object.
Updates the specified ContractualDocumentRevision
object and changes the revision state based on the
actions enum list: APPROVED, REVERT, CLOSED,
FREEZE

Method: DELETE unsupported

ContractualDocumentRevision does not support DELETE

method.

DOMAIN-ASSET RELATED APIs 188

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ContractualDocumentRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_number Integer integer R/O
effective_from String time R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
effective_to String time R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
is_current Boolean boolean R/O
pending_2_time String time R/O
pending_time String time R/O
renewal_period String enum R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
revert_time String time R/O
review_time String time R/O
source_file String url R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
source_object_type String enum R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
comments List<String> reflist R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
current_revision String ref R/O
modified_by String ref R/O
pending_2_user String ref R/O
pending_user String ref R/O
phase String ref R/O
revert_user String ref R/O
review_user String ref R/O
state_change_user String ref R/O
description String string R/W
revision_comment String string R/W
_url_base_template String string R/O File (image, pdf, document) retrieval
URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 189

 Centric 8 REST API DEVELOPER GUIDE

ContractualDocumentSubtype
Creating ContractualDocumentSubtype
Method:POST
URI Comments

./contractual_document_subtypes Create a new ContractualDocumentSubtype object.

Reading ContractualDocumentSubtype
Method:GET
URI Comments

./contractual_document_subtypes/ Retrieves the specified ContractualDocumentSubtype

object.
{contractual_document_subtype_id}
./contractual_document_subtypes/ Retrieves the ContractualDocumentSubtype objects
which match the <filter_parameters>
{contractual_document_subtype_id}
[?[skip=m][[&]limit=n][[&<filter_
parameters>]..]

Updating ContractualDocumentSubtype
Method:PUT
URI Comments

./contractual_document_subtypes/ Updates the specified ContractualDocumentSubtype

object.
{contractual_document_subtype_id}

Deleting ContractualDocumentSubtype
Method:DELETE
URI Comments

./contractual_document_subtypes/ Deletes the specified ContractualDocumentSubtype

object.
{contractual_document_subtype_id}

DOMAIN-ASSET RELATED APIs 190

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ContractualDocumentSubtype

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
applied_on String time R/O
published Boolean boolean R/O
validation_rule String string R/O
_group_name
workflow_name String string R/O
modified_by String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
active Boolean boolean R/W
auto_create_pdf Boolean boolean R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
has_effectivity Boolean boolean R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
has_renewal_per Boolean boolean R/W This attribute requires
iod module: Quality to be installed.
Otherwise, it is ignored.
renewal_period_ Boolean boolean R/W This attribute requires
begins_on_recei module: Quality to be installed.
pt Otherwise, it is ignored.
requires_acknow Boolean boolean R/W This attribute requires
ledgement module: Quality to be installed.
Otherwise, it is ignored.
track_usage Boolean boolean R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 191

 Centric 8 REST API DEVELOPER GUIDE

CostMaterial
Creating CostMaterial
Method:POST
URI Comments

./cost_routing_groups/{cost_routing_gro Create a new CostMaterial object as a child of

up_id}/ CostRoutingGroup.
materials

Reading CostMaterial
Method:GET
URI Comments

./cost_routing_groups/{cost_routing_gro Retrieve the CostMaterial objects referenced

up_id by CostRoutingGroup which match filter
parameters specified as query string values.
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]

./cost_materials/{cost_material_id} Retrieve the specified CostMaterial object.

./cost_materials[?[skip=m][[&]limit=n] Retrieve the CostMaterial objects which match

<filter parameters> specified as query string
[& <filter_parameters>]..] values.

Updating CostMaterial
Method:PUT
URI Comments

./cost_materials/{cost_material_id} Updates the specified CostMaterial object.

Deleting CostMaterial
Method:DELETE
URI Comments

./cost_materials/{cost_material_id} Deletes the specified CostMaterial object.

DOMAIN-ASSET RELATED APIs 192

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of CostMaterial

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
ad_hoc boolean R/O
duty_total double R/O
freight_total double R/O
material_burden double R/O
material_fob_cost double R/O
material_total double R/O
quantity_usage double R/O
raw_material_freight double R/O
modified_by ref User R/O
cost_material_name string R/W
description string R/W
duty_additional double R/W
duty_pct double R/W
freight_additional double R/W
freight_cost double R/W
material_burden_pct double R/W
qty_per_container double R/W
quantity double R/W
raw_material_freight_p double R/W
ct
unit_price double R/W
usage_factor_pct double R/W
cost_duty_rate ref DutyRate R/W
cost_product ref Shape; Style; R/W
Material
cost_quote ref SupplierItem R/W
cost_shipping_rate ref ShippingRate R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 193

 Centric 8 REST API DEVELOPER GUIDE

CostRoutingGroup
Reading CostRoutingGroup
Method:GET
URI Comments

./cost_scenarios/{cost_scenario_id}/gro Retrieve the CostRoutingGroup objects

ups referenced by CostScenario which match filter
parameters specified as query string values.
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]

./cost_routing_groups/{cost_routing_gro Retrieve the specified CostRoutingGroup

up_id} object.
./cost_routing_groups[?[skip=m][[&]limi Retrieve the CostRoutingGroup objects which
t=n] match <filter parameters> specified as query
string values.
[& <filter_parameters>]..]

Updating CostRoutingGroup
Method:PUT
URI Comments

./cost_routing_groups/{cost_routing_gro Updates the specified CostRoutingGroup

up_id} object.

Method: POST and DELETE unsupported

CostRoutingGroup is a read and update only endpoint. It

does not support POST and Delete methods.

DOMAIN-ASSET RELATED APIs 194

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of CostRoutingGroup

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
duty_total double R/O
freight_total double R/O
labor_cost double R/O
material_burden double R/O
material_fob_cost double R/O
material_total double R/O
operation_total double R/O
overhead_cost double R/O
raw_material_freight double R/O
total_cost double R/O
modified_by ref User R/O
fixed_oh_rate double R/W
labor_rate double R/W
material_burden_pct double R/W
raw_material_freight_p double R/W
ct
variable_oh_rate double R/W
cost_factory ref Factory R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 195

 Centric 8 REST API DEVELOPER GUIDE

CostRoutingItem
Creating CostRoutingItem
Method:POST
URI Comments

./cost_routing_groups/{cost_routing_gro Create a new CostRoutingItem object as a

up_id}/operations child of CostRoutingGroup.

./cost_routing_items Create a new CostRoutingItem object.

Reading CostRoutingItem
Method:GET
URI Comments

./cost_routing_groups/{cost_routing_gro Retrieve the CostRoutingItem objects

up_id}/
operations[?[skip=m][[&]limit=n][&...]]
./cost_routing_items/{cost_routing_item
_id}
./cost_routing_items[?[skip=m][[&]limit
=n][&...]]
referenced by CostRoutingGroup which match
filter parameters specified as query string
values.
Retrieve the specified CostRoutingItem object.
Retrieve the CostRoutingItem objects which
match <filter parameters> specified as query
string values.

Updating CostRoutingItem
Method:PUT
URI Comments

/cost_routing_items/{cost_routing_item_ Updates the specified CostRoutingItem object.

id}

Deleting CostRoutingItem
Method:DELETE
URI Comments

/cost_routing_items/{cost_routing_item_ Deletes the specified CostRoutingItem object.

id}

DOMAIN-ASSET RELATED APIs 196

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of CostRoutingItem

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
labor_cost double R/O
operation_total double R/O
overhead_cost double R/O
modified_by ref User R/O
description string R/W
pcs_per_hr double R/W
cost_item ref RoutingItem R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 197

 Centric 8 REST API DEVELOPER GUIDE

CostScenario
Creating CostScenario
Method:POST
URI Comments

./supplier_item_revisions/ Create a new CostScenario object as a child of

SupplierItemRevision.
{supplier_item_revision_id}/quote_cost_
scenario

Reading CostScenario
Method:GET
URI Comments

./supplier_item_revisions/{supplier_ite Retrieve the CostScenario objects referenced

m_revision_id}/ by SupplierItemRevision which match filter
parameters specified as query string values.
quote_cost_scenario[?[skip=m][[&]limit=
n]

[& <filter_parameters>]..]

./cost_scenarios/{cost_scenario_id} Retrieve the specified CostScenario object.

./cost_scenarios[?[skip=m][[&]limit=n][ Retrieve the CostScenario objects which match

& <filter_parameters>]..] <filter parameters> specified as query string
values.

Updating CostScenario
Method:PUT
URI Comments

./cost_scenarios/{cost_scenario_id} Updates the specified Comment object.

Deleting CostScenario
Method:DELETE
URI Comments

./cost_scenarios/{cost_scenario_id} Deletes the specified Comment object.

DOMAIN-ASSET RELATED APIs 198

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of CostScenario

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
duty_total double R/O
freight_total double R/O
labor_cost double R/O
material_burden double R/O
material_fob_cost double R/O
material_total double R/O
operation_total double R/O
overhead_cost double R/O
raw_material_freight double R/O
total_cost double R/O
Groups refvector CostRoutingG R/O
roup
modified_by ref User R/O
expand_bom boolean R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 199

 Centric 8 REST API DEVELOPER GUIDE

Country
Creating Country
Method:POST
URI Comments

./countries Create a new Country Object.

Reading Country
Method:GET
URI Comments

./countries/{country_id} Retrieves the specified Country object.

./countries[?[skip=m][[&]limit=n] Retrieves the Country objects which match

the <filter_parameters>
[[&<filter_parameters>]..]

Updating Country
Method:PUT
URI Comments

./countries/{country_id} Updates the specified Country object.

Deleting Country
Method:DELETE
URI Comments

./countries/{country_id} Deletes the specified Country object.

DOMAIN-ASSET RELATED APIs 200

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of Country

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
province_states reflist ProvinceState R/O
made_in stringmap R/O
country_product_sales_ reflist ProductSales R/O
region_specs RegionSpec
active boolean R/W
code string R/W
region string R/W
languages refvector Language R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 201

 Centric 8 REST API DEVELOPER GUIDE

CreateFormDefinition
Reading CreateFormDefinition
Method:GET
URI Comments

./create_form_definitions/{create_form_ Retrieves the specified CreateFormDefinition

definition_id} object.

./create_form_definitions[?[skip=m][[&] Retrieves the CreateFormDefinition objects

limit=n][&...]] which match <filter parameters> specified as
query string values.

Updating CreateFormDefinition
Method:PUT
URI Comments

./create_form_definitions/{create_form_ Updates the specified CreateFormDefinition

definition_id} object.

DOMAIN-ASSET RELATED APIs 202

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
modified_by ref User R/O
configurable_attrib refvector CustomAttribute R/W
utes ; BuildInAttribute
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 203

 Centric 8 REST API DEVELOPER GUIDE

Crew
Creating Crew
Method:POST
URI Comments

./crews/parent/{parent_id} Creates a new Crew object from the parent with specified id.
A list of valid parent object types are listed below.

Valid parent objects for a Crew

Category1 PrintDesignSecurityGroup
Category2 ProductSource
Collection PurchasedOrder
Customer PurchasedOrderGroup
EventCalendar SalesDivision
FinalInspectionSecurityGroup SalesMarket
HierarchySecurityGroup Season
JasperReportTemplate ShapeSecurityGroup
Material Style
MaterialSecurityGroup Supplier
MerchFolder SupplierRequest
MerchPlan ThemeSecurityGroup

Reading Crew
Method:GET
URI Comments

./crews/{crew_id} Retrieves the Crew objects referenced by

./crews[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
SharedCrew which matches the
<filter_parameters> included in the
resource_path.
Retrieves the Crew objects which matches the
<filter_parameters> included in the
resource_path.

Updating Crew
Method:PUT
URI Comments

./crews/{crew_id} Updates the specified Crew

DOMAIN-ASSET RELATED APIs 204

 Centric 8 REST API DEVELOPER GUIDE

Deleting Crew
Method:DELETE
URI Comments

./crews/{crew_id} Deletes the specified Crew

Attribute List of Crew

Attribute Data Type Ref. Type Read Description

Write
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
assignments reflist CrewAssignment R/O
modified_by ref User R/O
parent_crew reflist Crew; R/W
SharedCrew
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 205

 Centric 8 REST API DEVELOPER GUIDE

CrewAssignment
Creating CrewAssignment
Method:POST
URI Comments

./crews/{crew_id}/assignments Creates a new CrewAssigment object as a child of

Crew.
./shared_crews/{shared_crew_id}/ Creates a new CrewAssigment object as a child of
assignments SharedCrew.

Reading CrewAssignment
Method:GET
URI Comments

./shared_crews/{shared_crew_id}/ Retrieves the CrewAssigment objects

assignments[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
./crews/{crew_id}/assignments
[?[skip=m][[&]limit=n]
referenced by SharedCrew which matches the
<filter_parameters> included in the
resource_path.
Retrieves the CrewAssigment objects
referenced by Crew which matches the
<filter_parameters>.

[& <filter_parameters>]..]
./crew_assignments/{crew_assignment_id} Retrieve the specified CrewAssignment object

./crew_assignments[?[skip=m][[&]limit=n] Retrieves the CrewAssigment objects which

[& <filter_parameters>]..] matches the <filter_parameters>.

Updating CrewAssignment
Method:PUT
URI Comments

./crew_assignments/{crew_assignment_id} Updates the specified CrewAssigment object.

Deleting CrewAssignment
Method:DELETE
URI Comments

./crew_assignments/{crew_assignment_id} Deletes the specified CrewAssignment object.

DOMAIN-ASSET RELATED APIs 206

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CrewAssignment

Attribute Data Type Ref. Type Read Write Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
assigned_users reflist User R/W
role ref Role R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 207

 Centric 8 REST API DEVELOPER GUIDE

Currency
Creating Currency
Method:POST
URI Comments

./currencies Creates a new currency object.

Reading Currency
Method:GET
URI Comments

./currencies/{currency_id} Retrieves the specified currency object.

./currencies[?[skip=m][[&]limit=n][& Retrieves the currency objects which matches the

<filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating Currency
Method:PUT

URI Comments

./currencies/{currency_id} Updates the specified currency object.

Deleting Currency
Method:DELETE
URI Comments

./currencies/{currency_id} Deletes the specified currency object.

DOMAIN-ASSET RELATED APIs 208

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Currency

Attribute Data Type Ref. Type Read Description

Write
id String CNL R/O Centric Node Locator.
_modified_at String Time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
modified_by String ref R/O
active Boolean boolean R/W
description String string R/W
symbol String string R/W
tags List<String> stringvector R/W
images Map<String, String> refmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 209


CurrencyExchangeRate
Creating CurrencyExchangeRate
Method:POST
URI
./currency_exchange_tables/{currency_exchange_
table_id}/currency_exchange_rates
Reading CurrencyExchangeRate
Method:GET
URI
./currency_exchange_tables/{currency_
exchange_table_id}/currency_exchange_
rates[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./currency_exchange_rates/{currency_e
xchange_rate_id}
./currency_exchange_rates[?[skip=m][[
&]limit=n][& <filter_parameters>]..]
Updating CurrencyExchangeRate
Method:PUT
URI
./currency_exchange_rates/
{currency_exchange_rate_id}
Deleting CurrencyExchangeRate
Method:DELETE
URI
./currency_exchange_rates/
{currency_exchange_rate_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new
CurrencyExchangeRate object as a
child of CurrentExchangeTable
Comments
Retrieve the CurrencyExchangeRate objects
referenced by CurrencyExchangeTable which
match filter parameters specified as query string
values.
Retrieve the specified CurrencyExchangeRate
object
Retrieves theCurrencyExchangeRateobjects which
matches the <filter_parameters> included in the
resource_path.
Comments
Updates the specified CurrencyExchangeRate
object.
Comments
Deletes the specifiedCurrencyExchangeRate object.
210
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CurrencyExchangeRate

Attribute Data Type Ref. Type Read/ Description

Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
rates Map<String, Double> doublemap R/W
target String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 211

 Centric 8 REST API DEVELOPER GUIDE

CurrencyExchangeTable
Creating CurrencyExchangeTable
Method:POST
URI Comments

./currency_exchange_tables Creates a new

CurrencyExchangeTable object

Reading CurrencyExchangeTable
Method:GET
URI Comments

./currency_exchange_tables/{currency_ Retrieve the specified CurrencyExchangeTable

exchange_table_id} object
./currency_exchange_tables[?[skip=m][ Retrieves the CurrencyExchangeTableobjects
[&]limit=n][& <filter_parameters>]..] which matches the <filter_parameters> included in
the resource_path.

Updating CurrencyExchangeTable
Method:PUT
URI Comments

./currency_exchange_tables/{currency Updates the specifiedCurrencyExchangeTable

_exchange_table_id} object.

Deleting CurrencyExchangeTable
Method:DELETE
URI Comments

./currency_exchange_tables/{currency Deletes the specified CurrencyExchangeTable

_exchange_table_id} object.

DOMAIN-ASSET RELATED APIs 212

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CurrencyExchangeTable

Attribute Data Type Ref. Type Read/ Description

Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
modified_by String ref R/O
to Map<String, String> refmap R/O
active Boolean boolean R/W
description String string R/W
tags List<String> stringvector R/W
from List<String> reflist R/W
images Map<String, String> refmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 213

 Centric 8 REST API DEVELOPER GUIDE

Customer
Creating Customer
Method:POST
URI Comments

./customers Creates a new Customer object.

Reading Customer
Method:GET
URI Comments

./customers/{customer_id} Retrieves the specified Customer object.

./customers[?[skip=m][[&]limit=n][[ Retrieves the Customer objects which match the

&<filter_parameters>]..] <filter_parameters>

Updating Customer
Method:PUT
URI Comments

./customers/{customer_id} Updates the specified Customer object.

Deleting Customer
Method:DELETE
URI Comments

./customers/{customer_id} Deletes the specified Customer object.

DOMAIN-ASSET RELATED APIs 214

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Customer

Attribute Data Type Ref. Type Read/Write Description

id CNL R/O Centric Node
Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
address string R/W
address1 string R/W
address2 string R/W
city string R/W
company string R/W
customer_number string R/W
discount_pct double R/W
email string R/W
fax string R/W
job_title string R/W
language string R/W
localized_address string R/W
mobile string R/W
payment_term string R/W
payment_terms string R/W
phone_number string R/W
postal_code string R/W
purpose string R/W
state enum R/W
supplier_number string R/W
trade_term enum R/W
vat_code string R/W
website string R/W
country ref Country R/W
province_state ref ProvinceState R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL
Lookup map.

DOMAIN-ASSET RELATED APIs 215

 Centric 8 REST API DEVELOPER GUIDE

CustomerOrder
Creating CustomerOrder
Method:POST
URI Comments

./customer_purchase_orders/{ Create a new CustomerOrder object as a child of

customer_purchase_order_id}/ CustomerPurchaseOrder.
orders

Reading CustomerOrder
Method:GET
URI Comments

./customer_purchase_orders/{customer_ Retrieve the CustomerOrder objects referenced

purchase_order_id}/orders[?[skip=m][[ by CustomerPurchaseOrder which match filter
&]limit=n][& <filter_parameters>]..]
parameters specified as query string values.
./customer_orders/{customer_order_id} Retrieves the specified CustomerOrder object.

./customer_orders Retrieves the CustomerOrder objects which

[?[skip=m][[&]limit=n][& matches the <filter_parameters> included in the
<filter_parameters>]..] resource_path.

Updating CustomerOrder
Method:PUT
URI Comments

./customer_orders/{customer_order_id} Updates the specified CustomerOrder object.

Deleting CustomerOrder
Method:DELETE
URI Comments

./customer_orders/{customer_order_id} Deletes the specified CustomerOrder object.

DOMAIN-ASSET RELATED APIs 216

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CustomerOrder

Attribute Data Type Ref. Type Read/Write Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
extension Double double R/O
modified_by String ref R/O
po String ref R/O
po_color String ref R/O
po_product String ref R/O
adjusted_price Double double R/W
allowance_pct Double double R/W
allowance_value Double double R/W
base_price Double double R/W
description String string R/W
discount_pct Double double R/W
discount_value Double double R/W
quantity Double double R/W
quantity_per_size List<Double> doublevector R/W
unit_per_pack Integer integer R/W
realized_product String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 217

 Centric 8 REST API DEVELOPER GUIDE

CustomerPurchaseOrder
Creating CustomerPurchaseOrder
Method:POST
URI Comments

./customer_purchase_orders Create a new CustomerPurchaseOrder object

Reading CustomerPurchaseOrder
Method:GET
URI Comments

./customer_purchase_orders/ Retrieves the specified CustomerPurchaseOrder object.

{customer_purchase_order_id}
./customer_purchase_orders Retrieves the CustomerPurchaseOrder objects which
[?[skip=m][[&]limit=n][& matches the <filter_parameters> included in the
<filter_parameters>]..] resource_path.

Updating CustomerPurchaseOrder
Method:PUT
URI Comments

./customer_purchase_orders/ Updates the specified CustomerPurchaseOrder object.

{customer_purchase_order_id}

Deleting CustomerPurchaseOrder
Method:DELETE
URI Comments

./customer_purchase_orders/ Deletes the specified CustomerPurchaseOrder object.

{customer_purchase_order_id}

DOMAIN-ASSET RELATED APIs 218

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of CustomerPurchaseOrder

Attribute Data Type Ref. Type Read/Write Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
issue_time time R/O
po_subtype enum R/O
state_change_time time R/O
total_commission double R/O
total_units_ordered double R/O
total_value double R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
cnt_documents integer R/O
commission_percentage double R/W
confirmed_date time R/W
control_number string R/W
order_date time R/W
orders_by_color boolean C/O
po_comments string R/W
payment_term string R/W
remarks string R/W
state enum R/W Use special state 'Reissue' in
a PUT request to request re-
issue of the
CustomerPurchaseOrder.
The CustomerPurchaseOrder
remains in the 'Issued' state
after this special request.
target_date time R/W
trade_term enum R/W
orders refvector OrderTable R/W
Spanner;
CustomerO
rder
po_customer ref Customer C/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 219

 Centric 8 REST API DEVELOPER GUIDE

DataPackage
Creating DataPackage
Method:POST
URI Comments

./materials/{material_id}/packages Creates a new DataPackage object as a child of

Material.
./styles/{style_id}/packages Creates a new DataPackage object as a child of Style.

Reading DataPackage
Method:GET
URI Comments

./materials/{material_id}/packages[?[skip=m Retrieves the DataPackage objects

][[&]limit=n][& <filter_parameters>]..]
./styles/{style_id}/packages[?[skip=m][[&]l
imit=n][& <filter_parameters>]..]
./data_packages/{data_package_id }
referenced by Material which match the
<filter_parameters>
Retrieves the DataPackage objects
referenced by Style which match the
<filter_parameters>
Retrieves the specified DataPackage
objects

./data_packages[?[skip=m][[&]limit=n][& Retrieves the specified DataPackage

<filter_parameters>]..] objects which match the filter parameters

Updating DataPackage
Method:PUT
URI Comments

./data_packages/{data_package_id } Updates the specified DataPackage object.

Deleting DataPackage
Method:DELETE
URI Comments

./data_packages/{data_package_id } Deletes the specified DataPackage object.

DOMAIN-ASSET RELATED APIs 220

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DataPackage

Attribute Data Type Ref. Type Read/Write Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
use_theme Boolean boolean R/O
data_sheets List<String> refvector R/O
modified_by String ref R/O
template String ref R/O
theme_view String ref R/O
description String string R/W
due_date String time R/W
final_inspection_ Boolean boolean R/W This attribute requires
relevant module: AQL to be installed.
Otherwise, it is ignored.
pdf String url R/W
use_cover_sheet Boolean boolean R/W
cover_sheet_view String ref R/W
_url_base_template String string R/O File (image, pdf, document) retrieval
URL template.
for_product_source ref ProductSo R/W
urce
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 221

 Centric 8 REST API DEVELOPER GUIDE

DataPackageTemplate
Creating DataPackageTemplate
Method:POST
URI Comments

./data_package_templates Creates a new DataPackageTemplate object

Reading DataPackageTemplate
Method:GET
URI Comments

./data_package_templates/{data_package_temp Retrieves the specified

late_id}
./data_package_templates[?[skip=m][[&]limit
=n][& <filter_parameters>]..]
DataPackageTemplate object.
Retrieves the DataPackageTemplate
objects which match the
<filter_parameters> included in the
resource_path.

Updating DataPackageTemplate
Method:PUT
URI Comments

./data_package_templates/{data_package_tem Updates the specified

plate_id} DataPackageTemplate object.

Deleting DataPackageTemplate
Method:DELETE
URI Comments

./data_package_templates/{data_package_temp Deletes the specified

late_id} DataPackageTemplate object.

DOMAIN-ASSET RELATED APIs 222

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DataPackageTemplate

Attribute Data Ref. Type Read/ Description

Type Write
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
material_document_qu ref QueryFilter_Bool R/O
ery_filter eanExpression
is_supplier_specific boolean R/O
active boolean R/W
description string R/W
template_type enum C/O
use_cover_sheet boolean R/W
use_theme boolean R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 223

 Centric 8 REST API DEVELOPER GUIDE

DataPackageTemplateSheet
Creating DataPackageTemplateSheet
Method:POST
URI Comments

./data_package_templates/ Creates a new DataPackageTemplateSheet object as a child of

DataPackageTemplate.
{data_package_template_id}/

data_sheets

Reading DataPackageTemplateSheet
Method:GET
URI Comments

./data_package_templates/ Retrieves the DataPackageTemplateSheet objects

referenced by DataPackageTemplate which match the
{data_package_template_id}/ <filter_parameters>.

data_sheets[?[skip=m][[&]limit=n]

[& <filter_parameters>]..]
./data_package_template_sheets/ Retrieves the specified
DataPackageTemplateSheetobject.
{data_package_template_sheet_id}
./data_package_template_sheets Retrieves the DataPackageTemplateSheet objects
which match the <filter_parameters>.
[?[skip=m][[&]limit=n]

[& <filter_parameters>]..]

Updating DataPackageTemplateSheet
Method:PUT
URI Comments

./data_package_template_sheets/ Updates the specified

DataPackageTemplateSheet object.
{data_package_template_sheet_id}

Deleting DataPackageTemplateSheet
Method:DELETE
URI Comments

./data_package_template_sheets/ Deletes the specified

DataPackageTemplateSheet object.
{data_package_template_sheet_id}

DOMAIN-ASSET RELATED APIs 224

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DataPackageTemplateSheet

Attribute Data Type Ref. Type Read Description

/Writ
e
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
include_documents boolean R/O
include_sub_routi boolean R/O
ngs
include_sub_sheet boolean R/O
s
is_supplier_speci boolean R/O
fic
bom_document_quer ref QueryFilter_BooleanExpre R/O
y_filter ssion
data_sheet_query_ ref QueryFilter_BooleanExpre R/O
filter ssion
modified_by ref User R/O
sub_routing_view ref _CS_PreferenceView R/O
sub_sheet_view ref _CS_PreferenceView R/O
latest_only boolean R/W
optional boolean R/W
state enum R/W
sub_type enum R/W
type enum R/W
phase ref _CS_Phase R/W
subtype ref DataSheetSizeLabelSubty R/W
pe; MaterialBOMSubtype;
MaterialDataSheetSubtype
; RoutingSubtype;
ApparelBOMSubtype;
ArtworkSubtype;
PropertiesDataSheetSubty
pe; SizeChartSubtype;
ImageDataSheetSubtype;
TestRunSubtype;
ReviewStyleSubtype
view ref _CS_PreferenceView R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 225


DataSheetPage
Creating DataSheetPage
Method:POST
URI
./themes/{theme_id}/pages
./canvas_templates/{canvas_template_id}
/pages
./marketing_collections/{marketing_col
lection_id}/pages
Reading DataSheetPage
Method:GET
URI
./themes/{theme_id}/pages[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./canvas_templates/{canvas_template_i
d}/pages[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./marketing_collections/{marketing_co
llection_id}/pages[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./data_sheet_pages/
{data_sheet_page_id}
./data_sheet_pages/[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new DataSheetPage object as a child
of Theme.
Creates a new DataSheetPage object as a child
of CanvasTemplate.
Creates a new DataSheetPage object as a child
of MarketingCollection.
Comments
Retrieves the DataSheetPage objects referenced
by Theme which match the <filter_parameters>.
Retrieves the DataSheetPage objects referenced
by CanvasTemplate which match the
<filter_parameters>.
Retrieves the DataSheetPage objects referenced
by MarketingCollection which match the
<filter_parameters>.
Retrieves the specified DataSheetPage object.
Retrieves the DataSheetPage objects which
match the <filter_parameters>.
226
 Centric 8 REST API DEVELOPER GUIDE

Updating DataSheetPage
Method:PUT
URI Comments

./data_sheet_pages/{data_sheet_page_id} Updates the specified DataSheetPage

object.

Deleting DataSheetPage
Method:DELETE
URI Comments

./data_sheet_pages/{data_sheet_page_id} Deletes the specified DataSheetPage

object.

Attribute List of DataSheetPage

Attribute Data Type Ref. Type Read/Write Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
scale float R/O
snapshot_shared boolean R/O
split_pct float R/O
thumbnail_generated boolean R/O
modified_by ref User R/O
snapshot_request ref PDFRequest R/O
comments refvector Comment R/W
snapshot ref Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 227

 Centric 8 REST API DEVELOPER GUIDE

DataSheetSizeLabel
Creating DataSheetSizeLabel
Method:POST
URI Comments

./styles/{style_id}/data_sheets Creates a new DataSheetSizeLabel object as a child of

/data_sheet_size_labels Style.

Reading DataSheetSizeLabel
Method:GET
URI Comments

./styles/{style_id}/data_sheets/ Retrieves the DataSheetSizeLabel objects

referenced by Style which match the
data_sheet_size_labels[?[skip=m] <filter_parameters>.

[[&]limit=n][&<filter_parameters>]..]
./data_sheet_size_labels/ Retrieves the specified DataSheetSizeLabel
object.
{data_sheet_size_label_id}

./data_sheet_size_labels/[?[skip=m] Retrieves the DataSheetSizeLabel objects which

match the <filter_parameters>.
[[&]limit=n][&<filter_parameters>]..]

Updating DataSheetSizeLabel
Method:PUT
URI Comments

./data_sheet_size_labels/ Updates the specified DataSheetSizeLabel

object.
{data_sheet_size_label_id}

Deleting DataSheetSizeLabel
Method:DELETE
URI Comments

./data_sheet_size_labels/ Deletes the specified DataSheetSizeLabel

object.
{data_sheet_size_label_id}

DOMAIN-ASSET RELATED APIs 228

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DataSheetSizeLabel

Attribute Data Type Ref. Type Read/Write Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref DataSheet R/O
SizeLabel
Revision
latest_revision ref DataSheet R/O
SizeLabel
Revision
modified_by ref User R/O
revisions refvector DataSheet R/O
SizeLabel
Revision
can_track_by_calen boolean R/W
dar
description string R/W
for_product_source ref ProductSo R/W
urce
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 229

 Centric 8 REST API DEVELOPER GUIDE

DataSheetSizeLabelRevision
Creating DataSheetSizeLabelRevision
Method:POST
URI Comments

./data_sheet_size_label_revisions/ Creates a revision for the specified

DataSheetSizeLabelRevision object.
{data_sheet_size_label_revision_id}/
revise

Reading DataSheetSizeLabelRevision
Method:GET
URI Comments

./data_sheet_size_label_revisions/ Retrieves the specified

DataSheetSizeLabelRevision object.
{data_sheet_size_label_revision_id}

./data_sheet_size_label_revisions/ Retrieves the DataSheetSizeLabelRevision

objects which match the <filter_parameters>.
[?[skip=m][[&]limit=n][&<filter_param
eters>]..]

Updating DataSheetSizeLabelRevision
Method:PUT
URI Comments

./data_sheet_size_label_revisions/ Updates the specified

{data_sheet_size_label_revision_id}
./data_sheet_size_label_revisions/
{data_sheet_size_label_revision_id}
?action={action_name}
DataSheetSizeLabelRevisionobject.
Update the specified DataSheetSizeLabelRevision
object and changes the revision state based on the
actions enum list: APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

DataSheetSizeLabelRevision does not support DELETE

method.

DOMAIN-ASSET RELATED APIs 230

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DataSheetSizeLabelRevision

Attribute Data Ref. Type Read/Write Description

Type
id CNL R/O Centric Node
Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref DataSheet R/O
SizeLabel
Revision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
size_label ref SizeLabel R/W
sizes reflist SizeLabel R/W
Size
_url_base_template string R/O File (image, pdf,
document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL
Lookup map.

DOMAIN-ASSET RELATED APIs 231

 Centric 8 REST API DEVELOPER GUIDE

Defect
Creating Defect
Method:POST
URI Comments

./defects Creates a new Defect object

Reading Defect
Method:GET
URI Comments

./defects/{defect_id } Retrieves the specified Defect object.

./defects[?[skip=m][[&]limit=n][& Retrieves the Defect objects which match the

<filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating Defect
Method:PUT
URI Comments

./defects/{defect_id } Updates the specified Defect object.

Deleting Defect
Method:DELETE
URI Comments

./defects/{defect_id } Deletes the specified Defect object.

DOMAIN-ASSET RELATED APIs 232

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Defect

Attribute Data Type Ref. Type Read/Write Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
active Boolean boolean R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
code String string R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
defect_category String enum R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
description Map<String, stringmap R/W This attribute requires
String> module: AQL to be installed.
Otherwise, it is ignored.
localized_name Map<String, stringmap R/W
String>
images Map<String, refmap R/W
String>
tags Map<String, refmap R/W This attribute requires
String> module: AQL to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 233

 Centric 8 REST API DEVELOPER GUIDE

Document
Creating Document and uploading file/s
Method:POST
URI Comments

./documents Create a new Document object.

./documents/parent/{parent_id} Creates document from the specified parent_id of

the Centric object which owns the document.
Following is the list of valid DocsAndComments
enabled objects:
• ColorMaterial
• ColorSpecification
• Customer
• CustomerPurchaseOrder
• Factory
• FinalInspectionBatch
• MCMaterial
• MCProduct
• MarketingCollection
• Material
• MaterialSample
• MarketingTool
• PurchasedOrder
• QuestionRevision
• SalesDivision
• Sample
• Shape
• ShippingPort
• ShipmentTerm
• SKU
• SRLineItem
• Style
• Supplier
• SupplierItem
• Test
• TestSpecRevision
• TestRunRevision
• Theme

./documents/parent/{parent_id}/ Creates a new Document for the specified parent

upload object, creates a Document Revision object for
that document and then uploads the file/files from
local file system as defined in a multipart form
payload. Click here to see a program example of
the proper usage for Upload and Download of
files.
Note:
• When a user wants to upload a 3D
document, the query parameter to
change “is_3d=true”.

DOMAIN-ASSET RELATED APIs 234

 Centric 8 REST API DEVELOPER GUIDE

• When a user wants to upload a 3D

material, the query parameter to change
“is_3d_material=true”.

Reading Document
Method:GET
URI Comments

./documents/{document_id} Retrieve the specified Document object.

./documents[?[skip=m][[&]limit=n][&...]] Retrieve the Document objects which match

<filter parameters> specified as query string
values.

./documents/parent/{parent_id} Gets a list of documents from the document

container id (parent_id).
Following is the list of valid
DocsAndComments enabled objects:

• ColorMaterial
• ColorSpecification
• FinalInspectionBatch
• MCMaterial
• MarketingCollection
• Material
• MarketingTool
• Shape
• ShipmentTerm
• SRLineItem
• Style
• Supplier
• SupplierItem
• TestSpecRevision
• TestRunRevision
• Theme

User can filter the results based on:

• Revision Details(True/False):
o True gives all revision id(s) of the
document and details of all
revision(s).
o False gives only the latest
revision id.
• File Extension(file_ext): Users can
further down the results based on
the file extension were response.
User can add multiple file extension
types.

DOMAIN-ASSET RELATED APIs 235

 Centric 8 REST API DEVELOPER GUIDE

Updating Document
Method:PUT
URI Comments

./documents/{document_id } Updates the specified Document object.

Deleting Document
Method:DELETE
URI Comments

./documents/{document_id } Deletes the specified Document object.

Attribute List of Document

Attribute Data Type Ref. Type Read/Write Description
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref Document R/O
Revision
latest_revision ref Document R/O
Revision
modified_by ref User R/O
revisions refvector Document R/O
Revision
display_doc_on_mo boolean R/W This attribute requires
bile_app module: Operations to be installed.
Otherwise, it is ignored.
document_type enum R/W
locales reflist Locale R/W
is_3d boolean C/O
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

is_3d is a create only attribute. It determines if the attached DocumentRevision contains a 3D Document. The
Centric 3D document has regular zip file extension and contains at least one 3D model and optional 3D material
and image files. If the “is_3d” flag is true, Centric UI launches 3D visualization widget to visualize the 3D
interactively. If the flag is false, the attached Document is treated as a regular Zip file.

DOMAIN-ASSET RELATED APIs 236

 Centric 8 REST API DEVELOPER GUIDE

DocumentRevision
Creating DocumentRevision
Method:POST
URI Comments

./document_revisions/{document_revision_id} Creates a new revision of the specified

/revise DocumentRevision object.

Reading DocumentRevision
Method:GET
URI Comments

./document_revisions/{document_revision_id} Retrieves the specified DocumentRevision

object.
./document_revisions[?[skip=m][[&]limit=n][ Retrieves the DocumentRevision objects
[& <filter_parameters>]..] which match the <filter_parameters>

Updating DocumentRevision and uploading document to filevault

Method:PUT
URI Comments

./document_revisions/{document_revision_id} Updates the specified DocumentRevision

object.
./document_revisions/{document_revision_id} Update the specified DocumentRevisionobject
?action={action_name} and changes the revision state based on the
actions enum list: APPROVED, REVERT,
PURGEREVISION, PURGERESETREVISION
./document_revisions/ Uploads a document to the specific document
{document_revision_id}/upload revision object. See “Example: Uploading
Document Using Postman” for more details.

Method: DELETE unsupported

DocumentRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 237

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DocumentRevision

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
alternate_files urlmap R/O
approval_time time R/O
clarification_number integer R/O
file_name string R/O
is_current boolean R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
modified_by ref User R/O
processing_request reflist Document R/O
Processin
gRequest
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
file url R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 238

 Centric 8 REST API DEVELOPER GUIDE

Example: Uploading Document Using Postman

Program Example: Uploading normal and 3D Document

Click here to see Java program examples showing how to upload normal and 3D documents to
filevault by using DocumentRevision endpoint.

Program Example: Downloading Regular and 3D Document

There is no endpoint to download as the Centric base URL for the file is used to download the
Document Revision file.

DOMAIN-ASSET RELATED APIs 239

 Centric 8 REST API DEVELOPER GUIDE

DSLineDivider
Reading DSLineDivider
Method:GET
URI Comments

./ds_line_dividers/{ds_line_divider_id} Retrieves the specified DSLineDivider object.

./compositions[?[skip=m][[&]limit=n][& Retrieves the DSLineDivider objects which

<filter_parameters>]..] matches the <filter_parameters> included in the
resource_path.

Updating DSLineDivider
Method:PUT
URI Comments

./ds_line_dividers/{ds_line_divider_id} Updates the specified DSLineDivider

object.

Deleting DSLineDivider
Method:DELETE
URI Comments

./ds_line_dividers/{ds_line_divider_id} Deletes the specified DSLineDivider object.

Method: POST is unsupported

DSLineDivider does not support POST method. This object is

deprecated from Centric version 6.2 and is replaced by
BOMSectionDefinition. The 6.2 Migration script will convert all
DSLineDivider in BOM to BOMSectionDefinition object.

DOMAIN-ASSET RELATED APIs 240

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DSLineDivider

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
shape_sys_id String string R/O
sys_id String string R/O
modified_by String ref R/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 241

 Centric 8 REST API DEVELOPER GUIDE

DutyRate
Creating DutyRate
Method:POST
URI Comments

./duty_rates Creates a new DutyRate object

Reading DutyRate
Method:GET
URI Comments

./duty_rates/{duty_rate_id} Retrieves the specified DutyRate object.

./duty_rates[?[skip=m][[&]limit=n][& Retrieves the DutyRate objects which matches

<filter_parameters>]..] the <filter_parameters> included in the
resource_path.

Updating DutyRate
Method:PUT

URI Comments

./duty_rates/{duty_rate_id} Updates the specified DutyRate object.

Deleting DutyRate
Method:DELETE
URI Comments

./duty_rates/{duty_rate_id} Deletes the specified DutyRate object.

DOMAIN-ASSET RELATED APIs 242

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DutyRate

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
duty_material enum R/W
duty_pct double R/W
country_from ref Country R/W
country_to ref Country R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 243

 Centric 8 REST API DEVELOPER GUIDE

DutyRateUsage
Creating DutyRateUsage
Method:POST
URI Comments

./supplier_item_revisions/ Creates a new DutyRateUsage object as a

child of SupplierItemRevision.
{supplier_item_revision_id}/duty_rates

Reading DutyRateUsage
Method:GET
URI Comments

./duty_rate_usages/{duty_rate_usage_id} Retrieves the specified DutyRateUsage object.

./duty_rate_usages[?[skip=m][[&]limit=n Retrieves the DutyRateUsage objects which

] matches the <filter_parameters> included in
the resource_path.
[& <filter_parameters>]..]
./supplier_item_revisions/ Retrieves the DutyRateUsage objects
referenced by SupplierItemRevision which
{supplier_item_revision_id}/ matches the <filter_parameters> included in
the resource_path.
duty_rates[?[skip=m][[&]limit=n]

[& <filter_parameters>]..]

Updating DutyRateUsage
Method:PUT

URI Comments

./duty_rate_usages/{duty_rate_usage_id} Updates the specified DutyRateUsage

object.

Deleting DutyRateUsage
Method:DELETE
URI Comments

./duty_rate_usages/{duty_rate_usage_id} Deletes the specified DutyRateUsage

object.

DOMAIN-ASSET RELATED APIs 244

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of DutyRateUsage

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
duty_pct_blended double R/O
modified_by ref User R/O
comment string R/W
duty_pct double R/W
percentage double R/W
duty_rate ref DutyRate R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 245

 Centric 8 REST API DEVELOPER GUIDE

EngineeringChange
Creating EngineeringChange
Method:POST
URI Relative Path Comments

./engineering_changes Creates a new EngineeringChange object.

Reading EngineeringChange
Method:GET
URI Relative Path Comments

./engineering_changes/{engineering Retrieves the specified EngineeringChange object.

_change_id}
./engineering_changes[?[skip=m][[& Retrieves the EngineeringChange objects which match
]limit=n][&...]] <filter parameters> specified as query string values.

Updating EngineeringChange
Method:PUT
URI Relative Path Comments

./engineering_changes/{engineering_change_ Updates the specified EngineeringChange

id} object.

Deleting EngineeringChange
Method:DELETE
URI Relative Path Comments

./engineering_changes/{engineering_change_ Deletes the specified EngineeringChange

id} object.

DOMAIN-ASSET RELATED APIs 246

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
max_impact_levels integer R/O This attribute requires
_to_retrieve module: EngineeringChange to be
installed. Otherwise, it is ignored.
state enum R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
state_change_time time R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
affected_items refset AffectedIte R/O This attribute requires
m module: EngineeringChange to be
installed. Otherwise, it is ignored.
comments reflist Comment R/O
crew ref Crew R/O
crew_type ref CrewType R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
documents reflist Document R/O
modified_by ref User R/O This attribute requires
module: WBS2Apparel to be
installed. Otherwise, it is ignored.
recent_child_comm refvector Comment R/O
ents
recent_comments refvector Comment R/O
state_change_user ref User R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
additional_impact integer R/W This attribute requires
_levels_to_retrie module: EngineeringChange to be
ve installed. Otherwise, it is ignored.
**allowed_revisio enum R/W This attribute requires
n_state module: EngineeringChange to be
installed. Otherwise, it is ignored.
default_impact_le integer R/W This attribute requires
vels_to_retrieve module: EngineeringChange to be
installed. Otherwise, it is ignored.
description string R/W This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
effective_end time R/W This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
effective_start time R/W This attribute requires

DOMAIN-ASSET RELATED APIs 247

 Centric 8 REST API DEVELOPER GUIDE

module: EngineeringChange to be
installed. Otherwise, it is ignored.
issue_severity enum R/W This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
issue_type enum R/W This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
images refmap Image R/W
referenced_docume reflist Document R/W
nts
wbs ref Wbs R/W This attribute requires
module: WBS to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The (**) bold purple attribute is required when creating a new EngineeringChange object.

DOMAIN-ASSET RELATED APIs 248

 Centric 8 REST API DEVELOPER GUIDE

EnumList
Creating EnumList
Method:POST
URI Comments

./enum_lists Creates a new EnumList object.

Reading EnumList
Method:GET
URI Comments

./enum_lists/{enum_list_id } Retrieves the specified EnumList object.

./enum_lists[?[skip=m][[&]limit=n] Retrieves the EnumList objects which match the

[&<filter_parameters>]..] <filter_parameters> included in the resource_path.

./localization/enum_lists/ Retrieves all the attributes plus the localized name of the
{enum_list_id}/{locale} specified EnumList object for the specified locale. See the
Payload attribute “display_name” for details.

Updating EnumList
Method:PUT
URI Comments

./enum_lists/{enum_list_id } Updates the specified EnumList object.

Deleting EnumList
Method:DELETE
URI Comments

./enum_lists/{enum_list_id } Deletes the specified EnumList object. Please note, you cannot
delete any pre-defined EnumList using this endpoint.

DOMAIN-ASSET RELATED APIs 249

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of EnumList

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was modified.
node_name string C/O Display name for the object.
custom boolean R/O
modified_by ref User R/O
description string R/W
depends_on ref EnumList R/W
values refvector EnumValue R/W
display_names refmap See the bold purple entry for the
details.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue represents attribute which can be set only when the object is created.
• The bold purple is an additional attribute returned in the payload when the localization endpoint is used to query the EnumList
for localized details.

DOMAIN-ASSET RELATED APIs 250

 Centric 8 REST API DEVELOPER GUIDE

EnumValue
Creating EnumValue
Method:POST
URI Comments

./enum_lists/{enum_list_id}/values Creates a new EnumValue object.

Reading EnumValue
Method:GET
URI Comments

./enum_lists/{enum_list_id}/values[? Retrieves the EnumValues subordinate to the particular

[skip=m][[&]limit=n][&<filter_parame
ters>]..]
./enum_values/{enum_value_id}
./enum_values/{enum_value_id}/values
[?[skip=m][[&]limit=n][&<filter_para
meters>]..]
./enum_values[?[skip=m][[&]limit=n][
&<filter_parameters>]..]
EnumList id and which match the <filter_parameters>
included in the resource_path.
Retrieves the specified EnumValue object.
Retrieves the EnumValue objects referenced by
EnumValue which match the <filter_parameters>
included in the resource_path.
Retrieves the EnumValue objects which match the
<filter_parameters> included in the resource_path.

Updating EnumValue
Method:PUT
URI Comments

./enum_values/{enum_value_id} Updates the specified EnumValue object.

Deleting EnumValue
Method:DELETE
URI Comments

./enum_values/{enum_value_id} Deletes the specified EnumValue object.

Please note, you cannot delete any pre-defined
EnumList using this endpoint.

DOMAIN-ASSET RELATED APIs 251

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of EnumValue

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string C/O Display name for the object.
modified_by String ref R/O
custom_id String string R/W
description String string R/W
depends_on List<String> reflist R/W
active Boolean boolean R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue represents create only attribute which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 252

 Centric 8 REST API DEVELOPER GUIDE

Factory
Creating Factory
Method:POST
URI Comments

./factories Creates a new Factory object.

Reading Factory
Method:GET
URI Comments

./factories/{factory_id} Retrieves the specified Factory object.

./factories[?[skip=m][[&]limit=n][& Retrieves the Factory objects which match the

<filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating Factory
Method:PUT
URI Comments

./factories/{factory_id} Updates the specified Factory object.

Deleting Factory
Method:DELETE
URI Comments

./factories/{factory_id} Deletes the specified Factory object.

DOMAIN-ASSET RELATED APIs 253

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Factory

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
compliant boolean R/O
comments reflist Comment R/O
contacts refvector Contact R/O
documents reflist Document R/O
modified_by ref User R/O
operations_reviews reflist FactoryReview R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
suppliers reflist Supplier R/O
cnt_documents integer R/O
address string R/W
address_1 string R/W
address_2 string R/W
city string R/W
commission_pct double R/W
company string R/W
email string R/W
fax string R/W
fixed_oh_rate double R/W
job_title string R/W
labor_rate double R/W
language string R/W
lead_time string R/W
localized_address string R/W
moq_initial integer R/W
moq_reorder integer R/W
material_burden_pct double R/W
min_order_amt double R/W
min_order_surcharge double R/W
mobile string R/W
payment_term string R/W
payment_terms string R/W
phone_number string R/W
photocopy_number string R/W
postal_code string R/W
purpose string R/W
raw_material_freight_pct double R/W
state enum R/W
supplier_number string R/W
trade_term enum R/W
variable_oh_rate double R/W
volume_capacity integer R/W
website string R/W
country ref Country R/W
images refmap Image R/W
port_of_origin ref ShippingPort R/W
province_state ref ProvinceState R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 254


FactoryReview
Creating FactoryReview
Method:POST
URI
./factories/{factory_id}/operations_reviews
Reading FactoryReview
Method:GET
URI
./factories/{factory_id}/operations_
reviews
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./factory_reviews/{factory_review_id}
./factory_reviews[?[skip=m][[&]
limit=n][& <filter_parameters>]..]
Updating FactoryReview
Method:PUT
URI
./factory_reviews/{factory_review_id}
Deleting FactoryReview
Method:DELETE
URI
./factory_reviews/{factory_review_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new FactoryReview object as a
child of Factory.
Comments
Retrieves the FactoryReview object referenced by
Factory which matches the <filter_parameters>
included in the resource_path
Retrieves the specified FactoryReview objects
Retrieves the FactoryReview object which match
the <filter_parameters> included in the
resource_path
Comments
Updates the specified FactoryReview object.
Comments
Deletes the specified FactoryReview object.
255
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FactoryReview

Attribute Data Ref. Read Description

Type Type Only
id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
num_flagged integer R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
num_questions integer R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
num_responded integer R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
pdf url R/O
points_possible double R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
points_scored double R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
score double R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
state enum R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
state_change_time time R/O This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
fiscal_year string R/W This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
notes string R/W This attribute requires module: Operations to be
installed. Otherwise, it is ignored.
owner_contact string R/W This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
quarter integer R/W This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
review_date time R/W This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
or_template_revision ref FactoryRevi C/O This attribute requires module: Operations to be
ewTemplat installed. Otherwise, it is ignored.
eRevision
review_event ref FactoryRevi C/O This attribute requires module: Quality to be installed.
ewEvent; Otherwise, it is ignored.
SupplierRe
viewEvent
reviewer ref User R/W This attribute requires module: Quality to be installed.
Otherwise, it is ignored.
_url_base_template string R/O File (image, pdf, document) retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 256

 Centric 8 REST API DEVELOPER GUIDE

FactoryReviewTemplate
Creating FactoryReviewTemplate
Method:POST
URI Comments

./factory_review_templates Creates a new FactoryReviewTemplate object

Reading FactoryReviewTemplate
Method:GET
URI Comments

./factory_review_templates/ Retrieves the specified FactoryReviewTemplate

{factory_review_template_id}
./factory_review_templates[?[skip=m]
[[&]limit=n][&
<filter_parameters>]..]
objects
Retrieves the FactoryReviewTemplate object which
match the <filter_parameters> included in the
resource_path

Updating FactoryReviewTemplate
Method:PUT
URI Comments

./factory_review_templates/ Updates the specified FactoryReviewTemplate

object.
{factory_review_template_id}

Deleting FactoryReviewTemplate
Method:DELETE
URI Comments

./factory_review_templates/ Deletes the specified FactoryReviewTemplate

object.
{factory_review_template_id}

DOMAIN-ASSET RELATED APIs 257

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FactoryReviewTemplate

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
latest_revision String ref R/O
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
revisions List<String> refvector R/O
active Boolean boolean R/W This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
is_mainline_review Boolean boolean R/W This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 258

 Centric 8 REST API DEVELOPER GUIDE

FactoryReviewTemplateRevision
Creating FactoryReviewTemplateRevision
Method:POST
URI Comments

./factory_review_template_revisions Creates a new FactoryReviewTemplateRevision for

/ the specified FactoryRetiewTemplateRevision object

{factory_review_template_revisions_
id}/revise

Reading FactoryReviewTemplateRevision
Method:GET
URI Comments

./factory_review_template_revisions/ Retrieves the specified

{factory_review_template_revision_id}
./factory_review_template_revisions
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
FactoryReviewTemplateRevision objects
Retrieves the FactoryReviewTemplateRevision
object/s which match the <filter_parameters>
included in the resource_path

Updating FactoryReviewTemplateRevision
Method:PUT
URI Comments

./factory_review_template_revisions Updates the specified FactoryReviewTemplate

/{factory_review_template_revision_id}
./factory_review_template_revisions
/{factory_review_template_revision_id}
?action={action_name}
object.
Update the specified
FactoryReviewTemplateRevision object and
changes the revision state based on the actions
enum list: APPROVED, REVERT, CLOSED,
FREEZE

Method: DELETE unsupported

FactoryReviewTemplateRevision does not support DELETE

method.

DOMAIN-ASSET RELATED APIs 259

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FactoryReviewTemplateRevision

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_numb Integer integer R/O
er
is_current Boolean boolean R/O
is_latest Boolean boolean R/O This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
pending_2_time String time R/O
pending_time String time R/O
points_possible Double double R/O This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
pending_2_user String ref R/O
pending_user String ref R/O
revert_user String ref R/O
review_user String ref R/O
description String string R/W This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
revision_comment String string R/W
images Map<String, refmap R/W
String>
sections List<String> refvector R/W This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
template_questions List<String> reflist R/W This attribute requires module: Operations to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 260

 Centric 8 REST API DEVELOPER GUIDE

FinalInspection
Creating FinalInspection
Method:POST
URI Comments

./final_inspections Creates a new FinalInspection object

Reading FinalInspection
Method:GET
URI Comments

./final_inspections/ Retrieves the specified FinalInspection object

{final_inspection_id}
./final_inspections[?[skip=m][[&] Retrieves the FinalInspection objects which
match the filter parameters.
limit=n][&<filter_parameters>]..]

Updating FinalInspection
Method:PUT
URI Comments

./final_inspections/{final_inspection_id} Updates the specified FinalInspection

object and changes its state as per action
?action={action_name} parameter value. The valid values are:
START, PASS, FAIL

Deleting FinalInspection
Method:DELETE
URI Comments

./final_inspections/{final_inspection_id} Deletes the specified FinalInspection

object.

DOMAIN-ASSET RELATED APIs 261

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspection

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
inspection_state String enum R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
number_of_batches Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
state_change_time String time R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
style_name String string R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
style_type_name String string R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
supplier_name String string R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
batches List<String> refvector R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
error_types List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fibo_ms List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_data_packages List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_image_data_sheets List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_review_styles List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_size_charts List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_spec_data_sheets List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
sections List<String> refvector R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
state_change_user String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
actual_inspection_qty Integer integer R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_month String enum R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_type String enum C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_year String enum R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_orders List<String> reflist R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fi_shipments List<String> reflist R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.

DOMAIN-ASSET RELATED APIs 262

 Centric 8 REST API DEVELOPER GUIDE

inspection_colorways List<String> refset R/W This attribute requires module: AQL to be

installed. Otherwise, it is ignored.
inspection_sizes List<String> refset R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspector String ref R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
sampling_plan String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
style String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
supplier String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
template String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 263

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatch
Creating FinalInspectionBatch
Method:POST
URI Comments

./final_inspections/{final_inspect Creates a new FinalInspectionBatch object as a child

ion_id}/batches of FinalInspection

Reading FinalInspectionBatch
Method:GET
URI Comments

./final_inspections/ Retrieves the specified FinalInspectionBatch

{final_inspection_id}/batches[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./final_inspection_batches/{final_inspe
ction_id}
./final_inspection_batches[?[skip=m][[&
]limit=n][&<filter_parameters>]..]
object referenced by FinalInspection which
match the filter parameters.
Retrieves the specified FinalInspectionBatch
object.
Retrieves the FinalInspectionBatch objects
which match the filter parameters.

Updating FinalInspectionBatch
Method:PUT
URI Comments

./final_inspection_batches/{final_inspection Updates the specified

_id} FinalInspectionBatch object and
changes its state as specified in the
?action={action_name} action parameter. The valid action
values are:
START, PAUSE, RESUME, PASS,
FAIL, REOPEN

Deleting FinalInspectionBatch
Method:DELETE
URI Comments

./final_inspection_batches/{final_inspection_ Deletes the specified

id} FinalInspectionBatch object.

DOMAIN-ASSET RELATED APIs 264

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatch

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
actual_carton_qty Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
actual_samples_cnt Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
cnt_documents Integer integer R/O
defected_items_cnt Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_batch_state String enum R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
quality_a_items Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
quality_b_items Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
recommended_result String enum R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
state_change_time String time R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
target_samples_cnt Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
defects List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
documents List<String> reflist R/O
error_types List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
sampling_plan_item String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
sections List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
state_change_user String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
actual_inspection_lot Integer integer R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_batch_type String enum R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
target_carton_qty Integer integer R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
referenced_documents List<String> reflist R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 265

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatchErrorType
Reading FinalInspectionBatchErrorType
Method:GET
URI Comments

./final_inspection_batches/{final_inspectio Retrieves the

n_batch_id}/error_types[?[skip=m][[&]limit=
n][&<filter_parameters>]..]
./final_inspection_batch_error_types
/{final_inspection_batch_error_type_id}
./final_inspection_batch_error_types
[?[skip=m][[&]limit=n][&<filter_parameters>
]..]
FinalInspectionBatchErrorType object
referenced by FinalInspectionBatch which
match the filter parameters.
Retrieves the specified
FinalInspectionBatchErrorType object.
Retrieves
theFinalInspectionBatchErrorType objects
which match the filter parameters.

Updating FinalInspectionBatchErrorType
Method:PUT
URI Comments

./final_inspection_batch_error_types Updates the specified

FinalInspectionBatchErrorType object.
/{final_inspection_batch_error_type_id}

Method: POST & DELETE unsupported

FinalInspectionBatchErrorType is a read-update only

object. POST and DELETE methods are unsupported.

DOMAIN-ASSET RELATED APIs 266

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchErrorType

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
current_defect_count Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_error_type String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
error_acceptance_limit Integer integer R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 267

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatchSection
Reading FinalInspectionBatchSection
Method:GET
URI Comments

./final_inspection_batches/ Retrieves the

{final_inspection_batch_id}/sections
[?[skip=m][[&]limit=n][&<filter_paramet
ers>]..]
./final_inspection_batch_sections/
{final_inspection_batch_section_id}
./final_inspection_batch_sections
[?[skip=m][[&]limit=n]
specifiedFinalInspectionBatchSection object
referenced by FinalInspectionBatch which
match the filter parameters.
Retrieves the specified
FinalInspectionBatchSection object.
Retrieves the FinalInspectionBatchSection
objects which match the filter parameters.

[&<filter_parameters>]..]

Updating FinalInspectionBatchSection
Method:PUT
URI Comments

./final_inspection_batch_sections/ Updates the specified

FinalInspectionBatchSection object.
{final_inspection_batch_section_id}

Deleting FinalInspectionBatchSection
Method:DELETE
URI Comments

./final_inspection_batch_sections/ Deletes the specified

FinalInspectionBatchSection object.
{final_inspection_batch_section_id}

Method: POST unsupported

FinalInspectionBatchSection is a read, update, delete-only

endpoint. It does not support POST method.

DOMAIN-ASSET RELATED APIs 268

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchSection

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
actual_samples_tested Integer integer R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
samples List<String reflist R/O This attribute requires module: AQL to be
> installed. Otherwise, it is ignored.
section String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
subtype String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
tests List<String refvector R/O This attribute requires module: AQL to be
> installed. Otherwise, it is ignored.
capture_measurement_sa Boolean boolean R/W This attribute requires module: AQL to be
mples installed. Otherwise, it is ignored.
inspection_section_sta String enum R/W This attribute requires module: AQL to be
te installed. Otherwise, it is ignored.
target_samples_tested Integer integer R/W This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 269

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatchSectionSample
Creating FinalInspectionBatchSectionSample
Method:POST
URI Comments

./final_inspection_batch_sections/ Creates a new FinalInspectionBatchSectionSample

object as a child of FinalInspectionBatchSection
{final_inspection_batch_section_id}
/samples

Reading FinalInspectionBatchSectionSample
Method:GET
URI Comments

./final_inspection_batch_sections/ Retrieves the

{final_inspection_batch_section_id}/
samples[?[skip=m][[&]limit=n]
specifiedFinalInspectionBatchSectionS
ample object referenced by
FinalInspectionBatchSection which
match the filter parameters.

[&<filter_parameters>]..]
./final_inspection_batch_section_samples/ Retrieves the specified
FinalInspectionBatchSectionSample
{final_inspection_batch_section_sample_id} object.
./final_inspection_batch_section_samples Retrieves
theFinalInspectionBatchSectionSampl
[?[skip=m][[&]limit=n][&<filter_parameters>].. e objects which match the filter
] parameters.

Updating FinalInspectionBatchSectionSample
Method:PUT
URI Comments

./final_inspection_batch_section_samples/ Updates the specified

FinalInspectionBatchSectionSample
{final_inspection_batch_section_sample_id} object.

Method: DELETE unsupported

FinalInspectionBatchSectionSample does not support

DELETE method.

DOMAIN-ASSET RELATED APIs 270

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchSectionSample

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
fi_sample_dimensions List<String> reflist R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fibs_sample_colorway String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
fibs_sample_size String ref C/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents create only attribute, which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 271

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatchSectionSampleDimension
Reading FinalInspectionBatchSectionSampleDimension
Method:GET
URI Comments

./final_inspection_batch_section_sample_di Retrieves the specified

mensions/ FinalInspectionBatchSectionSampleDimen
sion object.
{final_inspection_batch_section_sample_dime
nsion_id}
./final_inspection_batch_section_sample_di Retrieves
mensions theFinalInspectionBatchSectionSampleDi
mension objects which match the filter
[?[skip=m][[&]limit=n][&<filter_parameters> parameters.
]..]

Updating FinalInspectionBatchSectionSampleDimension
Method:PUT
URI Comments

./final_inspection_batch_section_sample_dime Updates the specified

nsions/ FinalInspectionBatchSectionSampleDim
ension object.
{final_inspection_batch_section_sample_

dimension_id}

Method: POST & DELETE unsupported

FinalInspectionBatchSectionDimension is a read-update
only object. POST and DELETE methods are unsupported.

DOMAIN-ASSET RELATED APIs 272

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchSectionSampleDimension

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
deviation Double double R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
out_of_tolerance Boolean boolean R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
target_value Double double R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_batch_test String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_size_chart_dimension String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
measured_value Double double R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 273

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBatchTest
Creating FinalInspectionBatchTest
Method:POST
URI Comments

./final_inspection_batch_sections/ Creates a new FinalInspectionBatchTest object as a

child of FinalInspectionBatchSection
{final_inspection_batch_section_id}
/tests

Reading FinalInspectionBatchTest
Method:GET
URI Comments

./final_inspection_batch_sections/ Retrieves the

specifiedFinalInspectionBatchTest object
{final_inspection_batch_section_id}/te referenced by FinalInspectionBatchSection
sts[?[skip=m][[&]limit=n] which match the filter parameters.

[&<filter_parameters>]..]
./final_inspection_batch_tests/ Retrieves the specified
FinalInspectionBatchTest object.
{final_inspection_batch_test_id}
./final_inspection_batch_tests Retrieves theFinalInspectionBatchTest objects
which match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionBatchTest
Method:PUT
URI Comments

./final_inspection_batch_tests/ Updates the specified

FinalInspectionBatchTest object.
{final_inspection_batch_test_id}

Deleting FinalInspectionBatchTest
Method:DELETE
URI Comments

./final_inspection_batch_tests/ Deletes the specified

FinalInspectionBatchTest object.
{final_inspection_batch_test_id}

DOMAIN-ASSET RELATED APIs 274

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBatchTest

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
deviation_values List<Integer> integerv R/O This attribute requires module: AQL to
ector be installed. Otherwise, it is ignored.
in_tolerance_cnt Integer integer R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
out_tolerance_cnt Integer integer R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
response String enum R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
colorway String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
defects List<String> reflist R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_page String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_part_material String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_sample_dimensions List<String> refset R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_size_chart_dimension String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_spec_ds_line_item String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
target_color String ref R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
actual_inspected_cnt Integer integer R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
comment String string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
test_spec_rev String ref C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents create only attribute, which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 275

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionBOM
Creating FinalInspectionBOM
Method:POST
URI Comments

./final_inspection/ Creates a new FinalInspectionBOM object as a child

{final_inspection_id}/fi_boms of FinalInspection

Reading FinalInspectionBOM
Method:GET
URI Comments

./final_inspection/{final_inspec Retrieves the specified FinalInspectionBOM object

tion_id} referenced by FinalInspection which match the filter
parameters.
/fi_boms[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_boms/{final_in Retrieves the specified FinalInspectionBOM object.
spection_id}
./final_inspection_boms[?[skip=m] Retrieves the FinalInspectionBOM objects which match
[[&]limit=n][&<filter_parameters> the filter parameters.
]..]

Updating FinalInspectionBOM
Method:PUT
URI Comments

./final_inspection_boms/{final_inspection_id} Updates the specified

FinalInspectionBOM object.

Deleting FinalInspectionBOM
Method:DELETE
URI Comments

./final_inspection_boms/{final_inspection_id} Deletes the specified

FinalInspectionBOM object.

DOMAIN-ASSET RELATED APIs 276

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionBOM

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
bom_revision_name string R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
bom_revision_state enum R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
unlinked boolean R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
bom_revision ref ApparelBOMRe R/O This attribute requires
vision module: AQL to be installed.
Otherwise, it is ignored.
bom_revision_phase ref _CS_Phase R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
fi_part_materials refvector FinalInspection R/O This attribute requires
PartMaterial module: AQL to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
colorways refvector Colorway R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 277

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionDataPackage
Reading FinalInspectionDataPackage
Method:GET
URI Comments

./final_inspection_data_packages/ Retrieves the specified FinalInspectionDataPackage

{final_inspection_data_package_id}
./final_inspection_data_packages
[?[skip=m][[&]limit=n]
object.
Retrieves the FinalInspectionDataPackage objects
which match the <filter_parameters>

[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

FinalInspectionDataPackage is a read-only endpoint. It does not

support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 278

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionDataPackage

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
pdf url R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
data_package ref DataPackage R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 279

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionDefect
Creating FinalInspectionDefect
Method:POST
URI Comments

./final_inspection_batches/ Creates a new FinalInspectionDefect object as a

child of FinalInspectionBatch

{final_inspection_batch_id}/defects

Reading FinalInspectionDefect
Method:GET
URI Comments

./final_inspection_batches/ Retrieves the specified FinalInspectionDefect

object referenced by FinalInspectionBatch
{final_inspection_batch_id}/defects which match the filter parameters.

[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_defects/ Retrieves the specified FinalInspectionDefect
object.
{final_inspection_defect_id}
./final_inspection_defects Retrieves the FinalInspectionDefect objects
which match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionDefect
Method:PUT
URI Comments

./final_inspection_defects/ Updates the specified

FinalInspectionDefect object.
{final_inspection_defect_id}

DOMAIN-ASSET RELATED APIs 280

 Centric 8 REST API DEVELOPER GUIDE

Deleting FinalInspectionDefect
Method:DELETE
URI Comments

./final_inspection_defects/ Deletes the specified

FinalInspectionDefect object.
{final_inspection_defect_id}

Attribute List of FinalInspectionDefect

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
sections reflist FinalInspectionB R/O This attribute requires module: AQL to
atchSection be installed. Otherwise, it is ignored.
tests reflist FinalInspectionB R/O This attribute requires module: AQL to
atchTest be installed. Otherwise, it is ignored.
comment string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
defect_counter integer R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
batch_error_type ref FinalInspectionB C/O This attribute requires module: AQL to
atchErrorType be installed. Otherwise, it is ignored.
defect ref Defect C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents create only attribute, which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 281

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionErrorType
Creating FinalInspectionErrorType
Method:POST
URI Comments

./final_inspections/{final_inspecti Creates a new FinalInspectionErrorType object as a

on_id}/error_types child of FinalInspection.

Reading FinalInspectionErrorType
Method:GET
URI Comments

./final_inspections/ Retrieves the specifiedFinalInspectionErrorType

object referenced by FinalInspection which match
{final_inspection_id}/error_types the filter parameters.

[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_error_types/ Retrieves the specified FinalInspectionErrorType
object.
{final_inspection_error_type_id}
./final_inspection_error_types Retrieves the FinalInspectionErrorType objects
which match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionErrorType
Method:PUT
URI Comments

./final_inspection_error_types/ Updates the specified FinalInspectionErrorType

object.
{final_inspection_error_type_id}

Deleting FinalInspectionErrorType
Method:DELETE
URI Comments

./final_inspection_error_types/ Deletes the specified FinalInspectionErrorType

object.
{final_inspection_error_type_id}

DOMAIN-ASSET RELATED APIs 282

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionErrorType

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
acceptance_limit ref Acceptance C/O This attribute requires module: AQL to
Limit be installed. Otherwise, it is ignored.
error_type ref InspectionE C/O This attribute requires module: AQL to
rrorType be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents create only attribute, which can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 283

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionImageDataSheet
Reading FinalInspectionImageDataSheet
Method:GET
URI Comments

./final_inspection_image_data_sheets Retrieves the

/{final_inspection_image_data_sheet_id}
./final_inspection_image_data_sheets
[?[skip=m][[&]limit=n]
specifiedFinalInspectionImageDataSheet
object.
Retrieves
theFinalInspectionImageDataSheet objects
which match the filter parameters.

[&<filter_parameters>]..]

Updating FinalInspectionImageDataSheet
Method:PUT
URI Comments

./final_inspection_image_data_sheets Updates the specified

FinalInspectionImageDataSheet object.
/{final_inspection_image_data_sheet_id}

Deleting FinalInspectionImageDataSheet
Method:DELETE
URI Comments

./final_inspection_image_data_sheets Deletes the specified

FinalInspectionImageDataSheet object.
/{final_inspection_image_data_sheet_id}

POST unsupported
Method:POST

FinalInspectionImageDataSheet does not support POST method.

DOMAIN-ASSET RELATED APIs 284

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionImageDataSheet

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
description string R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
image_data_sheet_revis enum R/O This attribute requires module: AQL to
ion_state be installed. Otherwise, it is ignored.
fi_labeled_images refvector FinalInspection R/O This attribute requires module: AQL to
LabeledImage be installed. Otherwise, it is ignored.
image_data_sheet_revis ref ImageDataShe R/O This attribute requires module: AQL to
ion etRevision be installed. Otherwise, it is ignored.
image_data_sheet_revis ref _CS_Phase R/O This attribute requires module: AQL to
ion_phase be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 285

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionLabeledImage
Reading FinalInspectionLabeledImage
Method:GET
URI Comments

./final_inspection_labeled_images/ Retrieves the specified FinalInspectionLabeledImage

{final_inspection_labeled_image_id}
./final_inspection_labeled_images
[?[skip=m][[&]limit=n]
object.
Retrieves the FinalInspectionLabeledImage objects
which match the <filter_parameters>

[[&<filter_parameters>]..]

Method: POST, PUT & DELETE unsupported

FinalInspectionLabeledImage is a read-only endpoint.

It does not support POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 286

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionLabeledImage

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
image ref Image R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
labeled_image ref LabeledImage R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 287

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionOrder
Creating FinalInspectionOrder
Method:POST
URI Comments

./final_inspections/ Creates a new FinalInspectionOrder object as a child

of FinalInspection.

{final_inspection_id}/fi_orders

Reading FinalInspectionOrder
Method:GET
URI Comments

./final_inspections/ Retrieves the specified FinalInspectionOrder object

referenced by FinalInspection which match the filter
{final_inspection_id}/fi_orders parameters.

[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_orders/ Retrieves the specified FinalInspectionOrder object.

{final_inspection_order_id}
./final_inspection_orders Retrieves the FinalInspectionOrder objects which
match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionOrder
Method:PUT
URI Comments

./final_inspection_orders/ Updates the specified FinalInspectionOrder object.

{final_inspection_order_id}

Deleting FinalInspectionOrder
Method:DELETE
URI Comments

./final_inspection_orders/ Deletes the specified FinalInspectionOrder object.

{final_inspection_order_id}

DOMAIN-ASSET RELATED APIs 288

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionOrder

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
quantity double R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
order ref Order C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 289

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionPartMaterial
Creating FinalInspectionPartMaterial
Method:POST
URI Comments

./final_inspection_boms/ Creates a new

FinalInspectionPartMaterial object
{final_inspection_bom_id}/fi_part_material as a child of FinalInspectionBOM.

Reading FinalInspectionPartMaterial
Method:GET
URI Comments

./final_inspection_boms/ Retrieves the

specifiedFinalInspectionPartMateri
{final_inspection_bom_id}/fi_part_materials al object referenced by
FinalInspectionBOM which match
the filter parameters.
[?[skip=m][[&]limit=n][&<filter_parameters>]..]
./final_inspection_part_materials/ Retrieves the specified
FinalInspectionPartMaterial object.
{final_inspection_part_material_id}
./final_inspection_part_materials Retrieves
theFinalInspectionPartMaterial
[?[skip=m][[&]limit=n][&<filter_parameters>]..] objects which match the filter
parameters.

Updating FinalInspectionPartMaterial
Method:PUT
URI Comments

./final_inspection_part_materials/ Updates the specified

FinalInspectionPartMaterial object.
{final_inspection_part_material_id}

Deleting FinalInspectionPartMaterial
Method:DELETE
URI Comments

./final_inspection_part_materials/ Deletes the specified

FinalInspectionPartMaterial object.
{final_inspection_part_material_id}

DOMAIN-ASSET RELATED APIs 290

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionPartMaterial

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
unlinked boolean R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
colorways_color refvector Colorway; R/O This attribute requires module: AQL to
ColorMateri be installed. Otherwise, it is ignored.
al;
ColorSpecifi
cation
common_color ref Colorway; R/O This attribute requires module: AQL to
ColorMateri be installed. Otherwise, it is ignored.
al;
ColorSpecifi
cation
common_size ref ProductSize R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
part_material ref PartMaterial R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
material_code string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
material_name string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
part_material_id string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
part_material_main_mate boolean R/W This attribute requires module: AQL to
rial be installed. Otherwise, it is ignored.
material ref Material C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 291

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionReviewStyle
Reading FinalInspectionReviewStyle
Method:GET
URI Comments

./final_inspection_review_styles/ Retrieves the specified FinalInspectionReviewStyle

{final_inspection_review_style_id
}
./final_inspection_review_styles
[?[skip=m][[&]limit=n]
object.
Retrieves the FinalInspectionReviewStyle objects
which match the <filter_parameters>

[[&<filter_parameters>]..]

Deleting FinalInspectionReviewStyle
Method:DELETE
URI Comments

./final_inspection_review_styles/ Deletes the specified FinalInspectionPartMaterial

object.
{final_inspection_review_style_id}

Method: POST & PUT unsupported

FinalInspectionReviewStyle does not support POST or PUT methods.

DOMAIN-ASSET RELATED APIs 292

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionReviewStyle

Attribute Data Type Ref. Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
review_style_re string R/O This attribute requires module: AQL to
vision_name be installed. Otherwise, it is ignored.
review_style_re enum R/O This attribute requires module: AQL to
vision_state be installed. Otherwise, it is ignored.
fi_pages refvector FinalInsp R/O This attribute requires module: AQL to
ectionRe be installed. Otherwise, it is ignored.
viewStyle
Page
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
review_style_re ref ReviewSt C/O This attribute requires module: AQL to
vision yleRevisi be installed. Otherwise, it is ignored.
on
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 293

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionSection
Creating FinalInspectionSection
Method:POST
URI Comments

./final_inspections/ Creates a new FinalInspectionSection object as a

child of FinalInspection.
{final_inspection_id}/sections

Reading FinalInspectionSection
Method:GET
URI Comments

./final_inspections/ Retrieves the specified FinalInspectionSection

object referenced by FinalInspection which match
{final_inspection_id}/sections the filter parameters.

[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_sections/ Retrieves the specified FinalInspectionSection
object.
{final_inspection_section_id}
./final_inspection_sections Retrieves the FinalInspectionSection objects which
match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionSection
Method:PUT
URI Comments

./final_inspection_sections/ Updates the specified FinalInspectionSection object.

{final_inspection_section_id}

Deleting FinalInspectionSection
Method:DELETE
URI Comments

./final_inspection_sections/ Deletes the specified FinalInspectionSection object.

{final_inspection_section_id}

DOMAIN-ASSET RELATED APIs 294

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionSection

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
sample_qty_pct double R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
sample_qty_value integer R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
test_specs_count integer R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
test_spec_revs reflist InspectionTestS R/O This attribute requires module: AQL to
pecRevision be installed. Otherwise, it is ignored.
sample_qty_method enum R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
subtype ref FinalInspectionS C/O This attribute requires module: AQL to
ectionSubtype be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue can be set only when the object is created.
• The attribute in bold brown color represents mandatory attribute.

DOMAIN-ASSET RELATED APIs 295

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionSectionSubtype
Reading FinalInspectionSectionSubtype
Method:GET
URI Comments

./final_inspection_section_subtypes Retrieves the FinalInspectionSectionSubtype

object which match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./final_inspection_section_subtypes/{fi Retrieves the specified
nal_inspection_section_subtype_id} FinalInspectionSectionSubtype object.

Method: POST, PUT & DELETE unsupported

FinalInspectionSectionSubtype is a read-only object.

DOMAIN-ASSET RELATED APIs 296

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionSectionSubtype

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string C/O Display name for the object.
applied_on time R/O
modified boolean R/O
published boolean R/O
setup_applied_on time R/O
setup_modified boolean R/O
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
active boolean R/W
linking_type enum C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 297

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionSecurityGroup
Creating FinalInspectionSecurityGroup
Method:POST
URI Comments

./final_inspection_security_groups Creates a new FinalInspectionSecurityGroup object.

Reading FinalInspectionSecurityGroup
Method:GET
URI Comments

./final_inspection_security_groups/ Retrieves the specified

{final_inspection_section_id}
./final_inspection_security_groups
[?[skip=m][[&]limit=n]
FinalInspectionSecurityGroup object.
Retrieves the FinalInspectionSecurityGroup objects
which match the filter parameters.

[&<filter_parameters>]..]

Updating FinalInspectionSecurityGroup
Method:PUT
URI Comments

./final_inspection_security_groups/ Updates the specified FinalInspectionSecurityGroup

object.
{final_inspection_section_id}

Deleting FinalInspectionSecurityGroup
Method:DELETE
URI Comments

./final_inspection_security_groups/ Deletes the specified FinalInspectionSecurityGroup

object.
{final_inspection_section_id}

DOMAIN-ASSET RELATED APIs 298

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionSecurityGroup

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
security_group_final_ reflist FinalInspection R/O This attribute requires
inspections module: AQL to be installed.
Otherwise, it is ignored.
description string R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 299

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionSizeChart
Creating FinalInspectionSizeChart
Method:POST
URI Comments

./final_inspections/{final_inspection_id} Creates a new FinalInspectionSizeChart

/ object as a child of FinalInspection.
fi_size_charts

Reading FinalInspectionSizeChart
Method:GET
URI Comments

./final_inspections/{final_inspection_id}/ Retrieves theFinalInspectionSizeChart

objects referenced by FinalInspection
fi_size_charts[?[skip=m][[&]limit=n] which match the filter parameters

[&<filter_parameters>]..]
./final_inspection_size_charts/
{final_inspection_size_chart_id}
./final_inspection_size_charts[?[skip=m][[&]l
imit=n][&<filter_parameters>]..]
Retrieves the specified
FinalInspectionSizeChart object.
Retrieves theFinalInspectionSizeChart
objects which match the filter
parameters.

Updating FinalInspectionSizeChart
Method:PUT
URI Comments

./final_inspection_size_charts/{final_ Updates the specified

FinalInspectionSizeChart object.
inspection_size_chart_id}

Deleting FinalInspectionSizeChart
Method:DELETE
URI Comments

./final_inspection_size_charts/{final_ Deletes the specified

FinalInspectionSizeChart object.
inspection_size_chart_id}

DOMAIN-ASSET RELATED APIs 300

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionSizeChart

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
size_chart_revision_name string R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
size_chart_revision_state enum R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
unlinked boolean R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
size_chart_revision ref SizeChartRevision R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
size_chart_revision_phase ref _CS_Phase R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
size_range ref SizeRange R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
sizes refvector ProductSize R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_size_chart_dimensions refvector FinalInspectionSiz R/W This attribute requires module: AQL to
eChartDimension be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 301

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionSizeChartDimension
Reading FinalInspectionSizeChartDimension
Method:GET
URI Comments

./final_inspection_size_charts/ Retrieves the FinalInspectionSizeChartDimension

object referenced by FinalInspectionSizeChart
{final_inspection_size_chart_id}/ which match the filter parameters.

fi_size_chart_dimensions[?[skip=m]

[[&]limit=n][&<filter_parameters>]..]
./final_inspection_size_charts/ Retrieves the specified
FinalInspectionSizeChartDimension object.
{final_inspection_size_chart_id}
./final_inspection_size_charts Retrieves the FinalInspectionSizeChartDimension
object which match the filter parameters.
[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]

Updating FinalInspectionSizeChartDimension
Method:PUT
URI Comments

./final_inspection_size_chart_dimensions/{fina Updates the specified

l_inspection_size_chart_dimension_id} FinalInspectionSizeChartDimension
object.

Method: POST & DELETE unsupported

FinalInspectionSizeChartDimension is Read and Update

only object, it does not support POST and DELETE
methods.

DOMAIN-ASSET RELATED APIs 302

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionSizeChartDimension

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
description string R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_tolerance double R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
inspection_tolerance_ne double R/O This attribute requires module: AQL to be
gative installed. Otherwise, it is ignored.
unlinked boolean R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
apparel_dimension ref ApparelDi R/O This attribute requires module: AQL to be
mension installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to be
installed. Otherwise, it is ignored.
size_chart_dimension ref SizeChartD R/O This attribute requires module: AQL to be
imension installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 303

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionShipment
Creating FinalInspectionShipment
Method:POST
URI Comments

./final_inspections/ Creates a new FinalInspectionShipment object as a

{final_inspection_id}/fi_shipments child of FinalInspection.

Reading FinalInspectionShipment
Method:GET
URI Comments

./final_inspections/{final_inspection_id}/fi_ Retrieves theFinalInspectionShipment

shipments[?[skip=m][[&]limit=n][&<filter_para objects referenced by FinalInspection
meters>]..] which match the filter parameters
./final_inspection_shipments/{final_inspectio Retrieves the specified
n_id} FinalInspectionShipment object.

./final_inspection_shipments[?[skip=m][[&]li Retrieves theFinalInspectionShipment

mit=n] objects which match the filter
parameters.
[&<filter_parameters>]..]

Updating FinalInspectionShipment
Method:PUT
URI Comments

./final_inspection_shipments/{final_ Updates the specified

FinalInspectionShipment object.
inspection_id}

Deleting FinalInspectionShipment
Method:DELETE
URI Comments

./final_inspection_shipments/{final_ Deletes the specified

FinalInspectionShipment object.
inspection_id}

DOMAIN-ASSET RELATED APIs 304

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionShipment

Attribute Data Type Ref. Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
quantity double R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
shipment ref Shipment C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color can be set only when the object is created.

DOMAIN-ASSET RELATED APIs 305

 Centric 8 REST API DEVELOPER GUIDE

FinalInspectionTemplate
Creating FinalInspectionTemplate
Method:POST
URI Comments

./final_inspection_templates Creates a new FinalInspectionTemplate object as a

child of FinalInspection.

Reading FinalInspectionTemplate
Method:GET
URI Comments

./final_inspection_templates/ Retrieves the specified FinalInspectionTemplate

{final_inspection_template_id}
./final_inspection_templates
[?[skip=m][[&]limit=n]
object.
Retrieves the FinalInspectionTemplate objects which
match the filter parameters.

[&<filter_parameters>]..]

Updating FinalInspectionTemplate
Method:PUT
URI Comments

./final_inspection_templates/ Updates the specified FinalInspectionTemplate

object.
{final_inspection_template_id}

Deleting FinalInspectionTemplate
Method:DELETE
URI Comments

./final_inspection_templates/ Deletes the specified FinalInspectionTemplate

object.
{final_inspection_template_id}

DOMAIN-ASSET RELATED APIs 306

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of FinalInspectionTemplate

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
error_types reflist FinalInspectionErrorType R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fibo_ms reflist FinalInspectionBOM R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
fi_size_charts reflist FinalInspectionSizeChart R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
sections refvector FinalInspectionSection R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
sampling_plan ref SamplingPlan R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 307

 Centric 8 REST API DEVELOPER GUIDE

Food
Creating Food
Method:POST
URI Relative Path Comments

./foods Creates a new Food object.

Reading Food
Method:GET
URI Relative Path Comments

./foods/{food_id} Retrieves the specified Food object.

./foods[?[skip=m][[&]limit=n][&...]] Retrieves the Food objects which match <filter
parameters> specified as query string values.

Updating Food
Method:PUT
URI Relative Path Comments

./foods/{food_id} Updates the specified Food object.

Deleting Food
Method:DELETE
URI Relative Path Comments

./foods/{food_id} Deletes the specified Food object.

DOMAIN-ASSET RELATED APIs 308

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
data_sheets reflist ReviewFood; R/O
Artwork;
TestRun;
Specification
DataSheet
documents reflist Document R/O
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
packages reflist DataPackage R/O
product_sources refset FoodSource R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
projects reflist ProjectLineIt R/O
em
realized_products reflist FoodSKU R/O This attribute requires
recent_child_comments refvector Comment R/O module: FormulatedProduct to be
installed. Otherwise, it is ignored.
active boolean R/W
code string R/W
description string R/W
comments reflist Comment R/W
competitive_foods reflist CompetitiveF R/W This attribute requires
ood module: FormulatedProduct to be
installed. Otherwise, it is ignored.
copied_from ref Food R/W
default_quote ref FoodSupplier R/W This attribute requires
Item module: FormulatedProduct to be
designated_product_so ref FoodSource R/W installed. Otherwise, it is ignored.
urce
images refmap Image R/W
product_sales_regions reflist ProductSales R/W This attribute requires
Region module: FormulatedProduct to be
installed. Otherwise, it is ignored.
referenced_documents reflist Document R/W
**subtype ref FoodSubtype C/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new Food object.

• @ - C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 309

 Centric 8 REST API DEVELOPER GUIDE

FoodAllergen
Creating FoodAllergen
Method:POST
URI Relative Path Comments

./food_allergens Creates a new FoodAllergen object.

Reading FoodAllergen
Method:GET
URI Relative Path Comments

./food_allergens/{food_allergen_id} Retrieves the specified FoodAllergen object.

./food_allergens[?[skip=m][[&]limit=n][ Retrieves the FoodAllergen objects which match
&...]] <filter parameters> specified as query string
values.

Updating FoodAllergen
Method:PUT
URI Relative Path Comments

./food_allergens/{food_allergen_id} Updates the specified FoodAllergen object.

Deleting FoodAllergen
Method:DELETE
URI Relative Path Comments

./food_allergens/{food_allergen_id} Deletes the specified FoodAllergen object.

DOMAIN-ASSET RELATED APIs 310

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
languages stringmap R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 311

 Centric 8 REST API DEVELOPER GUIDE

FoodBOMRevision
Reading FoodBOMRevision
Method:GET
URI Relative Path Comments

./food_bom_revisions/{food_bom_revi List all FoodBOMLineItems of the FoodBOMRevision

sion_id}/items/food_bom_line_items with specified id.

./food_bom_revisions/{food_bom_revi Retrieve the specified FoodBOMRevision object.

sion_id}

./food_bom_revisions[?[skip=m][[&]l Retrieve the FoodBOMRevision objects which match

imit=n][&...]] <filter parameters> specified as query string values.

Attribute Summary

Attribute Type Object Read Description

Only*
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
Clarification_numbe integer R/O
r
Effective_end time R/O This attribute requires module:
EngineeringChange to be installed.
Otherwise, it is ignored.
effective_end time R/O This attribute requires module:
EngineeringChange to be installed.
Otherwise, it is ignored.
effective_start time R/O This attribute requires module:
EngineeringChange to be installed.
Otherwise, it is ignored.
is_current boolean R/O
is_managed_by_ec boolean R/O This attribute requires module:
EngineeringChange to be installed.
Otherwise, it is ignored.
pdf url R/O
pending_2_time time R/O
pending_time time R/O
proofing_time time R/O
release_version string R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O

DOMAIN-ASSET RELATED APIs 312

 Centric 8 REST API DEVELOPER GUIDE

validation_status enum R/O

validation_time time R/O
approver ref User R/O
bom_main_materials refset Material R/O This attribute requires module:
FormulatedProduct to be installed.
Otherwise, it is ignored.
bom_materials refset Material R/O
items refvector FoodBOMLin R/O
eItem
modified_by ref User R/O This attribute requires module:
FormulatedProduct to be installed.
Otherwise, it is ignored.
pending_2_user ref User R/O
pending_user ref User R/O
phase ref _CS_Phase R/O
proofing_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
workflow_execution ref ActionItem R/O
bom_main_material_c integer R/W
ount
description string R/W
revision_comment string R/W
all_sections refvector BOMSection R/W
Definition
pages refvector DataSheetPa R/W
ge
workflow_holder ref FoodBOM R/W
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

* All attributes are read/only, but this column provides context as to how these attribute values would be
managed with a full CRUD API.

DOMAIN-ASSET RELATED APIs 313

 Centric 8 REST API DEVELOPER GUIDE

FoodClaim
Creating FoodClaim
Method:POST
URI Relative Path Comments

./food_claims Creates a new FoodClaim object.

Reading FoodClaim
Method:GET
URI Relative Path Comments

./food_claims/{food_claim_id} Retrieves the specified FoodClaim object.

./food_claims[?[skip=m][[&]limit=n][&.. Retrieves the FoodClaim objects which match
.]] <filter parameters> specified as query string
values.

Updating FoodClaim
Method:PUT
URI Relative Path Comments

./food_claims/{food_claim_id} Updates the specified FoodClaim object.

Deleting FoodClaim
Method:DELETE
URI Relative Path Comments

./food_claims/{food_claim_id} Deletes the specified FoodClaim object.

DOMAIN-ASSET RELATED APIs 314

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
languages stringmap R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 315

 Centric 8 REST API DEVELOPER GUIDE

FoodIngredient
Creating FoodIngredient
Method:POST
URI Relative Path Comments

./food_ingredients Creates a new FoodIngredient object.

Reading FoodIngredient
Method:GET
URI Relative Path Comments

./food_ingredients/{food_ingredient_id} Retrieves the specified FoodIngredient object.

./food_ingredients[?[skip=m][[&]limit=n Retrieves the FoodIngredient objects which
][&...]] match <filter parameters> specified as query
string values.

Updating FoodIngredient
Method:PUT
URI Relative Path Comments

./food_ingredients/{food_ingredien Updates the specified FoodIngredient object.

t_id}

Deleting FoodIngredient
Method:DELETE
URI Relative Path Comments

./food_ingredients/{food_ingredien Deletes the specified FoodIngredient object.

t_id}

DOMAIN-ASSET RELATED APIs 316

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
languages stringmap R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 317

 Centric 8 REST API DEVELOPER GUIDE

FoodLabelDataSheet
Creating FoodLabelDataSheet
Method:POST
URI Relative Path Comments

./foods/{food_id}/data_sheets Creates a new FoodLabelDataSheet object as a child

of Food.

Reading FoodLabelDataSheet
Method:GET
URI Relative Path Comments

./foods/{food_id}/data_sheets[?[skip=m] Retrieves the FoodLabelDataSheet objects

[[&]limit=n][&...]] referenced by Food which match filter
parameters specified as query string values.
./food_label_data_sheets/{food_label_da Retrieves the specified FoodLabelDataSheet
ta_sheet_id} object.
./food_label_data_sheets[?[skip=m][[&]l Retrieves the FoodLabelDataSheet objects
imit=n][&...]] which match <filter parameters> specified as
query string values.

Updating FoodLabelDataSheet
Method:PUT
URI Relative Path Comments

./food_label_data_sheets/{food_lab Updates the specified FoodLabelDataSheet object.

el_data_sheet_id}

Deleting FoodLabelDataSheet
Method:DELETE
URI Relative Path Comments

./food_label_data_sheets/{food_lab Deletes the specified FoodLabelDataSheet object.

el_data_sheet_id}

DOMAIN-ASSET RELATED APIs 318

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref FoodLabel R/O
DataSheet
Revision
for_product_source ref ProductSou R/O
rce
latest_revision ref FoodLabel R/O
DataSheet
Revision
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
phase_current_revis refmap FoodLabel R/O
ions DataSheet
Revision
can_track_by_calend boolean R/W
ar
description string R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
**subtype ref FoodLabel C/O This attribute requires
DataSheet module: FormulatedProduct to be
Subtype installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new FoodLabelDataSheet object.

• @ - C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 319


FoodLabelDataSheetRevision
Creating FoodLabelDataSheetRevision
Method:POST
URI Relative Path
./food_label_data_sheet_revisions/{
food_label_data_sheet_revision_id}/
revise
Reading FoodLabelDataSheetRevision
Method:GET
URI Relative Path
./food_label_data_sheet_revisions/{food
_label_data_sheet_revision_id}
./food_label_data_sheet_revisions[?[ski
p=m][[&]limit=n][&...]]
Updating FoodLabelDataSheetRevision
Method:PUT
URI Relative Path
./food_label_data_sheet_revisions/
{food_label_data_sheet_revision_id
}
./food_label_data_sheet_revisions/
{food_label_data_sheet_revision_id
}?action={action_name}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates revision for the specified
food_label_data_sheet_revision_id object.
Comments
Retrieves the specified
FoodLabelDataSheetRevision object.
Retrieves the FoodLabelDataSheetRevision
objects which match <filter parameters>
specified as query string values.
Comments
Updates the specified FoodLabelDataSheetRevision
object.
Updates the specified FoodLabelDataSheetRevision
object and changes the revision state based on the
actions enum list [APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION]
320
 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_numbe integer R/O
r
effective_end time R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
effective_start time R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
is_current boolean R/O
is_managed_by_ec boolean R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
pdf url R/O
pending_2_time time R/O
pending_time time R/O
proofing_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
allergens refvector AllergenIte R/O This attribute requires
m module: FormulatedProduct to be
installed. Otherwise, it is ignored.
approver ref User R/O
claims refvector ClaimItem R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
ingredients refvector IngredientIt R/O This attribute requires
em module: FormulatedProduct to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
nutrients refvector NutrientIte R/O This attribute requires
m module: FormulatedProduct to be
installed. Otherwise, it is ignored.
pending_2_user ref User R/O
pending_user ref User R/O
phase ref _CS_Phas R/O
e
proofing_user ref User R/O
revert_user ref User R/O

DOMAIN-ASSET RELATED APIs 321

 Centric 8 REST API DEVELOPER GUIDE

review_user ref User R/O

state_change_user ref User R/O
workflow_execution ref ActionItem R/O
batch_size double R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
declared_weight double R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
description string R/W
revision_comment string R/W
serving_size double R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
pages refvector DataSheet R/W
Page
workflow_holder ref WorkflowH R/W
older
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 322

 Centric 8 REST API DEVELOPER GUIDE

FoodNutrient
Creating FoodNutrient
Method:POST
URI Relative Path Comments

./food_nutrients Creates a new FoodNutrient object.

Reading FoodNutrient
Method:GET
URI Relative Path Comments

./food_nutrients/{food_nutrient_id} Retrieves the specified FoodNutrient object.

./food_nutrients[?[skip=m][[&]limit=n][ Retrieves the FoodNutrient objects which match
&...]] <filter parameters> specified as query string
values.

Updating FoodNutrient
Method:PUT
URI Relative Path Comments

./food_nutrients/{food_nutrient_id Updates the specified FoodNutrient object.

}

Deleting FoodNutrient
Method:DELETE
URI Relative Path Comments

./food_nutrients/{food_nutrient_id Deletes the specified FoodNutrient object.

}

DOMAIN-ASSET RELATED APIs 323

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
languages stringmap R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 324

 Centric 8 REST API DEVELOPER GUIDE

FoodSample
Creating FoodSample
Method:POST
URI Relative Path Comments

./food_sources/{food_source_id}/sam Creates a new FoodSample object as a child of

ples FoodSource.

Reading FoodSample
Method:GET
URI Relative Path Comments

./food_sources/{food_source_id}/samples Retrieves the FoodSample objects referenced

[?[skip=m][[&]limit=n][&...]] by FoodSource which match filter parameters
specified as query string values.
./food_samples/{food_sample_id} Retrieves the specified FoodSample object.

./food_samples[?[skip=m][[&]limit=n][&. Retrieves the FoodSample objects which match

..]] <filter parameters> specified as query string
values.

Updating FoodSample
Method:PUT
URI Relative Path Comments

./food_samples/{food_sample_id} Updates the specified FoodSample object.

Deleting FoodSample
Method:DELETE
URI Relative Path Comments

./food_samples/{food_sample_id} Deletes the specified FoodSample object.

DOMAIN-ASSET RELATED APIs 325

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
storage_bin_number string R/O
storage_name string R/O
modified_by ref User R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
product_color ref Colorway; R/O This attribute requires
ColorMaterial module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
product_size ref ProductSize R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
recent_child_commen refvector Comment R/O
ts
recent_comments refvector Comment R/O
sample_po_colors reflist PurchasedOr R/O This attribute requires
derColor module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
sample_po_products reflist PurchasedOr R/O This attribute requires
derProduct module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
sample_sr_line_item ref SRLineItem R/O
sample_storage ref SampleStora R/O
ge
description string R/W
request_number string R/W
requested_qty double R/W
sample_notes string R/W
sample_received_dat time R/W
e
sample_review_date time R/W
sample_status enum R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
sample_type enum R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.

DOMAIN-ASSET RELATED APIs 326

 Centric 8 REST API DEVELOPER GUIDE

comments reflist Comment R/W

documents reflist Document R/W
images refmap Image R/W
referenced_document reflist Document R/W
s
responsible_users reflist User R/W
sample_data_sheets reflist FoodLabelDa R/W
taSheet;
ReviewFood;
PrintDesign;
Specification
DataSheet;
PriceList;
CareAndCo
mposition
sample_factory ref Factory R/W
sample_product_alte ref ProductAlter R/W
rnative native
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 327

 Centric 8 REST API DEVELOPER GUIDE

FoodSource
Creating FoodSource
Method:POST
URI Relative Path Comments

./foods/{food_id}/product_sources Creates a new FoodSource object as a child of Food.

Reading FoodSource
Method:GET
URI Relative Path Comments

./foods/{food_id}/product_sources[?[ski Retrieves the FoodSource objects referenced

p=m][[&]limit=n][&...]] by Food which match filter parameters specified
as query string values.
./food_sources/{food_source_id} Retrieves the specified FoodSource object.

./food_sources[?[skip=m][[&]limit=n][&. Retrieves the FoodSource objects which match

..]] <filter parameters> specified as query string
values.

Updating FoodSource
Method:PUT
URI Relative Path Comments

./food_sources/{food_source_id} Updates the specified FoodSource object.

Deleting FoodSource
Method:DELETE
URI Relative Path Comments

./food_sources/{food_source_id} Deletes the specified FoodSource object.

DOMAIN-ASSET RELATED APIs 328

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
recent_child_commen refvector Comment R/O
ts
recent_comments refvector Comment R/O
images refmap Image R/W
referenced_document reflist Document R/W
s
samples reflist FoodSample R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
**supplier ref Supplier C/O
supplier_items refset FoodSupplier R/W This attribute requires
Item module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new FoodSource object.

• @ - C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 329

 Centric 8 REST API DEVELOPER GUIDE

FoodSKU
Creating FoodSKU
Method:POST
URI Relative Path Comments

./foods/{food_id}/realized_products Create a new FoodSKU object as a child of Food.

Reading FoodSKU
Method:GET
URI Relative Path Comments

./foods/{food_id}/realized_products[?[s Retrieves the FoodSKU objects referenced by

kip=m][[&]limit=n][&...]] Food which match filter parameters specified as
query string values.
./food_skus/{food_sku_id} Retrieves the specified FoodSKU object.

./food_skus[?[skip=m][[&]limit=n][&...] Retrieves the FoodSKU objects which match

] <filter parameters> specified as query string
values.

Updating FoodSKU
Method:PUT
URI Relative Path Comments

./food_skus/{food_sku_id} Updates the specified FoodSKU object.

Deleting FoodSKU
Method:DELETE
URI Relative Path Comments

./food_skus/{food_sku_id} Deletes the specified FoodSKU object.

DOMAIN-ASSET RELATED APIs 330

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
gtin string R/O
gtin_checksum string R/O
gtin_manufacturer_c string R/O
ode
gtin_product_code string R/O
master_carton_i_2of string R/O
_5_checksum
master_carton_i_2of string R/O
_5_leading_digit
master_carton_i_2of string R/O
_5_pack_code
pallet_i_2of_5_chec string R/O
ksum
pallet_i_2of_5_lead string R/O
ing_digit
pallet_i_2of_5_pack string R/O
_code
contained_by reflist SelectSetIte R/O
m
modified_by ref User R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
recent_child_commen refvector Comment R/O
ts
recent_comments refvector Comment R/O
active boolean R/W
master_carton_i_2of string R/W
_5
pallet_i_2of_5 string R/W
comments reflist Comment R/W
documents reflist Document R/W
fps_product_sales_r ref ProductSales R/W This attribute requires
egion Region module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
images refmap Image R/W
referenced_document reflist Document R/W
s
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 331

 Centric 8 REST API DEVELOPER GUIDE

FoodSupplierItem
Creating FoodSupplierItem
Method:POST
URI Relative Path Comments

./food_sources/{food_source_id}/sup Creates a new FoodSupplierItem object as a child of

plier_items FoodSource.

Reading FoodSupplierItem
Method:GET
URI Relative Path Comments

./food_sources/{food_source_id}/supplie Retrieves the FoodSupplierItem objects

r_items[?[skip=m][[&]limit=n][&...]]
./food_supplier_items/{food_supplier_it
em_id}
./food_supplier_items[?[skip=m][[&]limi
t=n][&...]]
referenced by FoodSource which match filter
parameters specified as query string values.
Retrieves the specified FoodSupplierItem
object.
Retrieves the FoodSupplierItem objects which
match <filter parameters> specified as query
string values.

Updating FoodSupplierItem
Method:PUT
URI Relative Path Comments

./food_supplier_items/{food_suppli Updates the specified FoodSupplierItem object.

er_item_id}

Deleting FoodSupplierItem
Method:DELETE
URI Relative Path Comments

./food_supplier_items/{food_suppli Deletes the specified FoodSupplierItem object.

er_item_id}

DOMAIN-ASSET RELATED APIs 332

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
adoption_status enum R/O
cnt_documents integer R/O
offline boolean R/O
offline_import_erro string R/O
r
current_revision ref FoodSupplier R/O
ItemRevision
latest_revision ref FoodSupplier R/O
ItemRevision
modified_by ref User R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
phase_current_revis refmap FoodSupplier R/O
ions ItemRevision
recent_child_commen refvector Comment R/O
ts
recent_comments refvector Comment R/O
description string R/W
comments reflist Comment R/W
documents reflist Document R/W
images refmap Image R/W
referenced_document reflist Document R/W
s
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 333

 Centric 8 REST API DEVELOPER GUIDE

FormulatedMaterial
Creating FormulatedMaterial
Method:POST
URI Relative Path Comments

./formulated_materials Create a new FormulatedMaterial object.

Reading FormulatedMaterial
Method:GET
URI Relative Path Comments

./formulated_materials/{formulated_ Retrieve the specified FormulatedMaterial object.

material_id}

./formulated_materials[?[skip=m][[& Retrieve the FormulatedMaterial objects which match

]limit=n][&...]] <filter parameters> specified as query string values.

Updating FormulatedMaterial
Method:PUT
URI Relative Path Comments

./formulated_materials/{formulated Update the specified FormulatedMaterial object.

_material_id}

Deleting FormulatedMaterial
Method:DELETE
URI Relative Path Comments

./formulated_materials/{formulated Delete the specified FormulatedMaterial object.

_material_id}

DOMAIN-ASSET RELATED APIs 334

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
documents reflist Document R/O
modified_by ref User R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
pp_set_items refset ProductPresent R/O This attribute requires module:
ationSetItem ProductPresentation to be
installed. Otherwise, it is
ignored.
projects reflist ProjectLineItem R/O
recent_comments refvector Comment R/O
shared_spec_sections refset SpecificationSec R/O
tion
active boolean R/W
code string R/W
description string R/W
comments reflist Comment R/W
copied_from ref FormulatedMate R/W
rial
data_sheets reflist ReviewFood; R/W
FoodLabelData
Sheet;
RecipeDataShe
et; TestRun;
Routing;
SpecificationDat
aSheet
default_quote ref FoodSupplierIte R/W This attribute requires module:
m FormulatedProduct to be
installed. Otherwise, it is
ignored.
default_recipe ref RecipeDataShe R/W This attribute requires module:
et FormulatedProduct to be
installed. Otherwise, it is
ignored.
images refmap Image R/W
product_sources refset FoodSource R/W This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
referenced_documents reflist Document R/W
subtype** ref FormulatedMate C/O This attribute requires module:
rialSubtype FormulatedProduct to be

DOMAIN-ASSET RELATED APIs 335

 Centric 8 REST API DEVELOPER GUIDE

installed. Otherwise, it is
ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

** This attribute is required when creating a new FormulatedMaterial object.

@ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 336

 Centric 8 REST API DEVELOPER GUIDE

FPItem
Creating FPItem
Method:POST
URI Relative Path Comments

./apparel_bom_revisions/{apparel_bo Creates a new FPItem object as a child of

m_revision_id}/fp_items ApparelBOMRevision.
NOTE: Use version V3 of this API if the user is using
Centric 8 version 7.5 and above.

Reading FPItem
Method:GET
URI Relative Path Comments

./apparel_bom_revisions/{apparel_bom_re Retrieves the FPItem objects referenced by

vision_id}/fp_items[?[skip=m][[&]limit=
n][&...]]
./fp_items/{fp_item_id}
ApparelBOMRevision which match filter
parameters specified as query string values.
NOTE: Use version V3 of this API if the user is
using Centric 8 version 7.5 and above.
Retrieves the specified FPItem object.

./fp_items[?[skip=m][[&]limit=n][&...]] Retrieves the FPItem objects which match <filter

parameters> specified as query string values.

Updating FPItem
Method:PUT
URI Relative Path Comments

./fp_items/{fp_item_id} Updates the specified FPItem object.

Deleting FPItem
Method:DELETE
URI Relative Path Comments

./fp_items/{fp_item_id} Deletes the specified FPItem object.

DOMAIN-ASSET RELATED APIs 337

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID

1_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
fp_item_sku ref FoodSKU R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
quantity double R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
fp_item_product ref Food R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
only_for_colors refset Colorway R/W This attribute requires
module: FormulatedProduct to
be installed. Otherwise, it is
ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 338

 Centric 8 REST API DEVELOPER GUIDE

Group
Creating Group
Method:POST
URI Comments

./groups Creates a new Group object.

Reading Group
Method:GET
URI Comments

./groups/{group_id} Retrieves the specified Group object.

./groups[?[skip=m][[&]limit=n] Retrieves the Group objects which match the
<filter_parameters> included in the
[& <filter_parameters>]..] resource_path.

Updating Group
Method:PUT
URI Comments

./groups/{group_id} Updates the specified Group object.

Deleting Group
Method:DELETE
URI Comments

./groups/{group_id} Deletes the specified Group object.

DOMAIN-ASSET RELATED APIs 339

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Group

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
__members__ reflist User R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents mandatory attribute.

DOMAIN-ASSET RELATED APIs 340

 Centric 8 REST API DEVELOPER GUIDE

Holiday
Creating Holiday
Method:POST
URI Comments

./holiday_calendars/{holiday_calend Creates a new Holiday object as a child of

ar_id} HolidayCalendar.
/holidays

Reading Holiday
Method:GET
URI Comments

./materials/{material_id}/themes Retrieves the Theme objects referenced by

Material which matches the filter parameter
[?[skip=m][[&]limit=n][&<filter_paramet
ers>]..]
./holiday_calendars/{holiday_calendar_ Retrieves the Holiday objects referenced by
id}/holidays HolidayCalendar which match filter parameters
specified as query string values.
[?[skip=m][[&]limit=n][&<filter_paramet
ers>]..]
./holidays/{holiday_id} Retrieves the specified Holiday object.

./holidays[?[skip=m][[&]limit=n][&<filt Retrieves the Holiday objects which match

er_parameters>]..] <filter parameters> specified as query string
values.

Updating Holiday
Method:PUT
URI Comments

./holidays/{holiday_id} Updates the specified Holiday object.

Deleting Holiday
Method:DELETE
URI Comments

./holidays/{holiday_id} Deletes the specified Holiday object.

DOMAIN-ASSET RELATED APIs 341

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Holiday

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires module: WBS to be
installed. Otherwise, it is ignored.

end_date time R/W This attribute requires module: WBS to be

installed. Otherwise, it is ignored.

start_date time R/W This attribute requires module: WBS to be

installed. Otherwise, it is ignored.

links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 342

 Centric 8 REST API DEVELOPER GUIDE

HolidayCalendar
Creating HolidayCalendar
Method:POST
URI Comments

./holiday_calendars Creates a new HolidayCalendar object.

Reading HolidayCalendar
Method:GET
URI Comments

./holiday_calendars/{holiday_calendar_i Retrieve the specified HolidayCalendar object.

d}
./holiday_calendars Retrieve the HolidayCalendar objects which
match <filter parameters> specified as query
[?[skip=m][[&]limit=n][&<filter_paramet string values.
ers>]..]

Updating HolidayCalendar
Method:PUT
URI Comments

./holiday_calendars/{holiday_calendar_id} Updates the specified HolidayCalendar

object.

Deleting HolidayCalendar
Method:DELETE
URI Comments

./holiday_calendars/{holiday_calendar_id} Deletes the specified HolidayCalendar

object.

DOMAIN-ASSET RELATED APIs 343

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of HolidayCalendar

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
is_current boolean R/O This attribute requires module: WBS to be
installed. Otherwise, it is ignored.
holidays reflist Holiday R/O This attribute requires module: WBS to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module: WBS to be
installed. Otherwise, it is ignored.
active boolean R/W This attribute requires module: WBS to be
installed. Otherwise, it is ignored.
description string R/W This attribute requires module: WBS to be
installed. Otherwise, it is ignored.
latest_calendar_chan time R/W This attribute requires module: WBS to be
ge installed. Otherwise, it is ignored.
wbs_latest_date_chan time R/W This attribute requires module: WBS to be
ge_update_run installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 344

 Centric 8 REST API DEVELOPER GUIDE

Image
Creating and uploading Image
Method:POST
URI Comments

./images Creates a new Image object.

You have to upload an image as multipart attachment to the POST

call, else the call will fail. On successful upload, the Centric Server
will automatically generate the smaller images and thumbnail as well
populate all the necessary attribute, so POST method will not accept
any data payload. An image upload program example is provided in
this Dev Guide to illustrate the usage.

Reading Image
Method:GET
URI Comments

./color_materials/{color_material_id}/ Retrieve the Image objects referenced by

images[?[skip=m][[&]limit=n][&<filter_p
arameters>]..]
./color_specifications/{color_specific
ation_id}/images[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
ColorMaterial which match filter parameters
specified as query string values.
Retrieve the Image objects referenced by
ColorSpecification which match filter parameters
specified as query string values.

./colorways/{colorway_id}/images[?[skip Retrieve the Image objects referenced by

=m][[&]limit=n][&<filter_parameters>]..
] specified as query string values.
./colorways/images[?[skip=m][[&]limit=n
][&<filter_parameters>]..]
./factories/{factory_id}/images[?[skip=
m][[&]limit=n][&<filter_parameters>]..]
./materials/{material_id}/images[?[skip
=m][[&]limit=n][&<filter_parameters>]..
] as query string values.
./materials/images[?[skip=m][[&]limit=n
][&<filter_parameters>]..]
Colorway which match filter parameters
Retrieve the Image objects referenced by a
Colorway which match(es) qualified filter
parameters specified as colorway.<attribute>
=value where <attribute> is an attribute of the
Colorway EndPoint and unqualified filter
parameters of the form <attribute>=value where
<attribute> is an attribute of the Image
EndPoint.
Retrieve the Image objects referenced by
Factory which match filter parameters specified
as query string values.
Retrieve the Image objects referenced by
Material which match filter parameters specified
Retrieve the Image objects referenced by a
Material which match(es) qualified filter
parameters specified as material.<attribute>
=value where <attribute> is an attribute of the

DOMAIN-ASSET RELATED APIs 345

 Centric 8 REST API DEVELOPER GUIDE

URI Comments

Material EndPoint and unqualified filter

./styles/{style_id}/images[?[skip=m][[&
]limit=n][&<filter_parameters>]..]
./styles/images[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./spec_library_items/{spec_library_item
_id}/images[?[skip=m][[&]limit=n][&<fil
ter_parameters>]..]
./suppliers/{supplier_id}/images[?[skip
=m][[&]limit=n][&<filter_parameters>]..
] as query string values.
./images/{image_id}
parameters of the form <attribute>=value where
<attribute> is an attribute of the Image
EndPoint.
Retrieve the Image objects referenced by Style
which match filter parameters specified as query
string values.
Retrieve the Image objects referenced by a
Style which match(es) qualified filter parameters
specified as style.<attribute> =value where
<attribute> is an attribute of the Style EndPoint
and unqualified filter parameters of the form
<attribute>=value where <attribute> is an
attribute of the Image EndPoint.
Retrieve the Image objects referenced by
SpecLibraryItem which match filter parameters
specified as query string values.
Retrieve the Image objects referenced by
Supplier which match filter parameters specified
Retrieve the specified Image object.

./images[?[skip=m][[&]limit=n][&<filter Retrieve the Image objects which match <filter

_parameters>]..] parameters> specified as query string values.

Updating Image
Method:PUT
URI Comments

./images/{image_id} Updates the specified Image object. Mostly used to update the image tags.

NOTE: Centric UI or REST API does not allow you to upload custom thumbnails or low
resolution images for the full resolution image. The only attribute that can be changed by PUT
call are generated_by and the tags attribute.

Deleting Image
Method:DELETE
URI Comments

./images/{image_id} Deletes the specified Image object.

DOMAIN-ASSET RELATED APIs 346

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Image

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
file_size int64 R/O
large_image url R/O
recycled boolean R/O
small_image url R/O
thumbnail url R/O
viewable url R/O
modified_by ref User R/O
generated_by string R/W
tags stringvector R/W
_url_base_template string R/O File (image, pdf, document) retrieval URL
template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

List of Objects containing Image (Centric Version 6.6 and higher datamodel)

AbstractContact PrintSpecification
CompetitiveStyle ProductColor
CustomSalesCollection ProductSample
Defect ProductSymbol
DocumentRevision QuestionRevision
FinalInspectionDefect RealizedProduct
InspectionTestSpecRevision SalesPromo
LibraryItem SelectSet
MarketingCollection Shape
MarketingLook SizeChartRevision
MarketingSegment SizeLabelSize
MCMaterial SRLineItem
MCMaterialColor StructureItem
MCProduct Style
MCProductColor SupplierItem
MTSection Test
OperationsReviewTemplateRevision TestSpecRevision
ORQuestion Theme

DOMAIN-ASSET RELATED APIs 347


ImageDataSheet
Creating ImageDataSheet
Method:POST
URI
./styles/{style_id}/data_sheets/image_dat
a_sheets
Reading ImageDataSheet
Method:GET
URI
./styles/{style_id}/data_sheets/
image_data_sheets[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
./image_data_sheets/{image_data_sheet_id}
./image_data_sheet_revisions/
{image_data_sheet_revision_id}
Updating ImageDataSheet
Method:PUT
URI
./image_data_sheets/{image_data_sheet_id}
Deleting ImageDataSheet
Method:DELETE
URI
./image_data_sheets/{image_data_sheet_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new ImageDataSheet object as a
child of Style.
Comments
Retrieves the ImageDataSheet objects
referenced by Style which match the filter
parameters.
Retrieves the specified ImageDataSheet
object.
Retrieves the ImageDataSheet objects
which match the <filter_parameters>.
Comments
Updates the specified ImageDataSheet object.
Comments
Deletes the specified ImageDataSheet object.
348
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ImageDataSheet

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref ImageDataSheet R/O
Revision
latest_revision ref ImageDataSheet R/O
Revision
modified_by ref User R/O
revisions refvector ImageDataSheet R/O
Revision
can_track_by_calendar boolean R/W
description string R/W
final_inspection_rele boolean R/W This attribute requires module: AQL to
vant be installed. Otherwise, it is ignored.
subtype ref ImageDataSheet C/O
Subtype
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 349

 Centric 8 REST API DEVELOPER GUIDE

ImageDataSheetRevision
Creating ImageDataSheetRevision
Method:POST
URI Comments

./image_data_sheet_revisions/ Creates a revision for the specified

{image_data_sheet_revision_id}/revise ImageDataSheetRevision object.

Reading ImageDataSheetRevision
Method:GET
URI Comments

./image_data_sheet_revisions/ Retrieves the

{image_data_sheet_revision_id}
./image_data_sheet_revisions
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
specifiedImageDataSheetRevision object.
Retrieves the ImageDataSheetRevision
objects which match the
<filter_parameters>.

Updating ImageDataSheetRevision
Method:PUT
URI Comments

./image_data_sheet_revisions/ Updates the specified ImageDataSheetRevision object.

{image_data_sheet_revision_id}
./image_data_sheet_revisions/
{image_data_sheet_revision_id}
?action={action_name}
Update the specified ImageDataSheetRevision object and
changes the revision state based on the actions enum list:
APPROVED, ABANDONED, FREEZE, REOPEN, REVIEW,
PURGEREVISION, PURGERESETREVISION

Method: DELETE unsupported

ImageDataSheetRevision is a create read, update-only

object. It does not support DELETE method.

DOMAIN-ASSET RELATED APIs 350

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ImageDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref ImageDataShee R/O
tRevision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
phase ref _CS_Phase R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
workflow_execution ref ActionItem R/O
description string R/W
labeled_images refvector LabeledImage R/W
pages refvector DataSheetPage R/W
workflow_holder ref WorkflowHolder R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 351

 Centric 8 REST API DEVELOPER GUIDE

ImpactedItem
The ImpactedItem EndPoint is a read/only endpoint.

Reading ImpactedItem
Method:GET
URI Comments

./impacted_items/{impacted_item_id} Retrieves the specified ImpactedItem

object.
./impacted_items[?[skip=m][[&]limit=n][&.. Retrieves the ImpactedItem objects which
.]] match <filter parameters> specified as
query string values.

Attribute Summary

Attribute Type Object Read Description

Only*
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
impact_level integer R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
item_type enum R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
reason_for_impactin string R/O This attribute requires
g module: EngineeringChange to be
installed. Otherwise, it is ignored.
item ref PartMaterial R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
item_product ref Shape; Style; R/O This attribute requires
Material module: EngineeringChange to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: EngineeringChange to be
installed. Otherwise, it is ignored.
next_level_impacted refset ImpactedItem R/O This attribute requires
_items module: EngineeringChange to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• * - All attributes are read/only, but this column provides context as to how these attribute values will be managed with a full
CRUD API.

DOMAIN-ASSET RELATED APIs 352

 Centric 8 REST API DEVELOPER GUIDE

Increment
Creating Increment
Method:POST
URI Comments

./increments Creates a new Increment object.

Reading Increment
Method:GET
URI Comments

./increments/{increment_id} Retrieves the specified Increment object.

./increments[?[skip=m][[&] Retrieves the Increment objects which match the

<filter_parameters>.
limit=n][& <filter_parameters>]..]

Updating Increment
Method:PUT
URI Comments

./increments/{increment_id} Updates the specified Increment object.

Deleting Increment
Method:DELETE
URI Comments

./increments/{increment_id} Deletes the specified Increment object.

DOMAIN-ASSET RELATED APIs 353

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Increment

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
dimension_1_type enum R/O
dimension_2_type enum R/O
sys_id string R/O
dimensions refvector IncrementDim R/O
ension
increment_dimension_1 refvector ProductSize R/O
_sizes
increment_dimension_2 refvector ProductSize R/O
_sizes
modified_by ref User R/O
active boolean R/W
description string R/W
base_size ref IncrementSize R/W
images refmap Image R/W
increment_size_range ref SizeRange R/W
sizes refvector IncrementSize R/W
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 354

 Centric 8 REST API DEVELOPER GUIDE

IncrementDimension
Creating IncrementDimension
Method:POST
URI Comments

./increments/{increment_id}/dimens Creates a new IncrementDimension object as a child

ions of Increment.

Reading IncrementDimension
Method:GET
URI Comments

./increments/{increment_id}/ Retrieves the IncrementDimension objects

referenced by Increment which match the
dimensions[?[skip=m][[&] <filter_parameters>.

limit=n][& <filter_parameters>]..]
./increment_dimensions/ Retrieve the specified IncrementDimention
object.
{increment_dimension_id}
./increment_dimensions[?[skip=m][[&] Retrieves the IncrementDimension objects which
match the <filter_parameters>.
limit=n][& <filter_parameters>]..]

Updating IncrementDimension
Method:PUT
URI Comments

./increment_dimensions/ Updates the specified IncrementDimension object.

{increment_dimension_id}

Deleting IncrementDimension
Method:DELETE
URI Comments

./increment_dimensions/ Deletes the specified IncrementDimension object.

{increment_dimension_id}

DOMAIN-ASSET RELATED APIs 355

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of IncrementDimension

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
increment_dimension ref ApparelDimen R/O
sion
modified_by ref User R/O
blanks boolean R/W
increments doublevector R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 356

 Centric 8 REST API DEVELOPER GUIDE

IncrementSize
Creating IncrementSize
Method: POST
URI Comments

./increment_sizes Creates a new IncrementSize object as a child of

Increment.

Reading IncrementSize
Method: GET
URI Comments

./increment_sizes/{increment_size_id} Retrieve the specified IncrementSize object.

./increment_sizes[?[skip=m][[&] Retrieves the IncrementSize objects which

match the <filter_parameters>.
limit=n][& <filter_parameters>]..]

Updating IncrementSize
Method: PUT
URI Comments

./increment_sizes/{increment_size_id} Updates the specified IncrementSize object.

Deleting IncrementSize
Method: DELETE
URI Comments

./increment_sizes/{increment_size_id} Deletes the specified IncrementSize object.

DOMAIN-ASSET RELATED APIs 357

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of IncrementSize

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
us_size string R/O
modified_by ref User R/O
increment_size ref ProductSize C/O Create only mandatory attribute
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory create only attribute.

DOMAIN-ASSET RELATED APIs 358

 Centric 8 REST API DEVELOPER GUIDE

IngredientItem
Creating IngredientItem
Method: POST
URI Comments

./food_label_data_sheet_revisions/ Creates a new IngredientItem object as a child of

{food_label_data_sheet_revision_id FoodLabelDataSheetRevision.
}/ingredients

Reading IngredientItem
Method: GET
URI Comments

./food_label_data_sheet_revisions/{food_ Retrieves the IngredientItem objects

label_data_sheet_revision_id}/ingredient referenced by FoodLabelDataSheetRevision
s[?[skip=m][[&]limit=n][&...]] which match filter parameters specified as
query string values.
./ingredient_items/{ingredient_item_id} Retrieves the specified IngredientItem object.

./ingredient_items[?[skip=m][[&]limit=n] Retrieves the IngredientItem objects which

[&...]] match <filter parameters> specified as query
string values.

Updating IngredientItem
Method: PUT
URI Comments

./ingredient_items/{ingredient_item_id} Updates the specified IngredientItem object.

Deleting IngredientItem
Method: DELETE
URI Comments

./ingredient_items/{ingredient_item_id} Deletes the specified IngredientItem object.

DOMAIN-ASSET RELATED APIs 359

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
relative_qty double R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
library_item ref FoodIngredien R/W This attribute requires
t module: FormulatedProduct to be
installed. Otherwise, it is ignored.
only_for_product_sale refset ProductSales R/W This attribute requires
s_regions Region module: FormulatedProduct to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 360

 Centric 8 REST API DEVELOPER GUIDE

InspectionErrorType
Creating InspectionErrorType
Method: POST
URI Comments

./inspection_error_types Creates a new InspectionErrorType object.

Reading InspectionErrorType
Method: GET
URI Comments

./inspection_error_types/ Retrieves the specified

{inspection_error_type_id}
./inspection_error_types[?[skip=m][[&]
limit=n][& <filter_parameters>]..]
InspectionErrorType object.
Retrieves the InspectionErrorType objects
which match the <filter_parameters>.

Updating InspectionErrorType
Method: PUT
URI Comments

./inspection_error_types/{inspecti Updates the specified InspectionErrorType object.

on_error_type_id}

Deleting InspectionErrorType
Method: DELETE
URI Comments

./inspection_error_types/{inspecti Deletes the specified InspectionErrorType object.

on_error_type_id}

DOMAIN-ASSET RELATED APIs 361

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of InspectionErrorType

Attribute Data Type Ref. Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
full_inspection boolean R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 362

 Centric 8 REST API DEVELOPER GUIDE

InspectionTestSpec
Creating InspectionTestSpec
Method: POST
URI Comments

./inspection_test_specs Creates a new InspectionTestSpec object.

Reading InspectionTestSpec
Method: GET
URI Comments

./inspection_test_specs/{inspection_test_s Retrieves the specified InspectionTestSpec

pecs_id} object.

./inspection_test_specs[?[skip=m][[&] Retrieves the InspectionTestSpec objects

which match the <filter_parameters>.
limit=n][& <filter_parameters>]..]

Updating InspectionTestSpec
Method: PUT
URI Comments

./inspection_test_specs/{inspectio Updates the specified InspectionTestSpec object.

n_test_specs_id}

Deleting InspectionTestSpec
Method: DELETE
URI Comments

./inspection_test_specs/{inspectio Deletes the specified InspectionTestSpec object.

n_test_specs_id}

DOMAIN-ASSET RELATED APIs 363

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of InspectionTestSpec

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref InspectionTest R/O
SpecRevision
latest_revision ref InspectionTest R/O
SpecRevision
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
revisions refvector InspectionTest R/O
SpecRevision
code string R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
linking_type enum C/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
tags refmap Tag R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 364

 Centric 8 REST API DEVELOPER GUIDE

InspectionTestSpecRevision
Creating InspectionTestSpecRevision
Method: POST
URI Comments

./inspection_test_spec_revisions/ Creates a new revision for the specified

InspectionTestSpecRevision object.
{inspection_test_spec_revisions_id}/revise

Reading InspectionTestSpecRevision
Method: GET
URI Comments

./inspection_test_spec_revisions/ Retrieves the specified

{inspection_test_spec_revisions_id}
./inspection_test_spec_revisions
[?[skip=m][[&]limit=n]
InspectionTestSpecRevision object.
Retrieves the InspectionTestSpecRevision
objects which match the
<filter_parameters>.

[& <filter_parameters>]..]

Updating InspectionTestSpecRevision
Method: PUT
URI Comments

./inspection_test_spec_revisions/ Updates the specified

{inspection_test_spec_revisions_id}
./inspection_test_spec_revisions/
{inspection_test_spec_revisions_id}
?action={action_name}
InspectionTestSpecRevision object.
Update the specified
InspectionTestSpecRevision object and changes
the revision state based on the actions enum list:
APPROVED, REVERT, COLD, FREEZE

Method: DELETE unsupported

InspectionTestSpecRevision is a create read, update-only

object. It does not support DELETE method.

DOMAIN-ASSET RELATED APIs 365

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of InspectionTestSpecRevision

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
bom_colorway_dependen boolean R/O This attribute requires module: AQL to
t be installed. Otherwise, it is ignored.
clarification_number integer R/O
is_current boolean R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
modified_by ref User R/O This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
pending_2_user ref User R/O
pending_user ref User R/O
phase ref _CS_Phase R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
allow_not_applicable boolean R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
description string R/W
localized_description stringmap R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
localized_name stringmap R/W
possible_points integer R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
revision_comment string R/W
apply_to_style_types reflist StyleType R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 366


Issue
Creating Issue
Method: POST
URI
./seasons/{season_id}/issues
./category1s/{category1_id}/issues
./category2s/{category2_id}/issues
./collections/{collection_id}/issues
./shapes/{shape_id}/issues
./styles/{style_id}/issues
./materials/{material_id}/issues
Reading Issue
Method: GET
URI
./seasons/{season_id}/issues[?[skip=m][[&]
limit=n][& <filter_parameters>]..]
./category1s/{category1_id}/issues[?[skip=
m][[&]limit=n][& <filter_parameters>]..]
./cagetory2s/{category2_id}/issues[?[skip=
m][[&]limit=n][& <filter_parameters>]..]
./collections/{collection_id}/issues[?[ski
p=m][[&]limit=n][& <filter_parameters>]..]
./styles/{style_id}/issues[?[skip=m][[&]li
mit=n][& <filter_parameters>]..]
./shapes/{shape_id}/issues[?[skip=m][[&]li
mit=n][& <filter_parameters>]..]
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new Issue object as a child of
Season.
Creates a new Issue object as a child of
Category1.
Creates a new Issue object as a child of
Category2.
Creates a new Issue object as a child of
Collection.
Creates a new Issue object as a child of
Shape.
Creates a new Issue object as a child of
Style.
Creates a new Issue object as a child of
Material.
Comments
Retrieves the Issue objects owned by
Season which match the
<filter_parameters> included in the
resource_path.
Retrieves the Issue objects owned by
Category1 which match the
<filter_parameters> included in the
resource_path.
Retrieves the Issue objects owned by
Category2 which match the
<filter_parameters> included in the
resource_path.
Retrieves the Issue objects owned by
Collection which match the
<filter_parameters> included in the
resource_path.
Retrieves the Issue objects owned by
Shape which match the <filter_parameters>
included in the resource_path.
367
 Centric 8 REST API DEVELOPER GUIDE

./materials/{material_id}/issues[?[skip=m] Retrieves the Issue objects owned by

[[&]limit=n][& <filter_parameters>]..] Material which match the
<filter_parameters> included in the
resource_path.
./issues/{issue_id} Retrieves the specified Issue object.

./issues[?[skip=m][[&]limit=n][& Retrieves the Issue objects which match

<filter_parameters>]..] the <filter_parameters> included in the
resource_path.

Updating Issue
Method: PUT
URI Comments

./issues/{issue_id} Updates the specified Issue object.

Deleting Issue
Method: DELETE
URI Comments

./issues/{issue_id} Deletes the specified Issue object.

DOMAIN-ASSET RELATED APIs 368

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Issue

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
status_update_date time R/O
modified_by ref User R/O
comment string R/W
description string R/W
due_date time R/W
status enum R/W
issue_product_sizes refvector ProductSize R/W
owner ref User R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 369

 Centric 8 REST API DEVELOPER GUIDE

Language
Creating Language
Method: POST
URI Comments

./languages Creates a new Issue Language object

Reading Language
Method: GET
URI Comments

./languages/{languages_id} Retrieves the specified Language object

./languages[?[skip=m][[&]limit=n][& Retrieves the Language objects which

<filter_parameters>]..] match the <filter_parameters>

Updating Language
Method: PUT
URI Comments

./languages/{languages_id} Updates the specified Language object.

Deleting Language
Method: DELETE
URI Comments

./languages/{languages_id} Deletes the specified Language object.

DOMAIN-ASSET RELATED APIs 370

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Language

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
sys_id string R/O
sort_order integer R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 371

 Centric 8 REST API DEVELOPER GUIDE

LibColorSpecification
Creating LibColorSpecification
Method: POST
URI Comments

./lib_color_specifications Creates a new LibColorSpecification object

Reading LibColorSpecification
Method: GET
URI Comments

./lib_color_specifications/ Retrieves the specified LibColorSpecification object

{lib_color_specifications_id}
./lib_color_specifications Retrieves the LibColorSpecification objects which
match the <filter_parameters>
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]

Updating LibColorSpecification
Method: PUT
URI Comments

./lib_color_specifications/ Updates the specified LibColorSpecification

object.
{lib_color_specifications_id}

Deleting LibColorSpecification
Method: DELETE
URI Comments

./lib_color_specifications/ Deletes the specified LibColorSpecification

object.
{lib_color_specifications_id}

DOMAIN-ASSET RELATED APIs 372

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of LibColorSpecification

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
elements refset ColorSpecif R/W
ication
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 373

 Centric 8 REST API DEVELOPER GUIDE

LibMaterial
Creating LibMaterial
Method: POST
URI Comments

./lib_materials Creates a new LibMaterial object

Reading LibMaterial
Method: GET
URI Comments

./lib_materials/{lib_material_id} Retrieves the specified LibMaterial object

./lib_materials Retrieves the LibMaterial objects which match the

<filter_parameters>
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]

Updating LibMaterial
Method: PUT
URI Comments

./lib_materials/{lib_material_id} Updates the specified LibMaterial object.

Deleting LibMaterial
Method: DELETE
URI Comments

./lib_materials/{lib_material_id} Deletes the specified LibMaterial object.

DOMAIN-ASSET RELATED APIs 374

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of LibMaterial

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
elements refset Material R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 375

 Centric 8 REST API DEVELOPER GUIDE

LibPrintDesign
Reading LibPrintDesign
Method: GET
URI Relative Path Comments

./lib_print_designs/{lib_print_desig Retrieve the specified LibPrintDesign object.

n_id}
./lib_print_designs[?[skip=m][[&]lim Retrieve the LibPrintDesign objects which match
it=n][&...]] <filter parameters> specified as query string values.

Attribute List of LibSizeLabel

Attribute Type Oject Read Description

Only*
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
print_designs refset R/O Display PrintDesigns for the object.
print_design_colors reflist R/O Display PrintDesignColor for the object.
modified_by ref User R/O
description string R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

* All attributes are read/only, but this column provides context as to how these attribute values would be
managed with a full CRUD API.

DOMAIN-ASSET RELATED APIs 376

 Centric 8 REST API DEVELOPER GUIDE

LibSizeLabel
Creating LibSizeLabel
Method: POST
URI Comments

./lib_size_labels Creates a new LibSizeLabel object

Reading LibSizeLabel
Method: GET
URI Comments

./lib_size_labels/{lib_size_label_id Retrieves the specified LibSizeLabel object

}
./lib_size_labels[?[skip=m][[&]limi Retrieves the LibSizeLabel objects which match the
t=n] <filter_parameters>

[& <filter_parameters>]..]

Updating LibSizeLabel
Method: PUT
URI Comments

./lib_size_labels/{lib_size_label_id Updates the specified LibSizeLabel object.

}

Deleting LibSizeLabel
Method: DELETE
URI Comments

./lib_size_labels/{lib_size_label_id Deletes the specified LibSizeLabel object.

}

DOMAIN-ASSET RELATED APIs 377

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of LibSizeLabel

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
elements refset SizeLabel R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 378

 Centric 8 REST API DEVELOPER GUIDE

Locale
Reading Locale
Method: GET
URI Comments

./localization/locales/{locale_id} Retrieves the specified Locale object

./localization/locales[?[skip=m][[& Retrieves the Locale objects which match the filter

]limit=n][& <filter_parameters>]..] parameters.

Method: POST, PUT & DELETE unsupported

Locale is a read-only object.

Attribute List of Locale

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
applied_on time R/O
modified boolean R/O
modified_by ref User R/O
active boolean R/O
date_pattern string R/O
decimal_separator string R/O
group_separator string R/O
number_separator enum R/O
time_pattern string R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 379

 Centric 8 REST API DEVELOPER GUIDE

Localization
Reading Localizable Class name information
Method: GET
URI Comments

./localization/classes Retrieves complete list of Centric objects name in

./localization/classes[?[skip=m][[&
]limit=n][& <filter_parameters>]..]
./localization/classes/{class_name}
data payload which supports localization.
Retrieves the list of Centric objects name in data
payload which match the filter parameters.
Retrieves Centric object and business name in data
payload for a specified localizable object

Example: ./localization/classes/ShippingContainer

Attribute list of Localizable Class name information

Attribute Data Type Ref. Type Read Description

Only
class_name String R/O Centric Object name
business_name String R/O The object name as displayed on
Web UI

DOMAIN-ASSET RELATED APIs 380

 Centric 8 REST API DEVELOPER GUIDE

Reading Localizable Class name, locale and attribute information

Method: GET
URI Comments

./localization/classes/{class_name} Retrieves the specified Localization class name,

/{locale} locale and its attribute information in the data
payload for the specified locale.

Attribute List of Localizable Class Name, Locale and Attribute Information

Attribute Data Type Ref. Type Read Description

Only
class_name String R/O Localized object name
locale String R/O Locale name
attributes String R/O List of attributes

Method: POST, PUT & DELETE unsupported

Localization is a read-only endpoint. It does not support

POST, PUT or DELETE methods.

DOMAIN-ASSET RELATED APIs 381

 Centric 8 REST API DEVELOPER GUIDE

LookupItem
Creating LookupItem
Method: POST
URI Comments

./lookup_items Creates a new LookupItem object

Reading LookupItem
Method: GET
URI Comments

./lookup_items/{lookup_item_id} Retrieves the specified LookupItem object

./lookup_items[?[skip=m][[&]limit=n][& Retrieves the LookupItem objects which

<filter_parameters>]..] match the <filter_parameters>

Updating LookupItem
Method: PUT
URI Comments

./lookup_items/{lookup_item_id} Updates the specified LookupItem object.

Deleting LookupItem
Method: DELETE
URI Comments

./lookup_items/{lookup_item_id} Deletes the specified LookupItem object.

DOMAIN-ASSET RELATED APIs 382

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of LookupItem

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
sys_id string R/O
modified_by ref User R/O
active boolean R/W
code string R/W
description string R/W
final_inspection_rele boolean R/W This attribute requires module: AQL to
vant be installed. Otherwise, it is ignored.
images refmap Image R/W
subtype ref LookupIte C/O
mSubtype
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

Correct way to use “optional” attribute

LookupItem is one of the class that supports optional attribute. Here is a correct way to use
optional attribute on this class.

• Go to the LookupItem business Object and add a new custom attribute “testOptional”
with optional flag set to true.

Go to the System Configuration > Setup > Configuration > Type configuration > Lookup Item
Types tab and check the custom attribute flag to true as shown in screen.

DOMAIN-ASSET RELATED APIs 383

 Centric 8 REST API DEVELOPER GUIDE

The newly created “testOptional” is supported by only one LookupItemSubType “SLIType1”.

• create LookupItem from REST API post method using SLIType1. The node will be
created with attribute "test_optional".

"node_name": "test0002",

"subtype": "centric://APPAREL/LookupItemSubtype/SLIType1",

"test_optional": "test"

If you try to create a Lookup item of any other subtype

such as SLIType2, you will receive an error.

DOMAIN-ASSET RELATED APIs 384

 Centric 8 REST API DEVELOPER GUIDE

For example if you try to create a LookupItem object with following payload:

"node_name": "test0003",

"subtype": "centric://APPAREL/LookupItemSubtype/SLIType2",

"test_optional": "test003"

You will get this exception:

Cannot change 'test_optional' on 'C2308'. Can't change field 'test_optional'

on node 'Node(C2308)'. Attribute doesn't exist.

DOMAIN-ASSET RELATED APIs 385

 Centric 8 REST API DEVELOPER GUIDE

LookupItemSubtype
Reading LookupItemSubtype
Method: GET
URI Comments

./lookup_item_subtypes/{lookup_item Retrieves the specified LookupItemSubtype object .

_subtype_id}
./lookup_item_subtypes[?[skip=m][[& Retrieves the LookupItemSubtype objects which
]limit=n][& <filter_parameters>]..] match the filter parameter.

Method: POST, PUT & DELETE unsupported

LookupItemSubtype is a read-only endpoint. It does not

support POST, PUT or DELETE methods.

Attribute List of LookupItemSubtype

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
applied_on time R/O
modified boolean R/O
published boolean R/O
setup_applied_on time R/O
setup_modified boolean R/O
modified_by ref User R/O
active boolean R/W
setup_active boolean R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 386

 Centric 8 REST API DEVELOPER GUIDE

MarketingCollection
Creating MarketingCollection
Method: POST
URI Comments

./marketing_collections Creates a new MarketingCollection object

Reading MarketingCollection
Method: GET
URI Comments

./marketing_collections/{marketing_ Retrieves the specified MarketingCollection object.

collections_id}

./marketing_collections[?[skip=m][[ Retrieves the MarketingCollection objects which

&]limit=n] match the <filter_parameters>

[& <filter_parameters>]..]

Updating MarketingCollection
Method: PUT

URI Comments

./marketing_collections/{marketing_co Updates the specified MarketingCollection object.

llections_id }

Deleting MarketingCollection
Method: DELETE
URI Comments

./marketing_collections/{marketing_c Deletes the specified MarketingCollection object.

ollections_id }

DOMAIN-ASSET RELATED APIs 387

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MarketingCollection

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
add_colorways_auto boolean R/O This attribute requires
matically module: CollectionBook to be installed.
Otherwise, it is ignored.
allow_duplicate_co boolean R/O This attribute requires
lorways module: CollectionBook to be installed.
Otherwise, it is ignored.
allow_duplicate_pr boolean R/O This attribute requires
oducts module: CollectionBook to be installed.
Otherwise, it is ignored.
cnt_documents integer R/O
comments reflist Comment R/O
documents reflist Document R/O
code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
description stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
sku_based_ordering boolean C/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
state enum R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
base_currency ref Currency C/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
currency_exchange_ ref CurrencyE R/W This attribute requires
table xchangeTa module: CollectionBook to be installed.
ble Otherwise, it is ignored.
images refmap Image R/W
referenced_documen reflist Document R/W
ts
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents out-of-the-box mandatory create only attribute.

DOMAIN-ASSET RELATED APIs 388

 Centric 8 REST API DEVELOPER GUIDE

MarketingLook
Creating MarketingLook
Method: POST
URI Comments

./marketing_looks Creates a new MarketingLook object

Reading MarketingLook
Method: GET
URI Comments

./marketing_looks/{marketing_look_id} Retrieves the specified MarketingLook object.

./marketing_looks[?[skip=m][[&]limit= Retrieves the MarketingLook objects which

n][& <filter_parameters>]..] match the <filter_parameters>

Updating MarketingLook
Method: PUT

URI Comments

./marketing_looks/{marketing_look_id} Updates the specified MarketingLook object.

Deleting MarketingLook
Method: DELETE
URI Comments

./marketing_looks/{marketing_look_id} Deletes the specified MarketingLook object.

DOMAIN-ASSET RELATED APIs 389

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MarketingLook

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.

sales_looks reflist SalesLo R/O This attribute requires

ok module: CollectionBook to be installed.
Otherwise, it is ignored.
Description stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
State enum R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.

images refmap Image R/W

look_products reflist MCProd R/W This attribute requires

uct module: CollectionBook to be installed.
Otherwise, it is ignored.

primary_collection ref Marketin R/W This attribute requires

gCollecti module: CollectionBook to be installed.
on Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 390

 Centric 8 REST API DEVELOPER GUIDE

MarketingSegment
Reading MarketingSegment
Method: GET
URI Comments

./marketing_collections/{marketing_ Retrieves the specified MarketingSegment object

collections_id}/segments[?[skip=m][ referenced by MarketingCollection which match the
[&]limit=n][& <filter_parameters>
<filter_parameters>]..]

./marketing_segments/{marketing_seg Retrieves the specified MarketingSegment object

ment_id}

./marketing_segments[?[skip=m][[&]l Retrieves the MarketingSegment objects which

imit=n][& <filter_parameters>]..] match the <filter_parameters>

Updating MarketingSegment
Method: PUT

URI Comments

./marketing_segments/{marketing_segme Updates the specified MarketingSegment object.

nt_id}

Deleting MarketingSegment
Method: DELETE
URI Comments

./marketing_segments/{marketing_segm Deletes the specified MarketingSegment object.

ent_id}

Method: POST unsupported

MarketingSegment does not support POST method.

DOMAIN-ASSET RELATED APIs 391

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MarketingSegment

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.

segment enum R/O This attribute requires

module: CollectionBook to be
installed. Otherwise, it is ignored.

modified_by ref User R/O This attribute requires

module: CollectionBook to be
installed. Otherwise, it is ignored.
description stringmap R/W This attribute requires
module: CollectionBook to be
installed. Otherwise, it is ignored.
images refmap Image R/W
segment_products refvector MCProduct R/W This attribute requires
module: CollectionBook to be
installed. Otherwise, it is ignored.

links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 392

 Centric 8 REST API DEVELOPER GUIDE

MarketingTool
Creating MarketingTool
Method: POST
URI Comments

./marketing_tools Creates a new MarketingCollection object

Reading MarketingTool
Method: GET
URI Comments

./marketing_tools/{marketing_tool_id} Retrieves the specified MarketingTool object

./marketing_tools[?[skip=m][[&]limit= Retrieves the MarketingTool objects which

n][& <filter_parameters>]..] match the <filter_parameters>

Updating MarketingTool
Method: PUT

URI Comments

./marketing_tools/{marketing_tool_id} Updates the specified MarketingTool object.

Deleting MarketingTool
Method: DELETE
URI Comments

./marketing_tools/{marketing_tool_id} Deletes the specified MarketingTool object.

DOMAIN-ASSET RELATED APIs 393

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MarketingTool

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
mt_documents refvector Document R/O This attribute requires
module: CollectionBook to be
installed. Otherwise, it is ignored.

mt_sections refvector MTSection; R/O This attribute requires

MarketingTool module: CollectionBook to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: CollectionBook to be
installed. Otherwise, it is ignored.
active boolean R/W This attribute requires
module: CollectionBook to be
installed. Otherwise, it is ignored.
localized_name stringmap R/W
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 394

 Centric 8 REST API DEVELOPER GUIDE

Material
Creating Material
Method: POST
URI Comments

./material_security_groups/{material_security Creates a new Material object as a child

_group_id}/security_group_materials of MaterialSecurityGroup.
./lib_materials/{lib_material_id}/elements Creates a new Material object as a child
of LibMaterial.
./materials Creates a new Material object.

Reading Material
Method: GET
URI Comments

./material_security_groups/{material_ Retrieves the Material objects referenced by

security_group_id}/security_group_mat
erials[?[skip=m][[&]limit=n][&<filter
_parameters>]..]
./lib_materials/{lib_material_id}/
elements[?[skip=m][[&]limit=n]
MaterialSecurityGroup and which match the filter
parameters.
Retrieves the Material objects referenced by
LibMaterial and which match the filter parameters.

[& <filter_parameters>]..]
./materials/{material_id} Retrieves the specified Material object
./materials[?[skip=m][[&]limit=n][& Retrieves the Material objects which match the
<filter_parameters>]..] <filter_parameters> included in the resource_path

Updating Material
Method: PUT
URI Comments

./materials/{material_id} Updates the specified Material object.

Updating the ProductSize of the Material

Method: PUT
URI Comments

./materials/{material_id} Updates the specified Material object’s Product Size by passing

the product_size in payload. See the example screenshot below.
This is a convenience feature as ProductSize can be updated
through ProductSize endpoint too.

DOMAIN-ASSET RELATED APIs 395

 Centric 8 REST API DEVELOPER GUIDE

Deleting Material
Method: DELETE
URI Comments

./materials/{material_id} Deletes the specified Material object.

Attribute Value Considerations

• The default_quote attribute value, if present, must reference a valid

active SupplierItem for the Material.
• The SupplierItem referenced as default_quote's product_source must belong to the
the Material.
• The current SupplierItemRevision referenced via default_quote must be in a valid
state: [DRAFT, PENDING, or APPROVED].

Attribute List of Material

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node
Locator.
_modified_at time R/O Last time this
object was

DOMAIN-ASSET RELATED APIs 396

 Centric 8 REST API DEVELOPER GUIDE

modified.
node_name string R/W Display name for
the object.
bom_main_material_count integer R/O
cnt_order integer R/O
cnt_purchased_order integer R/O
composition string R/O
earliest_target_date time R/O
is_size_owner boolean R/O
managed boolean R/O
status enum R/O
status_time time R/O
sys_id string R/O Identifier to
correlate revised
entities.
total_order_volume double R/O
total_shipment_qty double R/O
bom_main_materials refset Material R/O
bom_materials refset Material R/O
blended_costs reflist ProductBlendedCost R/O
comments reflist Comment R/O
copied_from ref Material R/O
cost_scenarios reflist CostScenario R/O
data_sheets reflist MaterialDataSheet; R/O
SpecDataSheet;
TestRun; Routing;
MaterialBOM
documents reflist Document R/O
issues reflist Issue; R/O
OperationsIssue
modified_by ref User R/O
product_colors reflist ColorMaterial R/O
product_sizes refvector ProductSize R/O
realized_products reflist SKUMaterial R/O
cnt_documents integer R/O
active boolean R/W
code string R/W Material Code
construction string R/W
default_color_size_availabil boolean R/W
ity
description string R/W
diameter string R/W
dimension string R/W
fob_calc double R/W
fob_negotiated double R/W
finish string R/W
has_season_availability boolean R/W
is_stock_managed boolean R/W
length string R/W
main_materials string R/W

DOMAIN-ASSET RELATED APIs 397

 Centric 8 REST API DEVELOPER GUIDE

ok_color_specs boolean R/W

ok_for_material_bom boolean R/W
ok_for_style_bom boolean R/W
qty_per_container double R/W
sample_cost double R/W
sourcing_model enum R/W
tags stringvect R/W
or
texture_emboss_ref string R/W
thickness string R/W
usage string R/W
weight string R/W
width string R/W
actual_size_range ref SizeRange R/W
authority_bom ref MaterialBOM R/W

care_symbols refvector CareSymbol R/W

default_color ref ColorSpecification R/W
default_quote ref SupplierItem R/W
default_size ref ProductSize R/W
images refmap Image R/W
material_compatibility reflist Material R/W
material_original_category_1 ref Category1 R/W
material_original_season ref Season R/W
product_sources refset ProductSource R/W
product_type ref MaterialType C/O
selected_blended_cost ref ProductBlendedCost R/W
technical_composition refvector MaterialComposition R/W
tooling_last reflist Material R/W
tooling_size_range ref SizeRange R/W
tooling_sizes refvector ProductSize R/W
designated_product_source ref ProductSource R/W
referenced_documents reflist Document R/W
main_material boolean R/W
crew ref Crew R/W
crew_type ref CrewType R/W
default_3d_material ref Document R/W
material_security_groups reflist MaterialSecurityGroup R/W
ok_variation_by_bom_size boolean R/W
libraries reflist LibMaterial R/W
links (_links) refmap R/O C8 Ref to URL
Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 398

 Centric 8 REST API DEVELOPER GUIDE

MaterialBOM
Creating MaterialBOM
Method: POST
URI Comments

./materials/{material_id}/data_sheets Creates a new MaterialBOM object as a child of

/material_boms Material

Reading MaterialBOM
Method: GET
URI Comments

./material_boms/{material_bom_id} Retrieves the specified MaterialBOM

./material_boms[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
./materials/{material_id}/data_sheets/materia
l_boms
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object.
Retrieves the MaterialBOM objects
which match the <filter_parameters>
Retrieves the MaterialBOM objects
referenced by Material which match
the <filter_parameters>

Updating MaterialBOM
Method: PUT

URI Comments

./material_boms/{material_bom_id} Updates the specified MaterialBOM object.

Deleting MaterialBOM
Method: DELETE
URI Comments

./material_boms/{material_bom_id} Deletes the specified MaterialBOM object.

DOMAIN-ASSET RELATED APIs 399

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialBOM

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
is_sample_bom boolean R/O
current_revision ref MaterialBOMR R/O
evision
data_sheet_samples reflist MaterialSample R/O
latest_revision ref MaterialBOMR R/O
evision
modified_by ref User R/O
revisions refvector MaterialBOMR R/O
evision
can_track_by_calendar boolean R/W
description string R/W
match_colors boolean R/W
subtype ref MaterialBOMS C/O
ubtype
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 400

 Centric 8 REST API DEVELOPER GUIDE

MaterialBOMRevision
Prior to the 7.0 release, use version V2 of these APIs. If the user is
using Centric 8 version 7.0 and above, then use version V3 of these
APIs.

Creating MaterialBOMRevision
Method: POST
URI Comments

./material_bom_revisions/ Creates a new revision of the MaterialBOMRevison

object
{material_bom_revision_id}/revise

Reading MaterialBOMRevision
Method: GET
URI Comments

./material_bom_revisions/{material_bom_revision Retrieves the specified

_id} MaterialBOMRevision object.
./material_bom_revisions[?[skip=m][[&]limit=n] Retrieves the MaterialBOMRevision
objects which match the
[&<filter_parameters>]..] <filter_parameters>

Updating MaterialBOMRevision
Method: PUT
URI Comments

./material_bom_revisions/{material_b Updates the specified MaterialBOMRevision object.

om_revision_id}
./material_bom_revisions/{material_b
om_revision_id}?action={action_name}
Updates the specified MaterialBOMRevision object
and change the revision state based on the actions
enum list: APPROVED, ABANDONED, FREEZE,
REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: Delete Unsupported

MaterialBOMRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 401

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialBOMRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
validation_status enum R/O
validation_time time R/O
approver ref User R/O
bom_main_materials refset Material R/O
bom_materials refset Material R/O
bom_product_colors refvector ColorMaterial R/O
bom_product_sizes refvector ProductSize R/O
items refvector PartMaterial; R/O
DSLineDivider
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
all_sections refvector BOMSectionD R/W
efinition
bom_main_material_co integer R/W
unt
description string R/W
main_materials string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 402

 Centric 8 REST API DEVELOPER GUIDE

MaterialBOMSubtype
Creating MaterialBOMSubtype
Method: POST
URI Comments

./material_bom_subtypes Creates the specified

MaterialBOMSubtype object.

Reading MaterialBOMSubtype
Method: GET
URI Comments

./material_bom_subtypes/ Retrieves the specified

MaterialBOMSubtype object.
{material_bom_subtype_id}

./material_bom_subtypes[?[skip=m] Retrieves the

MaterialBOMSubtype objects
[[&]limit=n][& <filter_parameters>]..] which match the
<filter_parameters>

Updating MaterialBOMSubtype
Method: PUT
URI Comments

./material_bom_subtypes/ Updates the specified

MaterialBOMSubtype object.
{material_bom_subtype_id}

Deleting MaterialBOMSubtype
Method: DELETE
URI Comments

./material_bom_subtypes/ Deletes the specified

MaterialBOMSubtype object.
{material_bom_subtype_id}

DOMAIN-ASSET RELATED APIs 403

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialBOMSubtype

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string C/O Display name for the object.
applied_on time R/O
modified boolean R/O
published boolean R/O
modified_by ref User R/O
filter_quotes_by_color boolean R/O
validate_bom boolean R/O
active boolean R/W
validation_rule_group_ string R/W
name
expose_bom_supplier_at boolean R/W
tributes
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 404

 Centric 8 REST API DEVELOPER GUIDE

MaterialComposition
Creating MaterialComposition
Method: POST
URI Comments

./materials/{material_id}/technical Creates a new MaterialComposition object as a child

_compositions ** see next page of Material with specific id.
./theme_masters/{theme_masters_id}/ Creates a new MaterialComposition object as a child
technical_compositions of ThemeMaster with specific id

Reading MaterialComposition
Method: GET
URI Comments

./material_compositions/{material_composition_id} Retrieves the specified

MaterialComposition object.
./material_compositions[?[skip=m][[&]limit=n][& Retrieves the
<filter_parameters>]..] MaterialComposition objects which
match the <filter_parameters>
./materials/{material_id}/technical_compositions[ Retrieves the
?[skip=m][[&]limit=n][& <filter_parameters>]..] MaterialComposition objects
referenced by Material which
match the <filter_parameters>
./theme_masters/{theme_masters_id}/technical_comp Retrieves all MaterialComposition
ositions objects referenced by
ThemeMaster with a specific id

Updating MaterialComposition
Method: PUT
URI Comments

./materials/{material_id}/technica Update MaterialComposition objects referenced by

l_compositions ## see next page Material with a specific id
./theme_masters/{theme_masters_id} Update MaterialComposition objects referenced by
/technical_compositions ThemeMaster with a specific id

DOMAIN-ASSET RELATED APIs 405

 Centric 8 REST API DEVELOPER GUIDE

Deleting MaterialComposition
Method: DELETE
URI Comments

./material_compositions/{material_ Deletes the specified MaterialComposition object as a child

composition_id} of Material.
./theme_masters/{theme_masters_id} Deletes the specified MaterialComposition object as a child
/technical_compositions of ThemeMaster.

Attribute list of MaterialComposition

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.

modified_by ref User R/O

percentage float R/W
composition ref Composition R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser

** POST /materials/{material_id}/technical_compositions Now accepts multiple object in an

array to create multiple MaterialComposition objects in a single REST call. An example of
payload which will create two MaterialComposition objects is as follows:
[
{
"percentage": 70,
"composition": "C1429"
},
{
"percentage": 30,
"composition": "C1428"
}
]

## PUT /materials/{material_id}/technical_compositions Now accepts multiple object payload

in an array to update multiple MaterialComposition objects in a single REST call. An example
of payload which will update two MaterialComposition objects is as follows:
{
"C1602" : { "percentage": 70, "composition": "C1702 },
"C1603" : { "percentage": 30, "composition": "C1429" }
}

DOMAIN-ASSET RELATED APIs 406

 Centric 8 REST API DEVELOPER GUIDE

MaterialDataSheet
Creating MaterialDataSheet
Method: POST
URI Comments

./materials/{material_id}/data_sheets Creates a new MaterialDataSheet object as

a child of Material.
/material_data_sheets

Reading MaterialDataSheet
Method: GET
URI Comments

./materials/{material_id}/data_sheets/ Retrieves the MaterialDataSheet objects

referenced by Material which match the
material_data_sheets[?[skip=m][[&]limit=n] filter parameters.
[&...]]

./material_data_sheets/{material_data_shee Retrieves the specified MaterialDataSheet

t_id} object.
./material_data_sheets[?[skip=m][[&] Retrieves the MaterialDataSheet objects
which match the <filter_parameters>.
limit=n][& <filter_parameters>]..]

Updating MaterialDataSheet
Method: PUT
URI Comments

./material_data_sheets/{material_dat Updates the specified MaterialDataSheet object.

a_sheet_id}

Deleting MaterialDataSheet
Method: DELETE
URI Comments

./material_data_sheets/{material_data Deletes the specified MaterialDataSheet object.

_sheet_id}

DOMAIN-ASSET RELATED APIs 407

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialDataSheet

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
current_revision ref MaterialDataShe R/O
etRevision
data_sheets refvector ColorDataSheet R/O
latest_revision ref MaterialDataShe R/O
etRevision
modified_by ref User R/O
revisions refvector MaterialDataShe R/O
etRevision
can_track_by_calendar boolean R/W
description string R/W
sub_type enum R/W
subtype ref MaterialDataShe C/O
etSubtype
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 408

 Centric 8 REST API DEVELOPER GUIDE

MaterialDataSheetRevision
Creating MaterialDataSheetRevision
Method: POST
URI Comments

./material_data_sheet_revisions/ Creates a revision for the specified

MaterialDataSheetRevision object.
{material_data_sheet_revision_id}/revise

Reading MaterialDataSheetRevision
Method: GET
URI Comments

./material_data_sheet_revisions/ Retrieves the specified

{material_data_sheet_revision_id}
./material_data_sheet_revisions
[?[skip=m][[&]limit=n]
MaterialDataSheetRevision object.
Retrieves the MaterialDataSheetRevision
objects which match the
<filter_parameters>.

[&<filter_parameters>]..]

Updating MaterialDataSheetRevision
Method: PUT
URI Comments

./material_data_sheet_revisions/ Updates the specified MaterialDataSheetRevision

{material_data_sheet_revision_id}
./material_data_sheet_revisions/
{material_data_sheet_revision_id}
?action={action_name}
object.
Update the specified MaterialDataSheetRevision
object and changes the revision state based on the
actions enum list: APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

MaterialDataSheetRevision is a create read, update-only

object. It does not support DELETE method.

DOMAIN-ASSET RELATED APIs 409

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref MaterialDataS R/O
heetRevision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
data_sheet_type enum R/W
description string R/W
styles reflist Style R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 410

 Centric 8 REST API DEVELOPER GUIDE

MaterialPlanPlacement
Creating MaterialPlanPlacement
Method: POST
URI Comments

./themes/{theme_id}/items/ Creates a new MaterialPlanPlacement object as a

material_plan_placements child of Theme

Reading MaterialPlanPlacement
Method: GET
URI Comments

./material_plan_placements/{material_plan_placeme Retrieves the specified

nts_id} MaterialPlanPlacement object.
./material_plan_placements[?[skip=m][[&]limit=n][ Retrieves the
& <filter_parameters>]..] MaterialPlanPlacement objects
which match the
<filter_parameters>
./themes/{theme_id}/items/ Retrieves the
material_plan_placements[?[skip=m][[&]limit=n][& MaterialPlanPlacement objects
<filter_parameters>]..] referenced by Theme which match
the <filter_parameters>

Updating MaterialPlanPlacement
Method: PUT

URI Comments

./material_plan_placements/{materi Updates the specifiedMaterialPlanPlacement object.

al_plan_placements_id}

Deleting MaterialPlanPlacement
Method: DELETE
URI Comments

./material_plan_placements/{materi Deletes the specified MaterialPlanPlacement object.

al_plan_placements_id}

DOMAIN-ASSET RELATED APIs 411

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialPlanPlacement

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
for_part_materials reflist PartMaterial R/O
modified_by ref User R/O
per_colorway reflist MaterialPlan R/O
PlacementCo
lorway
comment string R/W
description string R/W
main_material boolean R/W
material_name string R/W
qty_common double R/W
actual ref Material R/W
ds_section ref BOMSection R/W
Definition
mpp_color ref ColorMaterial R/W
mpp_color_spec ref ColorSpecific R/W
ation
mpp_quote ref SupplierItem R/W
mpp_request ref SupplierRequ R/W This attribute requires
est module: MaterialSpecSourcing to
be installed. Otherwise, it is
ignored.
mpp_size ref ProductSize R/W
only_for_product_alter refset ThemeProdu R/W
natives ctAlternative
original ref Material R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 412

 Centric 8 REST API DEVELOPER GUIDE

MaterialPlanPlacementColorway
Reading MaterialPlanPlacementColorway
Method: GET
URI Comments

./material_plan_placements/ Retrieves the

MaterialPlanPlacementColorway
{material_plan_placements_id}/per_colorway/ object referenced by
MaterialPlanPlacement which
material_plan_placement_colorways[?[skip match filter parameters specifiedas
=m][[&]limit=n][&...]] query string values.
./material_plan_placements/ Retrieves the specified
MaterialPlanPlacementColorway
{material_plan_placements_id} object.
./material_plan_placements[?[skip=m] Retrieves the
MaterialPlanPlacementColorway
[[&]limit=n][&...]] objects which match the
<filter_parameters>

Updating MaterialPlanPlacementColorway
Method: PUT

URI Comments

./material_plan_placements/{materi Updates the specifiedMaterialPlanPlacementColorway

al_plan_placements_id} object.

Method: POST and DELETE are unsupported

This is a read-update only endpoint. POST or DELETE

methods and unsupported.

DOMAIN-ASSET RELATED APIs 413

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialPlanPlacementColorway

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
mpc_colorway ref ColorColorwayContext R/O
modified_by ref User R/O
mpc_color ref ColorMaterial R/W
mpc_color_spec ref ColorSpecification R/W
mpc_material ref Material R/W
mpc_quote ref SupplierItem R/W
mpc_request ref SupplierRequest R/W This attribute requires
module: MaterialSpecSourcing to
be installed. Otherwise, it is
ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 414

 Centric 8 REST API DEVELOPER GUIDE

MaterialSample
Creating MaterialSample
Method: POST
URI Comments

./product_sources/{product_source_id}/material Creates a new MaterialSample object

_samples as a child of ProductSource.

Reading MaterialSample
Method: GET
URI Comments

./product_sources/{product_source_id}/materia Retrieves the specified MaterialSample

l_samples[?[skip=m][[&]limit=n][&<filter_para
meters>]..]
./materials/{material_id}
./materials[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object referenced by ProductSource
and matches the <filter_parameters>
Retrieves the specified MaterialSample
object.
Retrieves the MaterialSample objects
which match the <filter_parameters>
included in the resource_path.

Updating MaterialSample
Method: PUT
URI Comments

./material_samples/{material_sample_id} Updates the specified MaterialSample object.

Deleting MaterialSample
Method: DELETE
URI Comments

./material_samples/{material_sample_id} Deletes the specified MaterialSample object.

DOMAIN-ASSET RELATED APIs 415

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialSample

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
storage_bin_number string R/O
storage_name string R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
sample_sr_line_item ref SRLineItem R/O
cnt_documents integer R/O
description string R/W
request_number string R/W
requested_qty double R/W
sample_notes string R/W
sample_received_date time R/W
sample_review_date time R/W
sample_status enum R/W
sample_type enum R/W
supplier_material_code string R/W
product_color ref ColorMaterial R/W
product_size ref ProductSize R/W
responsible_users reflist User R/W
sample_factory ref Factory R/W
season ref Season R/W
images refmap Image R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 416

 Centric 8 REST API DEVELOPER GUIDE

MaterialSecurityGroup
Creating MaterialSecurityGroup
Method: POST
URI Comments

./material_security_groups Creates a new MaterialSecurityGroup object.

Reading MaterialSecurityGroup
Method: GET
URI Comments

./material_security_groups/ Retrieves the specified MaterialSecurityGroup

{material_security_group_id}
./material_security_groups[?[skip=m]
[[&]limit=n][&
<filter_parameters>]..]
object referenced by ProductSource and matches
the <filter_parameters>
Retrieves the MaterialSecurityGroup objects which
match the filter parameters.

Updating MaterialSecurityGroup
Method: PUT
URI Comments

./material_security_groups/ Updates the specified

MaterialSecurityGroupobject.
{material_security_group_id}

Deleting MaterialSecurityGroup
Method: DELETE
URI Comments

./material_security_groups/ Deletes the specified

MaterialSecurityGroupobject.
{material_security_group_id}

DOMAIN-ASSET RELATED APIs 417

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialSecurityGroup

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
calendar reflist Calendar R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
master_calendars reflist MasterCalen R/W This attribute requires
dar module: Calendar to be
installed. Otherwise, it is
ignored.
crew ref Crew R/W
crew_type ref CrewType R/W
calendar_materials reflist Material R/W
for_online_suppliers reflist Supplier R/W
only_for_material_types reflist MaterialType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 418

 Centric 8 REST API DEVELOPER GUIDE

MaterialType
Creating MaterialType
Method: POST
URI Comments

./material_types Creates a new MaterialType object.

Reading MaterialType
Method: GET
URI Comments

./material_types/{material_type_id} Retrieves the specified MaterialType

object.
./material_types[?[skip=m][[&]limit=n][& Retrieves the MaterialType objects which
<filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating MaterialType
Method: PUT
URI Comments

./material_types/{material_type_id} Updates the specified MaterialType object.

Deleting MaterialType
Method: DELETE
URI Comments

./material_types/{material_type_id} Deletes the specified MaterialType object.

DOMAIN-ASSET RELATED APIs 419

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MaterialType

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string C/O Display name for the object.
published boolean R/O
modified_by ref User R/O
available boolean R/W
has_color boolean R/W
has_size boolean R/W
material_usage enum R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 420

 Centric 8 REST API DEVELOPER GUIDE

MCMaterial
Creating MCMaterial
Method: POST
URI Comments

./marketing_collections/{marketing_collection_ Creates a new MCMaterial object as a

id}/materials/mc_materials child of MarketingCollection.

Reading MCMaterial
Method: GET
URI Comments

./marketing_collections/{marketing_collection Retrieves the specified MCMaterial

_id}/materials/mc_materials
[?[skip=m][[&]limit=n][&<filter_parameters>].
.]
./mc_materials/{mc_material_id}
./mc_materials[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object referenced by
MarketingCollection and matches the
<filter_parameters>
Retrieves the specified MCMaterial
object.
Retrieves the MCMaterial objects which
match the <filter_parameters> included
in the resource_path.

Updating MCMaterial
Method: PUT
URI Comments

./mc_materials/{mc_material_id} Updates the specified MCMaterial object.

Deleting MCMaterial
Method: DELETE
URI Comments

./mc_materials/{mc_material_id} Deletes the specified MCMaterial object.

DOMAIN-ASSET RELATED APIs 421

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MCMaterial

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
colors reflist MCMaterialColor R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
cnt_documents integer R/O
code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
composition stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
description stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
images refmap Image R/W
mc_material ref Material R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
mc_material_type ref MaterialType C/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
referenced_docum reflist Document R/W
ents
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute for object creation.

DOMAIN-ASSET RELATED APIs 422

 Centric 8 REST API DEVELOPER GUIDE

MCMaterialColor
Reading MCMaterialColor
Method: GET
URI Comments

./mc_materials/{mc_material_id}/co Retrieves the specified MCMaterialColor object

lors/ referenced by MCMaterial which matches the filter
parameters.
mc_material_colors[?[skip=m][[&]li
mit=n][&...]]

./mc_material_colors/{mc_material_ Retrieves the specified MCMaterialColor objects

color_id}

./mc_material_colors[?[skip=m][[&] Retrieves the specified MCMaterialColor object which

limit=n][&...]] matches the filter parameters.

Updating MCMaterialColor
Method: PUT
URI Comments

./mc_material_colors/{mc_material_col Updates the specified MCMaterialColor object.

or_id}

Method: POST & DELETE are unsupported

MCMaterialColor is a create-update only endpoint. It does

not support POST or DELETE methods.

DOMAIN-ASSET RELATED APIs 423

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MCMaterialColor

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
images refmap Image R/W
mc_color_material ref ColorMate R/W This attribute requires
rial module: CollectionBook to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 424

 Centric 8 REST API DEVELOPER GUIDE

MCProduct
Creating MCProduct
Method: POST
URI Comments

./marketing_collections/{marketing_collection_ Creates a new MCProduct object as a

id}/products/mc_products child of MarketingCollection.

Reading MCProduct
Method: GET
URI Comments

./marketing_collections/{marketing_collection Retrieves the specified MCProduct

_id}/products/mc_products[?[skip=m][[&]limit=
n][&<filter_parameters>]..]
./mc_products/{mc_product_id}
./mc_products[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object referenced by
MarketingCollection and matches the
<filter_parameters>
Retrieves the specified MCProduct
object.
Retrieves the MCProduct objects which
match the <filter_parameters> included
in the resource_path.

Updating MCProduct
Method: PUT
URI Comments

./mc_products/{mc_product_id} Updates the specified MCProduct object.

Deleting MCProduct
Method: DELETE
URI Comments

./mc_products/{mc_product_id} Deletes the specified MCProduct object.

DOMAIN-ASSET RELATED APIs 425

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MCProduct

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
sales_volume integer R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
colors reflist MCProductColor R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
comments reflist Comment R/O
documents reflist Document R/O
mc_product_skus reflist MCProductSKU R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
mc_product_segment ref MarketingSegment R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
description stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
marketing_segment enum R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
model_code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
retail_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
state enum R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
wholesale_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.

DOMAIN-ASSET RELATED APIs 426

 Centric 8 REST API DEVELOPER GUIDE

brands refvector ProductSymbol R/W This attribute requires

module: CollectionBook to be installed.
Otherwise, it is ignored.
features refvector ProductSymbol R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
images refmap Image R/W
mc_product_sizes refvector ProductSize R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
mc_size_range ref SizeRange R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
main_material ref MCMaterial R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
product_style ref Style R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
product_style_type ref StyleType R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute for object creation.

DOMAIN-ASSET RELATED APIs 427


MCProductColor
Creating MCProductColor
Method: POST
URI
./mc_products/{mc_product_id}/colors/
mc_product_colors
Reading MCProductColor
Method: GET
URI
./mc_products/{mc_product_id}/colors/
mc_product_colors[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./mc_product_colors/{mc_product_color_id}
./mc_product_colors[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
Updating MCProductColor
Method: PUT
URI
./mc_product_colors/{mc_product_color_id}
Deleting MCProductColor
Method: DELETE
URI
./mc_product_colors/{mc_product_color_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new MCProductColor object as a child
of MCProduct.
Comments
Retrieves the specified MCProductColor
object referenced by MCProduct and
matches the <filter_parameters>
Retrieves the specified MCProductColor
object.
Retrieves the MCProductColor objects
which match the <filter_parameters>
included in the resource_path.
Comments
Updates the specified MCProductColor
object.
Comments
Deletes the specified MCProductColor
object.
428
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MCProductColor

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
sales_volume integer R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
state enum R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
code string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
description stringmap R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
localized_name stringmap R/W
retail_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
wholesale_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
images refmap Image R/W
main_material_color ref MCMaterialColor R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
pc_colorway ref Colorway R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
mass_copy boolean R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 429

 Centric 8 REST API DEVELOPER GUIDE

MCProductSKU
Creating MCProductSKU
Method: POST
URI Comments

./mc_products/{mc_product_id}/mc_product_skus Creates a new MCProductSKU object

as a child of MCProduct.

Reading MCProductSKU
Method: GET
URI Comments

./mc_products/{mc_product_id}/mc_product_skus Retrieves the specified MCProductSKU

[?[skip=m][[&]limit=n][&<filter_parameters>].
.]
./mc_product_skus/{mc_product_sku_id}
./mc_product_skus[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
object referenced by MCProduct and
matches the <filter_parameters>
Retrieves the specified MCProductSKU
object.
Retrieves the MCProductSKU objects
which match the <filter_parameters>
included in the resource_path.

Updating MCProductSKU
Method: PUT
URI Comments

./mc_product_skus/{mc_product_sku_id} Updates the specified MCProductSKU

object.

Deleting MCProductSKU
Method: DELETE
URI Comments

./mc_product_skus/{mc_product_sku_id} Deletes the specified MCProductSKU object.

DOMAIN-ASSET RELATED APIs 430

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MCProductSKU

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
state enum R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
color ref MCProductColor R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
line_items_sku reflist SalesOrderLineItemSKU R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
product_size ref ProductSize R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
retail_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
wholesale_price double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
sku ref SKU C/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 431

 Centric 8 REST API DEVELOPER GUIDE

MerchCollection
Creating MerchCollection
Method: POST
URI Relative Path Comments

./merch_folders/{merch_folder_id}/children Creates a new MerchCollection object

as a child of MerchFolder.

Reading MerchCollection
Method: GET
URI Relative Path Comments

./merch_folders/{merch_folder_id}/children[?[ Retrieves the MerchCollection objects

skip=m][[&]limit=n][&...]]
./merch_collections/{merch_collection_id}
./merch_collections[?[skip=m][[&]limit=n][&..
.]]
referenced by MerchFolder which
match filter parameters specified as
query string values.
Retrieves the specified MerchCollection
object.
Retrieves the MerchCollection objects
which match <filter parameters>
specified as query string values.

Updating MerchCollection
Method: PUT
U URI Relative Path RI Comments

./merch_collections/{merch_collection_id} Updates the specified MerchCollection

object.

Deleting MerchCollection
Method: DELETE
URI Relative Path Comments

./merch_collections/{merch_collection_id} Deletes the specified MerchCollection object.

DOMAIN-ASSET RELATED APIs 432

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
children reflist MerchProduct R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
folders refvect MerchFolder R/O This attribute requires
or module: Merchandising to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan ref MerchPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
__parent__ ref MerchFolder R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondaries reflist MerchSecondary R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchCollectionSubtype C/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchCollectionVersion R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.
season ref MerchSeason R/W This attribute refers to
MerchSeason in MerchPlan.
Note: When creating
MerchCollection, season attribute
can only refer to existing
MerchSeason that is under
MerchPlan.

• ** - This attribute is required when creating a new MerchCollection object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 433

 Centric 8 REST API DEVELOPER GUIDE

MerchFolder
Creating MerchFolder
Method: POST
URI Relative Path Comments

./merch_plans/{merch_plan_id}/children Creates a new MerchFolder object as a

child of MerchPlan.
./merch_folders/{merch_folder_id}/folders Creates a new MerchFolder object as a
child of MerchFolder.

Reading MerchFolder
Method: GET
URI Relative Path Comments

./merch_plans/{merch_plan_id}/children[?[ Retrieves the MerchFolder objects

skip=m][[&]limit=n][&...]]
./merch_folders/{merch_folder_id}/folders
[?[skip=m][[&]limit=n][&...]]
./merch_folders/{merch_folder_id}
./merch_folders[?[skip=m][[&]limit=n][&..
.]]
referenced by MerchPlan which match filter
parameters specified as query string values.
Retrieves the MerchFolder objects
referenced by MerchFolder which match
filter parameters specified as query string
values.
Retrieves the specified MerchFolder object.
Retrieves the MerchFolder objects which
match <filter parameters> specified as query
string values.

Updating MerchFolder
Method: PUT
URI Relative Path Comments

./merch_folders/{merch_folder_id} Updates the specified MerchFolder object.

Deleting MerchFolder
Method: DELETE
URI Relative Path Comments

./merch_folders/{merch_folder_id} Deletes the specified MerchFolder object.

DOMAIN-ASSET RELATED APIs 434

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
children reflist MerchCollection; R/O This attribute requires
MerchFolder module: Merchandising to be
installed. Otherwise, it is ignored.
collections reflist MerchCollection R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
crew ref Crew R/O
crew_type ref CrewType R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
folders refvect MerchFolder R/O This attribute requires
or module: Merchandising to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan ref MerchPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
parent ref MerchFolder R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondaries reflist MerchSecondary R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchFolderSubtype C/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchFolderVersion R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.
season ref Season R/W This attribute refers to
MerchSeason in MerchFolder

• ** - This attribute is required when creating a new MerchFolder object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 435


MerchLevel
Creating MerchPlan and MerchLevel
Below APIs are deprecated from 7.4.
Method: POST
URI
./merch_levels
./merch_levels/{merch_level_id}
Reading Merchandise related objects
Method: GET
URI
./merch_levels/{merch_level_id}
./merch_levels[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./merch_levels/{merch_level_id}/
children[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
./merch_levels/{merch_level_id}/
versions[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new MerchPlan.
Creates a new MerchLevel child for the specified MerchLevel
parent.
Comments
Retrieves the specified MerchPlan, MerchFolder,
MerchCollection, MerchOption, MerchProduct or
MerchSecondary object.
Retrieve the MerchPlan, MerchFolder, MerchCollection,
MerchOption, MerchProduct or MerchSecondary objects
which match the class name specified in the header
parameter "class_name" and <filter parameters>
specified as query string values.
List all MerchLevel's children of the MerchLevel with
specified id.
List all MerchVersions of the MerchLevel with specified
id.
436
 Centric 8 REST API DEVELOPER GUIDE

Updating MerchLevel
Method: PUT
URI Comments

./merch_levels/{merch_level_id} Updates the specified MerchPlan, MerchFolder,

MerchCollection, MerchOption, MerchProduct or
MerchSecondary object.

Deleting MerchLevel
Method: DELETE
URI Comments

./merch_levels/{merch_level_id} Deletes the specified MerchPlan, MerchFolder,

MerchCollection, MerchOption, MerchProduct or
MerchSecondary object.

DOMAIN-ASSET RELATED APIs 437

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MerchLevel

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
children reflist MerchCollection; R/O This attribute requires
MerchFolder module: Merchandising to be installed.
Otherwise, it is ignored.
folders refvect MerchFolder R/O This attribute requires
or module: Merchandising to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
collections reflist MerchCollection R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
plan ref MerchPlan R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
secondaries reflist MerchSecondary R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
subtype ref MerchFolderSubtype C/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
versions reflist MerchFolderVersion R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 438

 Centric 8 REST API DEVELOPER GUIDE

MerchLevelSubtype
Creating MerchLevelSubtype
Method: POST
URI Comments

./merch_level_subtypes A POST of a MerchLevelSubtype requires a name value

pair in the headers. The name must be “class_name” the
value must be one of:
• “MerchFolderSubtype”
• “MerchPlanSubtype”
• “MerchCollectionSubtype”
• “MerchProductSubtype”
• “MerchOptionSubtype”
• “MerchSecondaryPlanSubtype”

Reading MerchLevelSubtype
Method: GET
URI Comments

./merch_level_subtypes[?[skip=m] A GET (many) of a MerchLevelSubtype requires a name

value pair in the headers. The name must be
“class_name” the value must be one of:
[[&]limit=n][&<filter_parameters>]..]
• “MerchFolderSubtype”
• “MerchPlanSubtype”
• “MerchCollectionSubtype”
• “MerchProductSubtype”
• “MerchOptionSubtype”
• “MerchSecondaryPlanSubtype”

./merch_level_subtypes/{merch_level_s A GET (single) of a MerchLevelSubtype requires a name

ubtype_id} value pair in the headers. The name must be
“class_name” the value must be one of:

• “MerchFolderSubtype”
• “MerchPlanSubtype”
• “MerchCollectionSubtype”
• “MerchProductSubtype”
• “MerchOptionSubtype”
• “MerchSecondaryPlanSubtype”

The value must match that of the

{merch_level_subtype_id} given in the url.

DOMAIN-ASSET RELATED APIs 439

 Centric 8 REST API DEVELOPER GUIDE

Updating MerchLevelSubtype
Method: PUT
URI Comments

./merch_level_subtypes/{merch_level_s A PUT of a MerchLevelSubtype requires a name value

ubtype_id} pair in the headers. The name must be “class_name” the
value must be one of:

• “MerchFolderSubtype”
• “MerchPlanSubtype”
• “MerchCollectionSubtype”
• “MerchProductSubtype”
• “MerchOptionSubtype”
• “MerchSecondaryPlanSubtype”

The value must match that of the

{merch_level_subtype_id} given in the url.

Deleting MerchLevelSubtype
Method: DELETE
URI Comments

./merch_level_subtypes/{merch_level_s A DELETE of a MerchLevelSubtype requires a name

ubtype_id} value pair in the headers. The name must be
“class_name” the value must be one of:

• “MerchFolderSubtype”
• “MerchPlanSubtype”
• “MerchCollectionSubtype”
• “MerchProductSubtype”
• “MerchOptionSubtype”
• “MerchSecondaryPlanSubtype”

The value must match that of the

{merch_level_subtype_id} given in the url.

DOMAIN-ASSET RELATED APIs 440

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MerchLevelSubtype

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string C/O Display name for the object.
applied_on time R/O
is_material boolean R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
is_style boolean R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
modified boolean R/O
published boolean R/O
modified_by ref User R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
active boolean R/W
children_subtypes reflist MerchOptionSubtype R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
style_push_templa reflist StylePushTemplate R/W This attribute requires
tes module: Merchandising to be installed.
Otherwise, it is ignored.
style_types reflist StyleType R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

Examples:

API should work for the following classes:

1. MerchFolderSubtype
2. MerchPlanSubtype
3. MerchOptionSubtype
4. MerchProductSubtype
5. MerchCollectionSubtype
6. MerchSecondaryPlanSubtype

Get all MerchLevelSubtype for the given class.

DOMAIN-ASSET RELATED APIs 441

 Centric 8 REST API DEVELOPER GUIDE

curl -X GET "http://<server>/api/v2/merch_level_subtypes?skip=0&limit=10" -H

"accept: application/json" -H "class_name: MerchFolderSubtype"

Note that the class_name is required in the header.

1. Create MerchLevelSubtype for the given class MerchFolderSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchFolderSubtype" -H "Content-Type: application/json" -d "{
"active": true, "node_name": "aaaa", "auto_create_crew": true,
"children_folder_subtypes": [ "centric://MERCH/CONF/MerchFolderSubtype/TH
CHW Gender", "centric://MERCH/CONF/MerchFolderSubtype/CK ACC Lifestyle" ],
"children_collection_subtypes": [
"centric://MERCH/CONF/MerchCollectionSubtype/TH WSW" ]}"

2. Create MerchLevelSubtype for the given class MerchOptionSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchOptionSubtype" -H "Content-Type: application/json" -d "{
"node_name": "MerchOptionSubtype-test01", "active": true}"

DOMAIN-ASSET RELATED APIs 442

 Centric 8 REST API DEVELOPER GUIDE

3. Create MerchLevelSubtype for the given class MerchPlanSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchPlanSubtype" -H "Content-Type: application/json" -d "{
"node_name": "MerchPlanSubtype-test01", "active": true, "auto_create_crew":
true, "children_subtypes": [ "centric://MERCH/CONF/MerchFolderSubtype/CK ACC
Lifestyle", "centric://MER

4. Create MerchLevelSubtype for the given class MerchProductSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchProductSubtype" -H "Content-Type: application/json" -d "{
"node_name": "MerchProductSubtype-test01", "active": true,
"children_subtypes": [ "centric://MERCH/CONF/MerchOptionSubtype/TH CHW" ],
"style_types": [ "centric://APPAREL/StyleType/Assortment",
"centric://APPAREL/StyleType/Default",
"centric://APPAREL/StyleType/DefaultTDS",
"centric://APPAREL/StyleType/NoColorNoSize"]}"

DOMAIN-ASSET RELATED APIs 443

 Centric 8 REST API DEVELOPER GUIDE

5. Create MerchLevelSubtype for the given class MerchCollectionSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchCollectionSubtype" -H "Content-Type: application/json" -d
"{ "node_name": "MerchCollectionSubtype-test01", "active": true,
"children_subtypes": [ "centric://MERCH/CONF/MerchProductSubtype/CK ACC" ]}"

6. Create MerchLevelSubtype for the given class MerchCollectionSubtype

curl -X POST "http://localhost:8080/csi-

requesthandler/api/v2/merch_level_subtypes" -H "accept: application/json" -H
"class_name: MerchSecondaryPlanSubtype" -H "Content-Type: application/json"
-d "{ "node_name": "MerchSecondaryPlanSubtype-test01", "active": true }"

DOMAIN-ASSET RELATED APIs 444

 Centric 8 REST API DEVELOPER GUIDE

MerchOption
Creating MerchOption
Method: POST
URI Relative Path Comments

./merch_products/{merch_product_id}/childre Creates a new MerchOption object as a

n child of MerchProduct.

Reading MerchOption
Method: GET
URI Relative Path Comments

./merch_products/{merch_product_id}/child Retrieves the MerchOption objects

ren[?[skip=m][[&]limit=n][&...]] referenced by MerchProduct which match
filter parameters specified as query string
values.
./merch_options/{merch_option_id} Retrieves the specified MerchOption object.

./merch_options[?[skip=m][[&]limit=n][&.. Retrieves the MerchOption objects which

.]] match <filter parameters> specified as query
string values.

Updating MerchOption
Method: PUT
URI Relative Path Comments

./merch_options/{merch_option_id} Updates the specified MerchOption object.

Deleting MerchOption
Method: DELETE
URI Relative Path Comments

./merch_options/{merch_option_id} Deletes the specified MerchOption object.

DOMAIN-ASSET RELATED APIs 445

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan ref MerchPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondaries reflist MerchSecondary R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchOptionVersion R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchOptionSubtype C/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new MerchOption object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 446

 Centric 8 REST API DEVELOPER GUIDE

MerchPlan
Creating MerchPlan
Method: POST
URI Relative Path Comments

./merch_plans Creates a new MerchPlan object.

Reading MerchPlan
Method: GET
URI Relative Path Comments

./merch_plans/{merch_plan_id} Retrieves the specified MerchPlan object.

./merch_plans[?[skip=m][[&]limit=n][&...] Retrieves the MerchPlan objects which

] match <filter parameters> specified as query
string values.

Updating MerchPlan
Method: PUT
URI Relative Path Comments

./merch_plans/{merch_plan_id} Updates the specified MerchPlan object.

Deleting MerchPlan
Method: DELETE
URI Relative Path Comments

./merch_plans/{merch_plan_id} Deletes the specified MerchPlan object.

DOMAIN-ASSET RELATED APIs 447

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
children reflist MerchFolder R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
crew ref Crew R/O
crew_type ref CrewType R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondaries reflist MerchSecondaryPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchSeason R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
show_all_seconda boolea R/W This attribute requires
ries n module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchPlanSubtype C/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.
season ref MerchSeason R/W This attribute refers to
Merchseason in MerchPlan.
Note: When season attribute is
not passed while creating
MerchPlan, a season object is
automatically created with the
name as “Sample Season”

• ** - This attribute is required when creating a new MerchPlan object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 448

 Centric 8 REST API DEVELOPER GUIDE

MerchProduct
Creating MerchProduct
Method: POST
URI Relative Path Comments

./merch_collections/{merch_collection_id}/c Creates a new MerchProduct object as a

hildren child of MerchCollection.

Reading MerchProduct
Method: GET
URI Relative Path Comments

./merch_collections/{merch_collection_i Retrieves the MerchProduct objects referenced

d}/children[?[skip=m][[&]limit=n][&...] by MerchCollection which match filter
] parameters specified as query string values.
./merch_products/{merch_product_id} Retrieves the specified MerchProduct object.
./merch_products[?[skip=m][[&]limit=n][ Retrieves the MerchProduct objects which
&...]] match <filter parameters> specified as query
string values.

Updating MerchProduct
Method: PUT
URI Relative Path Comments

./merch_products/{merch_product_id} Updates the specified MerchProduct object.

Deleting MerchProduct
Method: DELETE
URI Relative Path Comments

./merch_products/{merch_product_id} Deletes the specified MerchProduct object.

DOMAIN-ASSET RELATED APIs 449

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
children reflist MerchOption R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan ref MerchPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
parent ref MerchCollection R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondaries reflist MerchSecondary R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchProductSubtype C/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchProductVersion R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.
season ref MerchSeason R/W This attribute refers to
MerchSeason in MerchPlan.

• ** - This attribute is required when creating a new MerchProduct object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 450

 Centric 8 REST API DEVELOPER GUIDE

MerchSeason
Creating MerchSeason
Method: POST
URI Relative Path Comments

./merch_plans/{merch_plan_id}/versions Creates a new MerchSeason object as a child

of MerchPlan.

Reading MerchSeason
Method: GET
URI Relative Path Comments

./merch_plans/{merch_plan_id}/versions[ Retrieves the MerchSeason objects referenced

?[skip=m][[&]limit=n][&...]]
./merch_versions/{merch_season_id}
./merch_versions[?[skip=m][[&]limit=n][
&...]]
by MerchPlan which match filter parameters
specified as query string values.
Retrieves the specified MerchSeason object.
Retrieves the MerchSeason objects which
match <filter parameters> specified as query
string values. class_name "MerchSeason" is
required.

Updating MerchSeason
Method: PUT
URI Relative Path Comments

./merch_versions/{merch_season_id} Updates the specified MerchSeason object.

Deleting MerchSeason
Method: DELETE
URI Relative Path Comments

./merch_versions/{merch_season_id} Deletes the specified MerchSeason object.

DOMAIN-ASSET RELATED APIs 451

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
1_modified_at time R/O Last time this object was modified.
1node_name string C/O Display name for the object.
1children reflist MerchFolderVersion R/O This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1modified_by ref User R/O This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1season ref MerchSeason R/O This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1secondaries reflist MerchSecondaryVersion R/O This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1active boolea R/W This attribute requires module:
n Merchandising to be installed.
Otherwise, it is ignored.
1apparel_season ref Season R/W This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1previous ref MerchSeason R/W This attribute requires module:
Merchandising to be installed.
Otherwise, it is ignored.
1links (_links) refmap R/O C8 Ref to URL Lookup map.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 452


MerchSecondary
Reading MerchSecondary
Method: GET
URI Relative Path
./merch_plans/{merch_plan_id}/secondari
es[?[skip=m][[&]limit=n][&...]]
./merch_collections/{merch_collection_i
d}/secondaries[?[skip=m][[&]limit=n][&.
..]]
./merch_products/{merch_product_id}/sec
ondaries[?[skip=m][[&]limit=n][&...]]
./merch_options/{merch_option_id}/secon
daries[?[skip=m][[&]limit=n][&...]]
./merch_folders/{merch_folder_id}/secon
daries[?[skip=m][[&]limit=n][&...]]
./merch_secondaries/{merch_secondary_id
}
./merch_secondaries[?[skip=m][[&]limit=
n][&...]]
Updating MerchSecondary
Method: PUT
URI Relative Path
./merch_secondaries/{merch_secondary_id}
Deleting MerchSecondary
Method: DELETE
URI Relative Path
./merch_secondaries/{merch_secondary_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Retrieves the MerchSecondary objects
referenced by MerchPlan which match filter
parameters specified as query string values.
Retrieves the MerchSecondary objects
referenced by MerchCollection which match
filter parameters specified as query string
values.
Retrieves the MerchSecondary objects
referenced by MerchProduct which match filter
parameters specified as query string values.
Retrieves the MerchSecondary objects
referenced by MerchOption which match filter
parameters specified as query string values.
Retrieves the MerchSecondary objects
referenced by MerchFolder which match filter
parameters specified as query string values.
Retrieves the specified MerchSecondary object.
Retrieves the MerchSecondary objects which
match <filter parameters> specified as query
string values.
Comments
Updates the specified MerchSecondary
object.
Comments
Deletes the specified MerchSecondary
object.
453
 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan ref MerchPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
plan_secondary ref MerchSecondaryPlan R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondary_parent ref MerchSecondaryPlan; R/O This attribute requires
MerchSecondary module: Merchandising to be
installed. Otherwise, it is ignored.
versions reflist MerchSecondaryVersion R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
children reflist MerchSecondary R/O This attribute requires
module: Merchandising to be
installed. Otherwise, it is ignored.
secondary_childr reflist MerchSecondary R/O This attribute requires
en module: Merchandising to be
installed. Otherwise, it is ignored.
**subtype ref MerchSecondaryPlanSu C/O This attribute requires
btype; module: Merchandising to be
MerchSecondarySubtyp installed. Otherwise, it is ignored.
e
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new MerchSecondary object.

• @ C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 454

 Centric 8 REST API DEVELOPER GUIDE

MerchVersion
Creating MerchVersion

MerchVersion is an abstract class that cannot be instantiated. When the user calls
GET/PUT/DELETE endpoint of this API they are performing operations against the version of
the six classes that inherit from MerchVersion class such as MerchCollectionVersion,
MerchFolderVersion, MerchOptionVersion, MerchProductVersion, MerchSeason, and
MerchSecondaryVersion.

Method: POST
URI Comments

./merch_levels/{merch_level_id} Creates new MerchVersion as a child of the MerchLevel

/versions with specified id.

Reading MerchVersion
Method: GET
URI Comments

./merch_versions/{merch_ve Retrieves the specified MerchCollectionVersion,

rsion_id}
./merch_versions[?[skip=m
][[&]limit=n]
[&<filter_parameters>]..]
MerchFolderVersion, MerchOptionVersion, MerchProductVersion,
MerchSeason or MerchSecondaryVersion object.
Retrieves the MerchCollectionVersion, MerchFolderVersion,
MerchOptionVersion, MerchProductVersion, MerchSeason or
MerchSecondaryVersion objects which match the above class
name specified in the header parameter "class_name" and also
match the <filter parameters>. See the example screenshot
below for the GET query of “class_name” = MechProductVersion.

Updating MerchVersion
Method: PUT
URI Comments

./merch_versions/{merch_ve Updates MerchCollectionVersion, MerchFolderVersion,

rsion_id} MerchOptionVersion, MerchProductVersion, MerchSeason or
MerchSecondaryVersion object for given id.

Deleting MerchVersion
Method: DELETE
URI Comments

./merch_versions/{merch_v Deletes MerchCollectionVersion, MerchFolderVersion,

ersion_id} MerchOptionVersion, MerchProductVersion, MerchSeason or
MerchSecondaryVersion object for given id.

DOMAIN-ASSET RELATED APIs 455

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of MerchVersion

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
parents reflist MerchSecondaryVersion R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
plan_secondary ref MerchSecondaryPlan R/O This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
primary ref MerchOptionVersion; R/O This attribute requires
MerchProductVersion; module: Merchandising to be installed.
MerchCollectionVersion; Otherwise, it is ignored.
MerchSeason;
MerchFolderVersion
active boolean R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
children reflist MerchSecondaryVersion R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
previous ref MerchSecondaryVersion R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
season ref MerchSeason R/W This attribute requires
module: Merchandising to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 456


NutrientItem
Creating NutrientItem
Method: POST
URI Relative Path
./food_label_data_sheet_revisions/{food_lab
el_data_sheet_revision_id}/nutrients
Reading NutrientItem
Method: GET
URI Relative Path
./food_label_data_sheet_revisions/{food
_label_data_sheet_revision_id}/nutrient
s[?[skip=m][[&]limit=n][&...]]
./nutrient_items/{nutrient_item_id}
./nutrient_items[?[skip=m][[&]limit=n][
&...]]
Updating NutrientItem
Method: PUT
URI Relative Path
./nutrient_items/{nutrient_item_id}
Deleting NutrientItem
Method: DELETE
URI Relative Path
./nutrient_items/{nutrient_item_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new NutrientItem object as a
child of FoodLabelDataSheetRevision.
Comments
Retrieves the NutrientItem objects referenced
by FoodLabelDataSheetRevision which match
filter parameters specified as query string
values.
Retrieves the specified NutrientItem object.
Retrieves the NutrientItem objects which match
<filter parameters> specified as query string
values.
Comments
Updates the specified NutrientItem object.
Comments
Deletes the specified NutrientItem object.
457
 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
amount double R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
**library_item ref FoodNutrient R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
only_for_product refset ProductSalesRegion R/W This attribute requires
_sales_regions module: FormulatedProduct to be
installed. Otherwise, it is ignored.
percent_daily_va double R/W This attribute requires
lue module: FormulatedProduct to be
installed. Otherwise, it is ignored.
uom enum R/W This attribute requires
module: FormulatedProduct to be
installed. Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new NutrientItem object.

DOMAIN-ASSET RELATED APIs 458

 Centric 8 REST API DEVELOPER GUIDE

OnlineCrew
Creating OnlineCrew
Method: POST
URI Comments

./online_crews/{online_crew_id} Create a new OnlineCrew for the specifired parent

(Customer, Supplier or SalesDivision) object id.

Reading OnlineCrew
Method: GET
URI Comments

./online_crews/{online_crew_id} Retrieve the specified SupplierCrew,

./online_crews[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
CustomerCrew or SalesDivisionCrew object.
Retrieve the specified online crew for the Supplier,
Customer or SalesDivision as specified in the
header parameter “class_name”, the valid values
for which are: “SupplierCrew”, “CustomerCrew”,
“SalesDivisionCrew”, and also match the
<filter_parameters>. See the example screenshot
below.

Updating OnlineCrew
Method: PUT
URI Comments

./online_crews/{online_crew_id} Updates the specified SupplierCrew,

CustomerCrew or SalesDivisionCrew object.and
add User to the OnlineCrew.

Method: DELETE unsupported

OnlineCrew does not support Delete.

See also:

• Create an on-line Customers, Suppliers and SalesDivision

• Assigning a role to the on-line Customers, Suppliers and SalesDivision

DOMAIN-ASSET RELATED APIs 459

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of OnlineCrew

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
active boolean R/O
self_managed boolean R/O
assignments reflist CrewAssignment R/O
company_info ref CompanyInfo R/O
modified_by ref User R/O
parent_crew reflist R/O
crew_users reflist User R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 460

 Centric 8 REST API DEVELOPER GUIDE

Order
Creating Order
Method: POST
URI Comments

./purchase_orders/{purchased_order_id} Create a new Order object as a child of

/ PurchaseOrder.
Orders
./customer_purchase_orders/ Create a new Order object as a child of
{customer_purchase_order_id}/po CustomerPurchaseOrder.

Reading Order
Method: GET
URI Comments

./purchase_orders/{purchased_order_id}/ Retrieve the Order objects referenced by

orders[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./customer_purchase_orders/
{customer_purchase_order_id}/po
./orders/{order_id}
./orders[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
PurchaseOrder which match the
<filter_parameters> included in the
resource_path.
Retrieve the Order objects referenced by
CustomerPurchaseOrder which match the
<filter_parameters> included in the
resource_path.
Retrieve the specified Order object.
Retrieves the Order objects which match the
<filter_parameters> included in the
resource_path.

Updating Order
Method: PUT
URI Comments

./orders/{order_id} Updates the specified Order object.

Deleting Order
Method: DELETE
URI Comments

./orders/{order_id} Deletes the specified Order object.

DOMAIN-ASSET RELATED APIs 461

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Order

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
balance_carton_quantit double R/O
y
balance_extension double R/O
carton_quantity double R/O
extension double R/O
source_color_code string R/O
source_product_code string R/O
source_size_code string R/O
modified_by ref User R/O
po ref PurchasedOrder R/O
po_color ref PurchasedOrderColor R/O
po_product ref PurchasedOrderProduct R/O
allowance_pct double R/W
allowance_value double R/W
balance_balance_quanti double R/W
ty
balance_shipped_quanti double R/W
ty
customer_name string R/W
description string R/W
discount_pct double R/W
discount_value double R/W
factory_out_bound double R/W
factory_out_bound_base double R/W
landed_cost double R/W
quantity double R/W
quantity_per_size doubleve R/W
ctor
unit_per_master_carton integer R/W
unit_per_pack integer R/W
customer ref Customer R/W
order_quote ref SupplierItem R/W
realized_product ref SKUMaterial; SKU R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 462


OrderTableSpanner
Creating OrderTableSpanner
Method: POST
URI
./customer_purchase_orders/{customer_purchase_
order_id}/orders/order_table_spanners
./purchased_order_products/{purchased_order_pr
oduct_id}/orders/order_table_spanners
./purchase_orders/{purchased_order_id}/orders/
order_table_spanners
Reading OrderTableSpanner
Method: GET
URI
./customer_purchase_orders/{customer_purchase
_order_id}/orders/order_table_spanners[?[skip
=m][[&]limit=n][& <filter_parameters>]..]
./purchase_order_products/{purchase_order_pro
duct_id}/orders/order_table_spanners[?[skip=m
][[&]limit=n][& <filter_parameters>]..]
./purchase_orders/{purchase_order_id}/orders/
order_table_spanners[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./order_table_spanners/{order_table_spanner_i
d}
./order_table_spanners[?[skip=m][[&]limit=n][
& <filter_parameters>]..]
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new OrderTableSpanner
object as a child of
CustomerPurchaseOrder.
Create a new OrderTableSpanner
object as a child of
PurchasedOrderProduct.
Create a new OrderTableSpanner
object as a child of PurchaseOrder.
Comments
Retrieve the OrderTableSpanner
objects referenced by
CustomerPurchaseOrder which match
<filter_parameters> included in the
resource_path.
Retrieve the OrderTableSpanner
objects referenced by
PurchaseOrderProduct which match
<filter_parameters> included in the
resource_path.
Retrieve the OrderTableSpanner
objects referenced by PurchaseOrder
which match <filter_parameters>
included in the resource_path.
Retrieve the specified
OrderTableSpanner object.
Retrieve the OrderTableSpanner
objects which match
<filter_parameters> included in the
resource_path.
463
 Centric 8 REST API DEVELOPER GUIDE

Updating OrderTableSpanner
Method: PUT

URI Comments

./order_table_spanners/{order_table_spa Updates the specified OrderTableSpanner

nner_id} object.

Deleting OrderTableSpanner
Method: DELETE
URI Comments

./order_table_spanners/{order_table_spa Deletes the specified OrderTableSpanner

nner_id} object.

Attribute List of OrderTableSpanner

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 464

 Centric 8 REST API DEVELOPER GUIDE

ORQuestion
Reading ORQuestion
Method: GET
URI Comments

./or_question/{or_question_id} Retrieves the specified ORQuestion object.

./or_question[?[skip=m][[&]limit=n] Retrieves the specified ORQuestion objects which

[&...]] match the filter parameters.

Method: POST, PUT & DELETE are unsupported

ORQuestion is a read-only object.

DOMAIN-ASSET RELATED APIs 465

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ORQuestion

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
points_possible double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
points_scored double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
weight double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
weighted_score double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
sub_questions refvector ORSubQuestion R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
comments string R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
flagged boolean R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
not_applicable boolean R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
response enum R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
response_text string R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 466

 Centric 8 REST API DEVELOPER GUIDE

ORQuestionSection
Reading ORQuestionSection
Method: GET
URI Comments

./supplier_reviews/{supplier_review Retrieves a list of ORQuestionSection objects

_id}/sections/ referenced by SupplierReview which match filter
parameters specified as query string values.
or_question_sections[?[skip=m][[&]l
imit=n][&...]]
./or_question_sections/{or_question Retrieves the specified ORQuestionSection object.
_section_id}

./or_question_sections[?[skip=m][[& Retrieves the specified ORQuestionSection objects

]limit=n][&...]] which match the filter parameters.

Method: POST, PUT & DELETE unsupported

ORQuestionSection is a read-only object.

DOMAIN-ASSET RELATED APIs 467

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ORQuestionSection

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
num_flagged integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
num_questions integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
num_responded integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
points_possible double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
points_scored double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
score double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
weight double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
spec ref QuestionSe R/O This attribute requires
ction module: Operations to be installed.
Otherwise, it is ignored.
subsections refvector ORQuestion R/O This attribute requires
Subsection module: Operations to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 468

 Centric 8 REST API DEVELOPER GUIDE

ORQuestionSubsection
Reading ORQuestionSection
Method: GET
URI Comments

./or_question_sections/{or_question_se Retrieves a list of ORQuestionSubsection objects

ction_id}/ referenced by SupplierReview which match filter
parameters specified as query string values.
subsections/or_question_subsections[?[
skip=m][[&]limit=n][&...]]

./or_question_subsections/ Retrieves the specified ORQuestionSubsection

{or_question_subsection_id} object.

./or_question_subsections[?[skip=m] Retrieves the specified ORQuestionSubsection

objects which match the filter parameters.
[[&]limit=n][&...]]

Method: POST, PUT & DELETE unsupported

ORQuestionSubsection is a read-only object.

DOMAIN-ASSET RELATED APIs 469

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ORQuestionSubsection

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
num_flagged integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
num_questions integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
num_responded integer R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
points_possible double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
points_scored double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
score double R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
questions refvector ORQuestion R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 470

 Centric 8 REST API DEVELOPER GUIDE

ORSubQuestion
Reading ORSubQuestion
Method: GET
URI Comments

./or_sub_question/{or_question_subs Retrieves the specified ORSubQuestion object.

ection_id}

./or_sub_question[?[skip=m][[&]limi Retrieves the specified ORSubQuestion objects

t=n][&...]] which match the filter parameters.

Method: POST, PUT & DELETE unsupported

ORSubQuestion is a read-only object.

Attribute List of ORSubQuestion

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
modified_by ref User R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
spec ref SubQuestion R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
response enum R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 471

 Centric 8 REST API DEVELOPER GUIDE

PackList
Creating PackList
Method: POST
URI Comments

./shipment_termss/{shipment_terms_id}/ Creates a new PackList object as a child of

pack_lists ShipmentTerms.
./pack_lists Creates a new PackList object.

Reading PackList
Method: GET
URI Comments

./shipment_termss/{shipment_terms_id}/ Retrieves the PackList objects referenced by

pack_lists[?[skip=m][[&]limit=n][&...] ShipmentTerms which match filter parameters
] specified as query string values.
./pack_lists/{pack_list_id} Retrieves the specified PackList object.

./pack_lists[?[skip=m][[&]limit=n][&...] Retrieves the PackList objects which match

] <filter parameters> specified as query string
values.

Updating PackList
Method: PUT
URI Comments

./pack_lists/{pack_list_id} Updates the specified PackList object.

Deleting PackList
Method: DELETE
URI Comments

./pack_lists/{pack_list_id} Deletes the specified PackList object.

DOMAIN-ASSET RELATED APIs 472

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
carton_total_qty double R/O
cnt_documents integer R/O
pdf url R/O
state_change_time time R/O
modified_by ref User R/O
purchased_order ref PurchasedOrder R/O
recent_child_comments refvector Comment R/O
recent_comments refvector Comment R/O
state_change_user ref User R/O
state enum R/W
comments reflist Comment R/W
documents reflist Document R/W
line_items refvector PackListItem R/W
referenced_documents reflist Document R/W
description string R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 473

 Centric 8 REST API DEVELOPER GUIDE

PackListCarton
Reading PackListCarton
Method: GET
URI Comments

./pack_lists/{pack_list_id}/cartons[ Retrieves the PackListCarton objects referenced

?[skip=m][[&]limit=n][&...]] by PackList which match filter parameters specified
as query string values.
./pack_list_cartons/{pack_list_carto Retrieves the specified PackListCarton object.
n_id}

./pack_list_cartons[?[skip=m][[&]lim Retrieves the PackListCarton objects which match

it=n][&...]] <filter parameters> specified as query string
values.

Updating PackListCarton
Method: PUT
URI Comments

./pack_list_cartons/{pack_list_carto Updates the specified PackListCarton object.

n_id}

Method: POST and DELETE unsupported

PackListCarton does not support POST and DELETE

methods.

Attribute List of PackListCarton

Attribute Type Read Only Description

id CNL R/O C8 system ID
modified_at time R/O Last time this object was modified
node_name string R/W Display name for the object
modified_by ref R/O
carton_number integer R/W
link (_links) refmap R/O C8 ref to URL Lookup map

DOMAIN-ASSET RELATED APIs 474

 Centric 8 REST API DEVELOPER GUIDE

PackListItem
Creating PackListItem
Method: POST
URI Comments

./pack_lists/{pack_list_id}/line_items Creates a new PackListItem object as a

child of PackList.
./pack_list_items Creates a new PackListItem object.

Reading PackListItem
Method: GET
URI Comments

./pack_lists/{pack_list_id}/line_items[?[ Retrieves the PackListItem objects

skip=m][[&]limit=n][&...]] referenced by PackList which match filter
parameters specified as query string values.
./pack_list_items/{pack_list_item_id} Retrieves the specified PackListItem object.

./pack_list_items[?[skip=m][[&]limit=n][& Retrieves the PackListItem objects which

...]] match <filter parameters> specified as query
string values.

Updating PackListItem
Method: PUT
URI Comments

./pack_list_items/{pack_list_item_id} Updates the specified PackListItem object.

Deleting PackListItem
Method: DELETE
URI Comments

./pack_list_items/{pack_list_item_id} Deletes the specified PackListItem object.

DOMAIN-ASSET RELATED APIs 475

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Only Description

id CNL R/O C8 System ID
modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
carton_quantity double R/O
packed_quantity double R/O
cartons refset PackListCarton R/O
modified_by ref User R/O
shipment ref Shipment R/O
scheduled_quanti double R/W
ty
linka (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 476

 Centric 8 REST API DEVELOPER GUIDE

PartMaterial (v2 Deprecated, use v3 instead)

The v2 endpoint will be retired from C8 Version 7.1.

Creating PartMaterial
Method: POST
URI Comments

./material_bom_revisions/{material_bom_revisi Creates a new PartMaterial object as a

on_id}/items/part_materials child owned by MaterialBOMRevision.
./apparel_bom_revisions/{apparel_bom_revision Creates a new PartMaterial object as a
_id}/items/part_materials child owned by ApparelBOMRevision.

Reading PartMaterial
Method: GET
URI Comments

./part_materials/{part_material_id} Retrieves the specified PartMaterial object.

./part_materials[?[skip=m][[&]limit=n][& Retrieves the PartMaterial objects which

<filter_parameters>]..] match the <filter_parameters> included in the
resource_path.

Updating PartMaterial
Method: PUT

URI Comments

./part_materials/{part_material_id} Updates the specified PartMaterial object.

Deleting PartMaterial
Method: DELETE
URI Comments

./part_materials/{part_material_id} Deletes the specified PartMaterial object.

DOMAIN-ASSET RELATED APIs 477

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterial

Attribute Data Type Ref. Type Access Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the
object.
cost Double double R/O
sys_id String string R/O
validation_status String enum R/O
bom_line_sku String Ref R/O
(SKUMaterial;
SKU)
modified_by String Ref R/O
(User)
used_color_specs List<String> Refset R/O
(ColorSpecificatio
n)
used_colors List<String> Refset R/O
(Colorway;
ColorMaterial;
ColorSpecification
)
used_product_colors List<String> Refset R/O
(Colorway;
ColorMaterial)
used_quotes List<String> Refset R/O
(SupplierItem)
used_sizes List<String> Refset R/O
(ProductSize)
variations List<String> Reflist R/O
(PartMaterialVariat
ion)
bom_color_unit_pric List<Double> doublevector R/W
es
color_lock Boolean boolean R/W
comment String string R/W
final_inspection_re Boolean boolean R/W This attribute requires
levant module: AQL to be
installed. Otherwise, it is
ignored.
for_style Boolean boolean R/W
pm_id String string R/W PartMaterial identifier
providing access to the
Centric8 'ID' attribute.
include_on_stock_or Boolean boolean R/W
der
loss_pct Float float R/W
main_material Boolean boolean R/W
qty_default Double double R/W

DOMAIN-ASSET RELATED APIs 478

 Centric 8 REST API DEVELOPER GUIDE

qty_sizes List<Double> doublevector R/W

sourcing_model String enum R/W
uom String enum R/W
unit_price_act Double double R/W
actual String Ref R/W
(Style; Material)
bom_color_quotes List<String> Refvector R/W
(SupplierItem)

bom_line_bom String Ref R/W

(ApparelBOM;
MaterialBOM)
bom_line_quote String Ref R/W
(SupplierItem)
ds_section String Ref R/W
(BOMSectionDefin
ition)
colorways_color List<String> Refvector R/W
(Colorway;
ColorMaterial;
ColorSpecification
)
common_color String Ref R/W
(Colorway;
ColorMaterial;
ColorSpecification
)
common_size String Ref R/W
(ProductSize)
common_size_spec String Ref R/W
(SizeSpec)
hidden_for_color List<String> Refset R/W
(Colorway;
ColorMaterial;
ColorSpecification
)
only_for_product_al List<String> Refset R/W
ternatives (ProductAlternativ
e)
only_for_sizes List<String> Refset R/W
(ProductSize)
original String Ref R/W
(Style; Material)
sizes_size_material List<String> Refvector R/W
(ProductSize)
sizes_size_spec List<String> Refvector R/W
(SizeSpec)
effective_end Map<String, timemap R/W
String>
effective_start Map<String, timemap R/W
String>
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 479

 Centric 8 REST API DEVELOPER GUIDE

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.

Attribute Value Considerations

• The values in attributes bom_color_quotes, colorways_color and bom_color_unit_prices,

qty_sizes, sizes_size_spec and sizes_size_material may change but the number of entries in
the value vector many not change.
• The values of attributes bom_color_quotes, colorways_color, bom_line_bom, bom_line_quote,
common_color, common_size, and sizes_size_material must belong to the owner specified
in actual.
• Color in bom_color_quotes, colorways_color and common_color must be unlocked.
• hidden_for_color must be on BOM's revision color.
• only_for_sizes must be on BOM's revision size.

DOMAIN-ASSET RELATED APIs 480

 Centric 8 REST API DEVELOPER GUIDE

PartMaterial
Prior to the 7.0 release, use version V2 of these APIs. If the user is
using Centric 8 version 7.0 and above, then use version V3 of these
APIs.

The PartMaterial v3 URL is : http[s]://{c8server}/csi-

requesthandler/api/v3/part_materials

Creating PartMaterial
Method: POST
URI Comments

./material_bom_revisions/{mater Create a new PartMaterial object as a child of

ial_bom_revision_id}/items/part MaterialBOMRevision.
_materials
./apparel_bom_revisions/{appare Create a new PartMaterial object as a child of
l_bom_revision_id} ApparelBOMRevision.

/items/part_materials
./apparel_bom_revisions/{appare Create a new PartMaterial object as a child of
l_bom_revision_id} ApparelBOMRevision.

/items/special_part_materials?m
aterial_type={material_type}&ma
terial_name={material_name}
./material_bom_revisions/{mater Create a new PartMaterial object as a child of
ial_bom_revision_id} MaterialBOMRevision.

/items/special_part_materials?m
aterial_type={material_type}&ma
terial_name={material_name}

Reading PartMaterial
Method: GET
URI Comments

./material_bom_revisions/{material_bom_r Retrieve the PartMaterial objects referenced

evision_id}/items/part_materials[?[skip= by MaterialBOMRevision which match filter
m][[&]limit=n] parameters specified as query string values.

[&<filter_parameters>]..]
./apparel_bom_revisions/{apparel_bom_rev Retrieve the PartMaterial objects referenced
ision_id}/items/part_materials[?[skip=m] by ApparelBOMRevision which match filter
[[&]limit=n] parameters specified as query string values.

[&<filter_parameters>]..]

DOMAIN-ASSET RELATED APIs 481

 Centric 8 REST API DEVELOPER GUIDE

./part_materials/{part_material_id} Retrieve the specified PartMaterial object.

./part_materials[?[skip=m][[&]limit=n] Retrieve the PartMaterial objects which match

<filter parameters> specified as query string
[&<filter_parameters>]..] values.

Updating PartMaterial
Method: PUT

URI Comments

./part_materials/{part_material_id} Updates the specified PartMaterial object.

Deleting PartMaterial
Method: DELETE
URI Comments

./part_materials/{part_material_id} Deletes the specified PartMaterial object.

DOMAIN-ASSET RELATED APIs 482

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterial

Attribute Data Type Ref. Type Access Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the
object.
cost Double double R/O
sys_id String string R/O
validation_status String enum R/O
bom_line_sku String Ref R/O
(SKUMaterial;
SKU)
modified_by String Ref R/O
(User)
used_color_specs List<String> Refset R/O NO LONGER AVAILABLE
(ColorSpecificatio IN CENTRIC 7.0
n)
used_colors List<String> Refset R/O
(Colorway;
ColorMaterial;
ColorSpecification
)
used_product_colors List<String> Refset R/O NO LONGER AVAILABLE
(Colorway; IN CENTRIC 7.0
ColorMaterial)
used_quotes List<String> Refset R/O
(SupplierItem)
used_sizes List<String> Refset R/O
(ProductSize)
variations List<String> Reflist R/O
(PartMaterialVariat
ion)
part_material_color List<String> Reflist R/O
s (PartMaterialColor
)
part_material_quant List<String> Reflist R/O
ities (PartMaterialQuan
tity)
part_material_sizes List<String> Reflist R/O
(PartMaterialSize)
color_lock Boolean boolean R/W
comment String string R/W
final_inspection_re Boolean boolean R/W This attribute requires
levant module: AQL to be
installed. Otherwise, it is
ignored.
for_style Boolean boolean R/W
pm_id String string R/W PartMaterial identifier
providing access to the
Centric8 'ID' attribute.

DOMAIN-ASSET RELATED APIs 483

 Centric 8 REST API DEVELOPER GUIDE

include_on_stock_or Boolean boolean R/W

der
loss_pct Float float R/W
main_material Boolean boolean R/W
qty_default Double double R/W
sourcing_model String enum R/W
uom String enum R/W
unit_price_act Double double R/W
actual String Ref R/W
(Style; Material)
bom_line_bom String Ref R/W
(ApparelBOM;
MaterialBOM)
bom_line_quote String Ref R/W
(SupplierItem)
ds_section String Ref R/W
(BOMSectionDefin
ition)
common_color String Ref R/W
(Colorway;
ColorMaterial;
ColorSpecification
)
common_size String Ref R/W
(ProductSize)
common_size_spec String Ref R/W
(SizeSpec)
only_for_product_al List<String> Refset R/W
ternatives (ProductAlternativ
e)
only_for_sizes List<String> Refset R/W
(ProductSize)
original String Ref R/W
(Style; Material)
sizes_size_spec List<String> Refvector R/W NO LONGER AVAILABLE
(SizeSpec) IN CENTRIC 7.0
ok_variation_by_bom Boolean boolean R/W
_size
only_for_colors List<String> Refset R/W
(Colorway;
ColorMaterial)
only_for_product_sa List<String> Refset R/W
les_regions (ProductSalesRegi
on)
tracking_comments String string R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.
modified_by_applica String String R/O This attribute is a R/O
tion attribute in C8. However,
user can change the value
via REST API call.

DOMAIN-ASSET RELATED APIs 484

 Centric 8 REST API DEVELOPER GUIDE

DOMAIN-ASSET RELATED APIs 485

 Centric 8 REST API DEVELOPER GUIDE

PartMaterialColor
Reading PartMaterialColor
Method: GET
URI Comments

./part_materials/{part_material_id}/ Retrieve the PartMaterialColor objects

referenced by PartMaterial which match filter
part_material_colors[?[skip=m][[&]limit= parameters specified as query string values.
n][&...]]

./part_material_colors/{part_material_co Retrieves the specified PartMaterialColor

lor_id} object.

./part_material_colors[?[skip=m][[&]limi Retrieves the PartMaterialColor objects which

t=n][&...]] match the <filter_parameters> included in the
resource_path.

Updating PartMaterialColor
Method: PUT

URI Comments

./part_material_colors/{part_material_co Updates the specifiedPartMaterialColor

lor_id} object.

Method: POST & DELETE unsupported

PartMaterialColor does not support POST or DELETE

methods.

DOMAIN-ASSET RELATED APIs 486

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterialColor

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
pmc_unit_price double R/O
modified_by ref User R/O
pmcbom_color ref Colorway; R/O
ColorMaterial
pmc_color ref Colorway; R/O
ColorMaterial;
ColorSpecification
pmc_quote ref SupplierItem R/O
pmc_user ref User R/O
effective_end time R/W
effective_start time R/W
pmc_sample ref Sample; R/W
MaterialSample
tracking_comments string R/W
tracking_status enum R/W
tracking_status_time time R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 487

 Centric 8 REST API DEVELOPER GUIDE

PartMaterialQuantity
Reading PartMaterialQuantity
Method: GET
URI Comments

./part_materials/{part_material_id}/ Retrieves the PartMaterialQuantity objects which

match the <filter_parameters> included in the
part_material_quantities[?[skip=m] resource_path.

[[&]limit=n][&<filter_parameters>]..]
./part_material_quantities/ Retrieves the specified PartMaterialQuantity object.

{part_material_size_id}
./part_material_quantities[?[skip=m] Retrieves the PartMaterialQuantity objects which
match the <filter_parameters> included in the
[[&]limit=n][&<filter_parameters>]..] resource_path.

Creating PartMaterialQuantity
Method: POST
URI Comments

./part_materials/{part_material_id}/p Creates a new PartMaterialQuantity object as a

art_material_sizes child of PartMaterial.

Deleting PartMaterialQuantity
Method: DELETE
URI Comments

./part_material_quantities/{part_mate Delete the specified PartMaterialQuantity object.

rial_quantity_id}

Method: PUT is not supported

PartMaterialQuantity does not support the PUT method.

DOMAIN-ASSET RELATED APIs 488

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterialQuantity

Attribute Data Type Ref. Access Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/O Display name for the object.
quantity Double double R/O
modified_by String Ref R/O
(User)
pmsbom_sizes List<String> Refset R/O
(Product
Size)
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 489

 Centric 8 REST API DEVELOPER GUIDE

PartMaterialSize
Reading PartMaterialSize
Method: GET
URI Comments

./part_materials/{part_material_id} Retrieves the PartMaterialSize objects which match

/part_material_sizes[?[skip=m][[&]
limit=n][&<filter_parameters>]..]
./part_material_sizes/{part_material
_size_id}
./part_material_sizes[?[skip=m][[&]l
imit=n][&<filter_parameters>]..]
the <filter_parameters> included in the
resource_path.
Retrieves the specified PartMaterialSize object.
Retrieves the PartMaterialSize objects which match
the <filter_parameters> included in the
resource_path.

Method: POST, PUT & DELETE unsupported

PartMaterialSize is a read-only endpoint. It does not

support POST, PUT or DELETE methods.

Attribute List of PartMaterialSize

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/O Display name for the object.
modified_by String ref (User) R/O
pmsbom_sizes List<String> refset R/O
( ProductSize)
pms_size String ref R/O
(ProductSize)
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 490

 Centric 8 REST API DEVELOPER GUIDE

PartMaterialSizeSpec
Reading PartMaterialSizeSpec
Method: GET
URI Comments

./part_materials/{part_material_id}/ Retrieves the PartMaterialSizeSpec object

referenced by PartMaterial which match the filter
part_material_size_specs[?[skip=m] parameters.

[[&]limit=n][[&<filter_parameters>].
.]
./part_material_size_specs/ Retrieves the specified PartMaterialSizeSpec
objects.
{part_material_size_spec_id}
./part_material_size_specs[?[skip=m] Retrieves the PartMaterialSizeSpec objects which
match the filter parameters.
[[&]limit=n][[&<filter_parameters>].
.]

Creating PartMaterialSizeSpec
Method: POST
URI Comments

./part_materials/{part_material_id}/ Creates a new PartMaterialSizeSpec object as a

part_material_sizes child of PartMaterial.

Deleting PartMaterialSizeSpec
Method: DELETE
URI Comments

./part_material_size_specs/{part_mat Deletes the specified PartMaterialSizeSpec object.

erial_size_spec_id}

Method: PUT is unsupported

PartMaterialSizeSpec does not support PUT method.

DOMAIN-ASSET RELATED APIs 491

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterialSizeSpec

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
modified_by ref User R/O
pmsbom_sizes refset ProductSize R/O
pms_size_spec ref SizeSpec R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 492

 Centric 8 REST API DEVELOPER GUIDE

PartMaterialVariation
Creating PartMaterialVariation
Method: POST
URI Comments

./part_materials/{part_material_id}/variations Deprecated and will be removed in

Centric Version 7.1. Creates a new
PartMaterialVariation object as a child
of PartMaterial.

Reading PartMaterialVariation
Method: GET
URI Comments

./part_material_variations/{part_material_ Deprecated and will be removed in

id}/variations[?[skip=m][[&]limit=n][&<fil
ter_parameters>]..]
./part_material_variations/{part_material_
variation_id}
./part_material_variations[?[skip=m][[&]li
mit=n][&<filter_parameters>]..]
Centric Version 7.1. Retrieves the
PartMaterialVariation objects referenced by
part_material_id which match the
<filter_parameters>
Retrieves the specified
PartMaterialVariation object.
Retrieves the PartMaterialVariation objects
which match the <filter_parameters>
included in the resource_path.

Updating PartMaterialVariation
Method: PUT

URI Comments

./part_material_variations/{part_material_ Updates the specified PartMaterialVariation

variation_id} object.

Deleting PartMaterialVariation
Method: DELETE
URI Comments

./part_material_variations/{part_material_ Deletes the specified PartMaterialVariation

variation_id} object.

DOMAIN-ASSET RELATED APIs 493

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PartMaterialVariation

Attribute Data Type Ref. Type Access Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
valid_color_size_ Boolean boolean R/O Invicates that this resource
combination passed BOM Validataion.
modified_by String Ref (User) R/O
quantity Double double R/W
use_color Boolean boolean R/W Enables use of Color
use_quantity Boolean boolean R/W Enables use of Quantity
use_size_material Boolean boolean R/W Enables use of SizeMaterial
use_size_spec Boolean boolean R/W Enables use of SizeSpec
color String Ref (Colorway; R/W
ColorMaterial;
ColorSpecification)
pmv_product_color String Ref (Colorway; R/W Must be a color listed on the
ColorMaterial) BOM revision.
pmv_product_size String Ref (ProductSize) R/W Must be a size listed on the
BOM revision.
size_material String Ref (ProductSize) R/W
size_spec String Ref (SizeSpec) R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

Attribute Value Considerations

The PartMaterial.actual attribute must be set to reference the Style or Material associated with this
PartMaterial in order to create a PartMaterialVariation.

• The associated BOM's is_sample_bom attribute value must be false.

• Boolean attributes use_color, use_quantity, use_size_material and use_size_spec correspond
to attributes color, quantity, size_material, and size_spec. The correlated attribute is utilized
(and must be valid) if the corresponding boolean attribute is true. At least one of the boolean
attributes is required to be true.
• If the associated BOM is owned by a Style, pmv_product_color references a Colorway, if
owned by a Material, pmv_product_color references a ColorMaterial,
• The pair pmv_product_color and pmv_product_size are required and must be unique among
the PartMaterialVariations for the parent part material.
• pmv_product_color must be a color of the owning BOM revision's bom_product_colors and the
color may not be hidden.
• pmv_product_size must be a size of the owning BOM revision's bom_product_sizes and the
size must be in the PartMaterial's only_for_sizes list if that attribute value list isn't empty.
• color must be an active, unlocked color on the PartMaterial.actual product
and PartMaterial.color_lock must be false.
• size_material must be a size on the PartMaterial.actual product.

DOMAIN-ASSET RELATED APIs 494

 Centric 8 REST API DEVELOPER GUIDE

PBCLineItem
Creating PBCLineItem
Method: POST
URI Comments

./product_blended_costs/ Create a new PBCLineItem object as a

child of ProductBlendedCost.
{product_blended_cost_id}/pbc_line_items

Reading PBCLineItem
Method: GET
URI Comments

./product_blended_costs/{product_blended_co Retrieve the PBCLineItem objects

st_id} referenced by ProductBlendedCost which
match filter parameters specified as query
/pbc_line_items[?[skip=m][[&]limit=n][&...] string values.
]

./pbc_line_items/{pbc_line_item_id} Retrieve the specified PBCLineItem

object.
./pbc_line_items[?[skip=m][[&]limit=n][&... Retrieve the PBCLineItem objects which
]] match <filter parameters> specified as
query string values.

Updating PBCLineItem
Method: PUT

URI Comments

./pbc_line_items/{pbc_line_item_id} Update the specified PBCLineItem object.

Deleting PBCLineItem
Method: DELETE
URI Comments

./pbc_line_items/{pbc_line_item_id} Update the specified PBCLineItem object.

DOMAIN-ASSET RELATED APIs 495

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PBCLineItem

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
modified_by ref User R/O
fraction double R/W
blended_cost_quote ref SupplierItem C/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 496

 Centric 8 REST API DEVELOPER GUIDE

Placement
Creating Placement
Method: POST
URI Comments

./placements Create a new Placement object.

Reading Placement
Method: GET
URI Comments

./placements/{placement_id} Retrieve the specified Placement object.

./placements[?[skip=m][[&]limit=n][&...]] Retrieve the Placement objects which

match <filter parameters> specified as
query string values.

Updating Placement
Method: PUT

URI Comments

./placements/{placement_id} Updates the specified Placement object.

Deleting Placement
Method: DELETE
URI Comments

./placements/{placement_id} Deletes the specified Placement object.

DOMAIN-ASSET RELATED APIs 497

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Placement

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
Node_name string R/W Display name for the object.
Modified_by ref User R/O
languages stringmap R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 498

 Centric 8 REST API DEVELOPER GUIDE

Price
Reading Price
Method: GET
URI Comments

./prices/{price_id} Retrieves the specified Price object.

./prices[?[skip=m][[&]limit=n][& Retrieves the Price objects which match the

<filter_parameters>]..] <filter_parameters>

Updating Price
Method: PUT

URI Comments

./prices/{price_id} Updates the specified Price object.

Deleting Price
Method: DELETE
URI Comments

./prices/{price_id} Deletes the specified Price object.

Method: POST is unsupported

Price does not support POST method.

DOMAIN-ASSET RELATED APIs 499

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Price

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
active boolean R/O
modified_by ref User R/O
product_sales_reg ref ProductSale R/O
ion sRegion
comment string R/W
freeze_status boolean R/W
colorway ref Colorway R/W
country ref Country R/W
sku ref SKU R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 500

 Centric 8 REST API DEVELOPER GUIDE

PriceList
Creating PriceList
Method: POST
URI Comments

./styles/{style_id}/data_sheets/price_lists Creates a new PriceList object as child of

Style.

Reading PriceList
Method: GET
URI Comments

./styles/{style_id}/data_sheets/price_lists Retrieve the PriceList objects referenced

[?[skip=m][[&]limit=n][&<filter_parameters> by Style which match filter parameters
]..] specified as query string values.

./price_lists/{price_list_id} Retrieves the specified PriceList object.

./price_lists[?[skip=m][[&]limit=n] Retrieves the PriceList objects which

match the <filter_parameters>
[&<filter_parameters>]..]

Updating PriceList
Method: PUT

URI Comments

./price_lists/{price_list_id} Updates the specified PriceList object.

Deleting PriceList
Method: DELETE
URI Comments

./price_lists/{price_list_id} Deletes the specified PriceList object.

DOMAIN-ASSET RELATED APIs 501

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Pricellist

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
Node_name string R/W Display name for the object.
Current_revision ref PriceListRevision R/O
latest_revision ref PriceListRevision R/O
modified_by ref User R/O
phase_current_revi refmap PriceListRevision R/O
sions
revisions refvector PriceListRevision R/O
description string R/W
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 502

 Centric 8 REST API DEVELOPER GUIDE

PriceListRevision
Creating PriceListRevision
Method: POST
URI Comments

./price_list_revisions/{price_list_ Creates a new revision of the PriceListRevision

revision_id}/revise object

Reading PriceListRevision
Method: GET
URI Comments

./price_list_revisions/ Retrieves the specified PriceListRevision

{price_list_revision_id} object.

./price_list_revisions[?[skip=m] Retrieves the PriceListRevision objects

which match the <filter_parameters>
[[&]limit=n][& <filter_parameters>]..]

Updating PriceListRevision
Method: PUT

URI Comments

./price_list_revisions/ Updates the specified PriceListRevision object.

{price_list_revision_id}
./price_list_revisions/
{price_list_revision_id}?
Action={action_name}
Update the specified PriceListRevision object and changes the
revision state based on the actions enum list: APPROVED,
REVERT, FREEZE, UPDATE_PRICES,
DELETE_INACTIVE_PRICES, FREEZE_PRICES,
UNFREEZE_ALL_PRICES

Method: DELETE unsupported

PriceListRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 503

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PriceListRevision

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
price_for_colorway_or_ enum R/O
sku
price_for_sales_region enum R/O
_or_country
revert_time time R/O
state enum R/O
state_change_time time R/O
approver ref User R/O
modified_by ref User R/O
pending_user ref User R/O
phase ref _CS_Phase R/O
revert_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
items refvector SpecDSLineItem; R/W
RoutingItem;
Price;
PartMaterial; Test;
SizeChartDimensi
on;
DSLineDivider;
MaterialPlanPlace
ment;
SubRoutingItem
supplier_item ref SupplierItem R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 504

 Centric 8 REST API DEVELOPER GUIDE

PrintDesign
Creating PrintDesign
Method: POST
URI Comments

./print_designs Creates a new PrintDesign object.

Reading PrintDesign
Method: GET
URI Comments

./print_designs/{print_design_id} Retrieves the specified PrintDesign object.

./print_designs[?[skip=m][[&]limit=n][& Retrieves the PrintDesign objects which

<filter_parameters>]..] match the <filter_parameters>

Updating PrintDesign
Method: PUT

URI Comments

./print_designs/{print_design_id} Updates the specified PrintDesign object.

Deleting PrintDesign
Method: DELETE
URI Comments

./print_designs/{print_design_id} Deletes the specified PrintDesign object.

DOMAIN-ASSET RELATED APIs 505

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PrintDesign

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
cnt_documents integer R/O
sys_id string R/O
comments reflist Comment R/O
current_revision ref PrintDesign R/O
Revision
documents reflist Document R/O
latest_revision ref PrintDesign R/O
Revision
modified_by ref User R/O
revisions refvector PrintDesign R/O
Revision
active boolean R/W
can_track_by_calendar boolean R/W
description string R/W
for_product_source ref ProductSour R/W
ce
images refmap Image R/W
referenced_documents reflist Document R/W
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 506

 Centric 8 REST API DEVELOPER GUIDE

PrintDesignColor
Creating PrintDesignColor
Method: POST
URI Comments

./print_design_revisions/{print_design Creates a new PrintDesignColor object.

_revision_id}/colors

Reading PrintDesignColor
Method: GET
URI Comments

./print_design_colors/{print_design_color_id} Retrieves thespecified

PrintDesignColor object.
./print_design_colors[?[skip=m][[&]limit=n][& Retrieves thePrintDesignColor objects
<filter_parameters>]..] which match the <filter_parameters>.

./print_design_revisions/{print_design_revisio Retrieves thePrintDesignColor objects

n_id}/colors[?[skip=m][[&]limit=n][& referenced by PrintDesignRevision,
<filter_parameters>]..] which match the <filter_parameters>.

Updating PrintDesignColor
Method: PUT

URI Comments

./print_design_colors/{print_design_colo Updates the specifiedPrintDesignColor object.

r_id}

Deleting PrintDesignColor
Method: DELETE
URI Comments

./print_design_colors/{print_design_colo Deletes the specifiedPrintDesignColor object.

r_id}

DOMAIN-ASSET RELATED APIs 507

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PrintDesignColor

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
cnt_documents integer R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
active boolean R/W
code string R/W
description string R/W
color_specification ref PrintDesign R/W
Color;
ColorSpecifi
cation
images refmap Image R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 508

 Centric 8 REST API DEVELOPER GUIDE

PrintDesignRevision
Creating PrintDesignRevision
Method: POST
URI Comments

./print_design_revisions/{print_de Creates a new revision of the PrintDesignRevison

sign_revision_id}/revise object

Reading PrintDesignRevision
Method: GET
URI Comments

./print_design_revisions/ Retrieves the specified PrintDesignRevison

{print_design_revision_id}
./print_design_revisions[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
object.
Retrieves the PrintDesignRevison objects which
match the <filter_parameters>

Updating PrintDesignRevision
Method: PUT
URI Comments

./print_design_revisions/ Updates the specified PrintDesignRevison object.

{print_design_revision_id}
./print_design_revisions/
{print_design_revision_id}?
action={action_name}
Updates the specified PrintDesignRevison object and
change the revision state based on the actions enum
list: [APPROVED, ABANDONED, FREEZE, REOPEN,
REVIEW, PURGEREVISION, PURGERESETREVISION]

Method: DELETE Unsupported

PrintDesignRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 509

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PrintDesignRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
colors reflist PrintDesign R/O
Color
current_revision ref PrintDesign R/O
Revision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
positions refvector PrintPosition R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
numberof_print_positions integer C/O
print_type enum R/W
repeat_height string R/W
repeat_width string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 510

 Centric 8 REST API DEVELOPER GUIDE

PrintPosition
Creating PrintPosition
Method: POST
URI Comments

./print_design_revisions/{print_de Creates a new PrintPosition object as a child of

sign_revision_id}/positions PrintDesignRevision.

Reading PrintPosition
Method: GET
URI Comments

./print_design_revisions/ Retrieves the PrintPosition objects

referenced by PrintDesignRevision
{print_design_revision_id}/positions[?[skip=m] which match the filter parameters.

[[&]limit=n][&<filter_parameters>]..]
./print_positions/{print_position_id}
./print_positions[?[skip=m][[&]limit=n][&<filte
r_parameters>]..]
Retrieves the specified PrintPosition
object.
Retrieves the PrintPosition objects
which match the <filter_parameters>.

Updating PrintPosition
Method: PUT
URI Comments

./print_positions/{print_position_id} Updates the specified PrintPosition object.

Deleting PrintPosition
Method: DELETE
URI Comments

./print_positions/{print_position_id} Deletes the specified PrintPosition object.

DOMAIN-ASSET RELATED APIs 511

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PrintPosition

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
print_position_colors reflist PrintPosition R/O
Color
position_number integer R/W
print_technique enum R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 512

 Centric 8 REST API DEVELOPER GUIDE

PrintPositionColor
Reading PrintPositionColor
Method: GET
URI Comments

./print_position_colors/{print_posit Retrieves the specified PrintPositionColor object.

ion_color_id}
./print_position_colors[?[skip=m][[& Retrieves the PrintPositionColor objects which
]limit=n][&<filter_parameters>]..] match the <filter_parameters> included in the
resource_path.

Method: POST, PUT & DELETE are unsupported

PrintPositionColor is a read-only endpoint. It does not

support Create, Update and Delete.

DOMAIN-ASSET RELATED APIs 513

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PrintPositionColor

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
modified_by ref User R/O
print_colorway ref PrintDesignCo R/O
lor
print_position_col ref ColorSpecifica R/O
or_specification tion
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 514

 Centric 8 REST API DEVELOPER GUIDE

ProductAlternative
Creating ProductAlternative
Method: POST
URI Comments

./styles/{style_id}/product_alternatives Creates a new ProductAlternative object as a

child of Style.

Reading ProductAlternative
Method: GET
URI Comments

./styles/{style_id}/product_alternatives[ Retrieves the ProductAlternative objects

?[skip=m][[&]limit=n][&...]]
./product_alternatives/{
product_alternatives_id}
./product_alternatives[?[skip=m][[&]limit=
n][& <filter_parameters>]..]
referred by Style which match the
<filter_parameters>
Retrieves the specified ProductAlternative
object.
Retrieves the ProductAlternative objects
which match the <filter_parameters>

Updating ProductAlternative
Method: PUT

URI Comments

./product_alternatives/{product_alternativ Updates the specified ProductAlternative

es_id} object.

Deleting ProductAlternative
Method: DELETE
URI Comments

./product_alternatives/{product_alternativ Deletes the specified ProductAlternative

es_id} object.

DOMAIN-ASSET RELATED APIs 515

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductAlternative

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
pa_selected Boolean boolean R/O
modified_by String ref R/O
active Boolean boolean R/W
description Map<String, String> stringma R/W
p
pa_spec String ref C/O
theme_pa String ref C/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 516

 Centric 8 REST API DEVELOPER GUIDE

ProductAlternativeSpecification
Creating ProductAlternativeSpecification
Method: POST
URI Comments

./product_alternative_specifications Creates a new ProductAlternativeSpecification

object.

Reading ProductAlternativeSpecification
Method: GET
URI Comments

./product_alternative_specifications/{product Retrieves the specified

_alternative_specification_id} ProductAlternativeSpecification object.
./product_alternative_specifications[?[skip=m Retrieves the specified
][[&]limit=n][& <filter_parameters>]..] ProductAlternativeSpecification objects
matching the <filter_parameters>.

Updating ProductAlternativeSpecification
Method: PUT

URI Comments

./product_alternative_specifications/{prod Updates the specified

uct_alternative_specification_id} ProductAlternativeSpecificationobject.

Deleting ProductAlternativeSpecification
Method: DELETE
URI Comments

./product_alternative_specifications/{prod Deletes the specified

uct_alternative_specification_id} ProductAlternativeSpecificationobject.

DOMAIN-ASSET RELATED APIs 517

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductAlternativeSpecification

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
active Boolean boolean R/W
description Map<String stringmap R/W
, String>
supplier_quote_ex Boolean boolean R/W
pected
pa_spec_suppliers List<String reflist R/W
>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 518


ProductBlendedCost
Creating ProductBlendedCost
Method: POST
URI
./styles/{style_id}/blended_costs
./materials/{material_id}/blended_costs
Reading ProductBlendedCost
Method: GET
URI
./styles/{style_id}/blended_costs[?
[skip=m][[&]limit=n][&...]]
./materials/{material_id}/blended_costs
[?[skip=m][[&]limit=n][&...]]
./product_blended_costs/
{product_blended_cost_id}
./product_blended_costs
[?[skip=m][[&]limit=n][&...]]
Updating ProductBlendedCost
Method: PUT
URI
./product_blended_costs/
{product_blended_cost_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new ProductBlendedCost object as a
child of Style.
Create a new ProductBlendedCost object as a
child of Material.
Comments
Retrieve the ProductBlendedCost objects
referenced by Style which match filter
parameters specified as query string
values.
Retrieve the ProductBlendedCost objects
referenced by Material which match filter
parameters specified as query string
values.
Retrieve the specified ProductBlendedCost
object.
Retrieve the ProductBlendedCost objects
which match <filter parameters> specified
as query string values.
Comments
Update the specified ProductBlendedCost
object.
519
 Centric 8 REST API DEVELOPER GUIDE

Deleting ProductBlendedCost
Method: DELETE
URI Comments

./product_blended_costs/ Deletes the specified ProductBlendedCost

object.
{product_blended_cost_id}

Attribute List of ProductBlendedCost

Attribute Data Type Ref. Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
fob_price double R/O
landed_cost double R/O
modified_by ref User R/O
pbc_line_items reflist PBCLin R/O
eItem
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 520

 Centric 8 REST API DEVELOPER GUIDE

ProductColorShipment
Reading ProductColorShipment
Method: GET
URI Comments

./product_color_shipments/ Retrieve the specified

{product_color_shipment_id}
./product_color_shipments[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
ProductColorShipment object.
Retrieve the ProductColorShipment
objects which match filter parameters

Updating ProductColorShipment
Method: PUT

URI Comments

./product_color_shipments/ Update the specified

ProductColorShipment object.
{product_color_shipment_id}

Method: POST, DELETE unsupported

This is a read/Update-only endpoint. It does not support

Create or Delete.

Attribute List of ProductColorShipment

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
total_quantity Double double R/O
modified_by String ref R/O
product_color String ref R/O
quantity_per_size List<Double> doublevector R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 521

 Centric 8 REST API DEVELOPER GUIDE

ProductGroup
Creating ProductGroup
Method: POST

URI Comments

./product_groups Create a new ProductGroup object.

Reading ProductGroup
Method: GET
URI Comments

./product_groups/{product_group_id} Retrieve the specified ProductGroup object.

./product_groups[?[skip=m][[&]limit=n] Retrieve the ProductGroup objects matching the

filter parameters
[&<filter_parameters>]..]

Updating ProductGroup
Method: PUT

URI Comments

./product_groups/{product_group_id} Update the specified ProductGroup object.

Deleting ProductGroup
Method: DELETE
URI Comments

./product_groups/{product_group_id} Deletes the specified ProductGroup object.

DOMAIN-ASSET RELATED APIs 522

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductGroup

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
sys_id string R/O
dimensions refvector ProductGroupDimension R/O
modified_by ref User R/O
active boolean R/W
description string R/W
images refmap Image R/W
increments reflist Increment R/W
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 523


ProductGroupDimension
Creating ProductGroupDimension
Method: POST
URI
./product_groups/{product_group_id}/
dimensions
Reading ProductGroupDimension
Method: GET
URI
./product_groups/{product_group_id}}/
dimensions[?[skip=m][[&]limit=n][&<fil
ter_parameters>]..]
./product_group_dimensions/
{product_group_dimension_id}
./product_group_dimensions[?[skip=m][[
&]limit=n][&<filter_parameters>]..]
Updating ProductGroupDimension
Method: PUT
URI
./product_groups/{product_group_id}
Deleting ProductGroupDimension
Method: DELETE
URI
./product_groups/{product_group_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new ProductGroupDimension object as a
child of ProductGroup.
Comments
Retrieve the specified ProductGroupDimension
object referenced by ProductGroup which mach
the filter parameters.
Retrieve the specified ProductGroupDimension
object.
Retrieve the ProductGroupDimension objects
matching the filter parameters.
Comments
Update the specified ProductGroupDimension
object.
Comments
Deletes the specified ProductGroupDimension
object.
524
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductGroupDimension

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the
object.
modified_by ref User R/O
inspection_tolerance double R/W This attribute requires
module: AQL to be
installed. Otherwise, it is
ignored.
inspection_tolerance double R/W This attribute requires
_negative module: AQL to be
installed. Otherwise, it is
ignored.
is_basic boolean R/W
tolerance double R/W
tolerance_negative double R/W
group_dimension ref ApparelDimension C/O
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 525

 Centric 8 REST API DEVELOPER GUIDE

ProductSalesRegion
Creating ProductSalesRegion
Method: POST
URI Comments

./styles/{style_id}/product_sales_regions Create a new ProductSalesRegion object

as a child of Style.

Reading ProductSalesRegion
Method: GET
URI Comments

./styles/{style_id}/product_sales_reg Retrieve the ProductSalesRegion objects

ions[?[skip=m][[&]limit=n][&<filter_p
arameters>]..]
./product_sales_regions/{product_sale
s_region_id}
./product_sales_regions[?[skip=m][[&]
limit=n][&<filter_parameters>]..]
referenced by Style which match filter parameters.
Retrieve the specified ProductSalesRegion object.
Retrieve the ProductSalesRegion objects
matching the filter parameters

Updating ProductSalesRegion
Method: PUT

URI Comments

./product_sales_regions/{product_sales_region_id} Update the specified

ProductSalesRegion object.

Deleting ProductSalesRegion
Method: DELETE
URI Comments

./product_sales_regions/{product_sales_region_id} Deletes the specified

ProductSalesRegion object.

DOMAIN-ASSET RELATED APIs 526

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductSalesRegion

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
sales_region_agent String ref R/O
sales_region_factory String ref R/O
active Boolean boolean R/W
product_sales_region_spec String ref C/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 527

 Centric 8 REST API DEVELOPER GUIDE

ProductSalesRegionSpec
Reading ProductSalesRegionSpec
Method: GET
URI Comments

./product_sales_region_specs/ Retrieve the ProductSalesRegion objects

referenced by Style which match filter parameters.
{product_sales_region_spec_id}

./product_sales_region_specs Retrieve the ProductSalesRegion objects

[?[skip=m][[&]limit=n][&<filter_param matching the filter parameters
eters>]..]

Method: POST, PUT & DELETE unsupported

This is a read-only endpoint. It does not support Create, Update, Delete.

Attribute List of ProductSalesRegionSpec

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
active Boolean boolean R/W
secondary_sales_regions List<String> reflist R/W
selling_countries List<String> reflist R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 528

 Centric 8 REST API DEVELOPER GUIDE

ProductShipment
Creating ProductShipment
Method: POST
URI Comments

./shipment_terms/{shipment_term_id}/ Create a new ProductShipment object

shipment_terms_product_shipments as a child of ShipmentTerm.

Reading ProductShipment
Method: GET
URI Comments

./shipment_terms/{shipment_term_id} Retrieve the ProductShipment objects referenced by

/ ShipmentTerm which match the filter parameters.

shipment_terms_product_shipments[?[
skip=m][[&]limit=n][&<filter_parame
ters>]..]

./product_shipments/{product_shipme Retrieve the specified ProductShipment object.

nt_id}

./product_shipments[?[skip=m][[&]li Retrieve the ProductShipment objects which match

mit=n] the filter parameters.

[&<filter_parameters>]..]

Updating ProductShipment
Method: PUT

URI Comments

./product_shipments/{product_shipment_id} Update the specified ProductShipment

object.

Method: DELETE unsupported

ProductShipment does not support DELETE method.

DOMAIN-ASSET RELATED APIs 529

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductShipment

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the
object.
actual_qty Double double R/O
planned_qty Double double R/O
modified_by String ref R/O This attribute requires
module: CalendarSourcing
to be installed. Otherwise,
it is ignored.
product_color_shipments List<String> reflist R/O
shipment_terms_shipments List<String> reflist R/O
product_for_shipment String ref R/W

DOMAIN-ASSET RELATED APIs 530

 Centric 8 REST API DEVELOPER GUIDE

ProductSize
Creating ProductSize
Method: POST
URI Comments

./materials/{material_id}/owned_product_sizes Creates a new ProductSize object as a

child owned by Material.
./product_sizes Creates a new ProductSize object.

Reading ProductSize
Method: GET
URI Comments

./materials/{material_id}/owned_product_sizes Retrieves the ProductSize objects

[?[skip=m][[&]limit=n][& owned by Material which match the
<filter_parameters>]..] <filter_parameters> included in the
resource_path.
./product_sizes/{product_size_id} Retrieves the specified ProductSize
object.
./product_sizes[?[skip=m][[&]limit=n][& Retrieves the ProductSize objects
<filter_parameters>]..] which match the <filter_parameters>
included in the resource_path.

Updating ProductSize
Method: PUT

URI Comments

./product_sizes/{product_size_id} Updates the specified ProductSize object.

DOMAIN-ASSET RELATED APIs 531

 Centric 8 REST API DEVELOPER GUIDE

Deleting ProductSize
Method: DELETE
URI Comments

./product_sizes/{product_size_id} Deletes the specified ProductSize object.

Attribute List of ProductSize

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.

node_name String string R/W Display name for the object.

dimension_type String enum R/W Only in C8 V6.0 release. The C8 V5.6.6
requests will assume Size as the value
when executed on a C8 V6.0 system.
is_two_dim Boolean boolean R/W Only in C8 V6.0. If true,
dimension_1_size and
dimension_2_size are required
otherwise, they are not allowed.
localized_name Map stringmap R/W
size_code Integer integer R/W
us_label String string R/W
dimension_1_size String ref R/W Only in C8 V6.0
dimension_2_size String ref R/W Only in C8 V6.0
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 532


ProductSource
Creating ProductSource
Method: POST
URI
./shapes/{shape_id}/product_sources
./styles/{style_id}/product_sources
./materials/{material_id}/product_sources
Reading ProductSource
Method: GET
URI
./shapes/{shape_id}/product_sources[?[skip
=m][[&]limit=n][&<filter_parameters>]..]
./styles/{style_id}/product_sources[?[skip
=m][[&]limit=n][&<filter_parameters>]..]
./materials/{material_id}/product_sources[
?[skip=m][[&]limit=n][&<filter_parameters>
]..]
./product_sources/{product_source_id}
./product_sources[?[skip=m][[&]limit=n][&<
filter_parameters>]..]
Updating ProductSource
Method: PUT
URI
./product_sources/{product_source_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new ProductSource object as a
child of Shape.
Create a new ProductSource object as a
child of Style.
Create a new ProductSource object as a
child of Material.
Comments
Retrieve the ProductSource objects
referenced by Shape which match filter
parameters specified as query string
values.
Retrieve the ProductSource objects
referenced by Style which match filter
parameters specified as query string
values.
Retrieve the ProductSource objects
referenced by Material which match filter
parameters specified as query string
values.
Retrieve the specified ProductSource
object.
Retrieve the ProductSource objects which
match filter parameters specified as query
string values.
Comments
Update the specified ProductSource object.
533
 Centric 8 REST API DEVELOPER GUIDE

Deleting ProductSource
Method: DELETE
URI Comments

./product_sources/{product_source_id} Deletes the specified ProductSource object.

Attribute List of ProductSource

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
agent ref Supplier R/O
availability_product ref Shape; Style; R/O
Material
modified_by ref User R/O
bom_supplier_attributes refset BOMSupplierAttri R/O
butes
sku_sources reflist SKUMaterialSour R/O
ce; SKUSource
cnt_documents integer R/O
comments reflist Comment R/O
sr_line_items reflist SRLineItem R/O
style_supplier_attributes ref StyleSupplierAttri R/O
butes
supplier_code string R/W
samples reflist Sample; R/W
MaterialSample
supplier ref Supplier C/O
supplier_items refset SupplierItem R/W
color_codes refmap R/W sysId of the productColor
(ColorMaterial or
Colorway)
crew ref Crew R/W
crew_type ref CrewType R/W
images refmap Image R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 534

 Centric 8 REST API DEVELOPER GUIDE

ProductPresentation
Reading ProductPresentation
Method: GET
URI Relative Path Comments

./product_presentations/{product_pr Retrieve the specified ProductPresentation object.

esentation_id}
./product_presentations[?[skip=m][[ Retrieve the ProductPresentation objects which
&]limit=n][&...]] match <filter parameters> specified as query string
values.

Attribute List of ProductPresentation

Attribute Type Object Read Description

Only*@
id CNL R/O C8 system ID.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
number_of_products integer R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
number_of_sets integer R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
recent_comments refvector Comment R/O
codes string R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
description String R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
product_type** enum C/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
images refmap Image R/W
Layouts refvector ProductPr R/W This attribute requires module:
esentation ProductPresentation to be installed.
Layout Otherwise, it is ignored.
pp_products reflist Shape; R/W This attribute requires module:
Formulate ProductPresentation to be installed.
dMaterial; Otherwise, it is ignored.
Style;
Material;
Food

DOMAIN-ASSET RELATED APIs 535

 Centric 8 REST API DEVELOPER GUIDE

sets reflist ProductPr R/W This attribute requires module:

esentation ProductPresentation to be installed.
Set Otherwise, it is ignored.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new ProductPresentation object.

• * - All attributes are read/only, but this column provides context as to how these attribute values would be
managed with a full CRUD API.
• @ - C/O attributes may only be set when the oject is created.

DOMAIN-ASSET RELATED APIs 536

 Centric 8 REST API DEVELOPER GUIDE

ProductPresentationLayout
Reading ProductPresentationLayout
Method: GET
URI Relative Path Comments

./product_presentation_layouts/{pro Retrieve the specified ProductPresentationLayout

duct_presentation_layout_id} object.
./product_presentation_layouts[?[sk Retrieve the ProductPresentationLayout objects
ip=m][[&]limit=n][&...]] which match <filter parameters> specified as query
string values.

Attribute List of ProductPresentationLayout

Attribute Type Object Read Description

Only*
id CNL R/O C8 system ID.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
pdf url R/O
modified_by ref User R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
description string R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
notes_orientation** enum R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
paper_orientation** enum R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
paper_size** enum R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new ProductPresentationLayout object.

• * - All attributes are read/only, but this column provides context as to how these attribute values would be
managed with a full CRUD API.

DOMAIN-ASSET RELATED APIs 537

 Centric 8 REST API DEVELOPER GUIDE

ProductPresentationSet
Reading ProductPresentationSet
Method: GET
URI Relative Path Comments

./product_presentation_sets/{produc Retrieve the specified ProductPresentationSet

t_presentation_set_id} object.
./product_presentation_sets[?[skip= Retrieve the ProductPresentationSet objects which
m][[&]limit=n][&...]] match <filter parameters> specified as query string
values.

Attribute List of ProductPresentationSet

Attribute Type Object Read Description

Only*
id CNL R/O C8 system ID.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
number_of_items integer R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
modified_by ref User R/O This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
recent_comments refvector Commen R/O
t
code string R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
description string R/W This attribute requires module:
ProductPresentation to be installed.
Otherwise, it is ignored.
images refmap Image R/W
items refvector ProductP R/W This attribute requires module:
resentati ProductPresentation to be installed.
onSetIte Otherwise, it is ignored.
m
links (_links) refmap R/O C8 Ref to URL Lookup map.

• * - All attributes are read/only, but this column provides context as to how these attribute values would be
managed with a full CRUD API.

DOMAIN-ASSET RELATED APIs 538

 Centric 8 REST API DEVELOPER GUIDE

ProductSymbol
Creating ProductSymbol
Method: POST
URI Comments

./product_symbols Creates a new ProductSymbol object.

Reading ProductSymbol
Method: GET
URI Comments

./product_symbols/{product_symbol_i Retrieves the specified ProductSymbol object.

d}
./product_symbols[?[skip=m][[&]limi Retrieves the ProductSymbol objects which match
t=n][&<filter_parameters>]..] the <filter_parameters>.

Updating ProductSymbol
Method: PUT
URI Comments

./product_symbols/{product_symbol_id} Updates the specified ProductSymbol object.

Deleting ProductSymbol
Method: DELETE
URI Comments

./product_symbols/{product_symbol_id} Deletes the specified ProductSymbol object.

DOMAIN-ASSET RELATED APIs 539

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProductSymbol

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
active boolean R/W
description stringmap R/W
localized_name stringmap R/W
rank integer R/W
symbol_type enum R/W
images refmap Image R/W
tags refmap tags R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 540

 Centric 8 REST API DEVELOPER GUIDE

Project
Creating Project
Method:POST
URI Relative Path Comments

./projects Creates a new Project object.

Reading Project
Method:GET
URI Relative Path Comments

./projects/{project_id} Retrieves the specified Project object.

./projects[?[skip=m][[&]limit=n][&...]] Retrieves the Project objects which match <filter
parameters> specified as query string values.

Updating Project
Method:PUT
URI Relative Path Comments

./projects/{project_id} Updates the specified Project object.

Deleting Project
Method:DELETE
URI Relative Path Comments

./projects/{project_id} Deletes the specified Project object.

DOMAIN-ASSET RELATED APIs 541

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_documents integer R/O
state_change_time time R/O
crew ref Crew R/O
crew_type ref CrewType R/O
documents reflist Document R/O
modified_by ref User R/O
recent_comments refvector Comment R/O
state_change_user ref User R/O
wbs ref Wbs R/O This attribute requires
module: WBS to be installed.
Otherwise, it is ignored.
active boolean R/W
description string R/W
state enum R/W
images refmap Image R/W
referenced_documents reflist Document R/W
subtype** ref ProjectSubty C/O
pe
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new Project object.

• @ - C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 542

 Centric 8 REST API DEVELOPER GUIDE

ProjectLineItem
Creating ProjectLineItem
Method:POST
URI Relative Path Comments

./projects/{project_id}/project_lin Create a new ProjectLineItem object as a child of

e_items Project.

Reading ProjectLineItem
Method:GET
URI Relative Path Comments

./projects/{project_id}/project_line_it Retrieves the ProjectLineItem objects

ems[?[skip=m][[&]limit=n][&...]]
./project_line_items/{project_line_item
_id}
./project_line_items[?[skip=m][[&]limit
=n][&...]]
referenced by Project which match filter
parameters specified as query string values.
Retrieves the specified ProjectLineItem object.
Retrieves the ProjectLineItem objects which
match <filter parameters> specified as query
string values.

Updating ProjectLineItem
Method:PUT
URI Relative Path Comments

./project_line_items/{project_line_item Updates the specified ProjectLineItem object.

_id}

Deleting ProjectLineItem
Method:DELETE
URI Relative Path Comments

./project_line_items/{project_line_item Delete the specified ProjectLineItem object.

_id}

DOMAIN-ASSET RELATED APIs 543

 Centric 8 REST API DEVELOPER GUIDE

Attribute Summary

Attribute Type Object Read Description

Only@
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
code string R/O
description string R/O
product_name string R/O
assigned_suppliers refset Supplier R/O
modified_by ref User R/O
project_documents refset Document R/O
subtype ref MaterialType R/O
;
FoodSubtype
; StyleType
product_type enum C/O
product** ref Shape; Style; C/O
Material;
Food
project_colors refset Colorway; R/W
ColorMaterial
project_sk_us refset SKUMaterial; R/W
FoodSKU;
SKU
links (_links) refmap R/O C8 Ref to URL Lookup map.

• ** - This attribute is required when creating a new ProjectLineItem object.

• @ - C/O attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 544

 Centric 8 REST API DEVELOPER GUIDE

PropertiesDataSheet
Creating PropertiesDataSheet
Method: POST
URI Comments

./properties_data_sheets Create a PropertiesDataSheet object.

Reading PropertiesDataSheet
Method: GET
URI Comments

./properties_data_sheets/ Retrieve the specified PropertiesDataSheet

{properties_data_sheets_id}
./properties_data_sheets[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
object.
Retrieve the PropertiesDataSheet objects
which match filter parameters specified as
query string values.

Updating PropertiesDataSheet
Method: PUT

URI Comments

./properties_data_sheets/ Update the specified PropertiesDataSheet

object.
{properties_data_sheets_id}

Deleting PropertiesDataSheet
Method: DELETE
URI Comments

./properties_data_sheets/ Deletes the specified PropertiesDataSheet

object.
{properties_data_sheets_id}

DOMAIN-ASSET RELATED APIs 545

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PropertiesDataSheet

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node
Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
current_revision ref PropertiesDataSheetRevision R/O
latest_revision ref PropertiesDataSheetRevision R/O
modified_by ref User R/O
revisions refvector PropertiesDataSheetRevision R/O
can_track_by_calendar boolean R/W
description string R/W
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL
Lookup map.

DOMAIN-ASSET RELATED APIs 546

 Centric 8 REST API DEVELOPER GUIDE

PropertiesDataSheetRevision
Creating PropertiesDataSheetRevision
Method: POST
URI Comments

./properties_data_sheet_revisions/ Create a revision for the specified

PropertiesDataSheetRevision object.
{properties_data_sheet_revision_id}/revise

Reading PropertiesDataSheetRevision
Method: GET
URI Comments

./properties_data_sheet_revisions/ Retrieve the specified

{properties_data_sheet_revision_id}
./properties_data_sheet_revisons[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
PropertiesDataSheetRevision object.
Retrieve the PropertiesDataSheetRevision
objects which match filter parameters.

Updating PropertiesDataSheetRevision
Method: PUT
URI Comments

./properties_data_sheet_revisions/ Update the specified

{properties_data_sheet_revision_id}
./properties_data_sheet_revisions/
{properties_data_sheet_revision_id}
?action={action_name}
PropertiesDataSheetRevision object.
Update the specified
PropertiesDataSheetRevision object and
change the revision state based of action.
Possible values are: APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

PropertiesDataSheetRevision is a Create, Update only

endpoint.

DOMAIN-ASSET RELATED APIs 547

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PropertiesDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node
Locator.
modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref PropertiesDataSheetRevision R/O
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
description string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf,
document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL
Lookup map.

DOMAIN-ASSET RELATED APIs 548

 Centric 8 REST API DEVELOPER GUIDE

ProvinceState
Creating ProvinceState
Method: POST
URI Comments

./countries/{country_id}/province_states Create a revision for the specified

PropertiesDataSheetRevision object.

Reading ProvinceState
Method: GET
URI Comments

./countries/{country_id}/province_states Retrieves the ProvinceState objects

referenced by Country which match the
[?[skip=m][[&]limit=n][[&<filter_paramete <filter_parameters>.
rs>]..]

./province_states/{province_state_id} Retrieves the specified ProvinceState

object.
./province_states[?[skip=m][[&]limit=n] Retrieves the ProvinceState objects which
match the <filter_parameters>.
[[&<filter_parameters>]..]

Updating ProvinceState
Method: PUT
URI Comments

./province_states/{province_state_id} Updates the specified ProvinceState object.

Deleting ProvinceState
Method: DELETE
URI Comments

./province_states/{province_state_id} Deletes the specified ProvinceState object.

DOMAIN-ASSET RELATED APIs 549

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ProvinceState

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
code string R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 550

 Centric 8 REST API DEVELOPER GUIDE

PurchaseOrder
Creating PurchaseOrder
Method: POST
URI Comments

./purchase_orders Creates a new PurchaseOrder object.

Reading PurchaseOrder
Method: GET
URI Comments

./purchase_orders/{purchased_order_id} Retrieves the specified PurchaseOrder

object.
./purchase_orders[?[skip=m][[&]limit=n][& Retrieves the PurchaseOrder objects
<filter_parameters>]..] which match the <filter_parameters>
included in the resource_path.

Updating PurchaseOrder
Method: PUT
URI Comments

./purchase_orders/{purchased_order_id} Updates the specified PurchaseOrder object.

Deleting PurchaseOrder
Method: DELETE
URI Comments

./purchase_orders/{purchased_order_id} Deletes the specified PurchaseOrder object.

DOMAIN-ASSET RELATED APIs 551

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PurchaseOrder

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
in_workflow boolean R/O
issue_time time R/O
pdf url R/O
po_subtype enum R/O
state_change_time time R/O
total_cartons_ordered double R/O
total_commission double R/O
total_units_ordered double R/O
total_value double R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
orders refvector Order; R/O
OrderTableS
panner
po_products reflist PurchasedOr R/O
derProduct
cnt_documents integer R/O
commission_percentage double R/W
confirmed_date time R/W
control_number string R/W
order_date time R/W
orders_by_color boolean C/O
po_comments string R/W
payment_term string R/W
remarks string R/W
state enum R/W TBC: Use special state 'Reissue'
in a PUT request to request re-
issue of the PurchasedOrder.
The PurchasedOrder remains in
the 'Issued' state after this
special request.
target_date time R/W
trade_term enum R/W
po_factory ref Factory R/W
po_sales_order ref SalesOrder R/W
po_supplier ref Supplier C/O

DOMAIN-ASSET RELATED APIs 552

 Centric 8 REST API DEVELOPER GUIDE

referenced_documents reflist Document R/W

crew ref Crew R/W
crew_type ref CrewType R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.
• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 553

 Centric 8 REST API DEVELOPER GUIDE

PurchaseOrderColor
Reading PurchaseOrderColor
Method: GET
URI Comments

./purchase_order_colors/ Retrieves the specified

PurchaseOrderColor object.
{purchased_order_color_id}
./purchase_order_colors[?[skip=m][[&]limit=n] Retrieves the
PurchaseOrderColor objects
[& <filter_parameters>]..] which match the
<filter_parameters>

Updating PurchaseOrderColor
Method: PUT
URI Comments

./purchase_order_colors/ Updates the specified

PurchaseOrderColor object.
{purchased_order_color_id}

Method: POST & DELETE unsupported

PurchaseOrderColor is a read-update only endpoint. It

does not support Create or Delete.

DOMAIN-ASSET RELATED APIs 554

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PurchaseOrderColor

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
balance Double double R/O
extension Double double R/O
factory_out_bound Double double R/O
quantity Double double R/O
modified_by String ref R/O
orders List<String> reflist R/O
po String ref R/O
po_color_samples List<String> reflist R/O
product_color String ref R/O
active Boolean boolean R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 555

 Centric 8 REST API DEVELOPER GUIDE

PurchaseOrderProduct
Reading PurchaseOrderProduct
Method: GET
URI Comments

./purchase_order_products/ Retrieves the specified PurchaseOrderProduct

{purchase_order_product_id}
./purchase_order_products[?[skip=m]
[[&]limit=n][& <filter_parameters>]..]
object.
Retrieves the PurchaseOrderProduct objects
which match the <filter_parameters> included in
the resource_path.

Updating PurchaseOrderProduct
Method: PUT
URI Comments

./purchase_order_products/ Updates the specified PurchaseOrder object.

{purchase_order_product_id}

Method: POST, DELETE unsupported

PurchaseOrderProduct is a read/Update-only endpoint.

It does not support Create or Delete.

DOMAIN-ASSET RELATED APIs 556

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of PurchaseOrderProduct

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.

_modified_at String time R/O Last time this object
was modified.
node_name String string R/W Display name for the
object.
balance Double double R/O
colors_count Integer integer R/O
extension Double double R/O
factory_out_bound Double double R/O
quantity Double double R/O
modified_by String ref R/O
po String ref R/O
po_colors List<String> reflist R/O
po_product_samples List<String> reflist R/O
product_sizes List<String> refvector R/O
active Boolean boolean R/W
orders List<String> refvector R/W
product String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 557

 Centric 8 REST API DEVELOPER GUIDE

Question
Creating Question
Method: POST
URI Comments

./question_subsections/{question_subsection Creates a new Question object as a child

_id}/Questions of QuestionSubsection.

Reading Question
Method: GET
URI Comments

./question_subsections/{question Retrieves the Question objects referenced by

_subsection_id}/ QuestionSubsection which match the
<filter_parameters>.
questions[?[skip=m][[&]limit=n]

[&<filter_parameters>]..]
./questions/{question_id} Retrieves the specified Question object.

./questions[?[skip=m][[&]limit=n Retrieves the Question objects which match the

] <filter_parameters>.

[&<filter_parameters>]..]

Updating Question
Method: PUT
URI Comments

./questions/{question_id} Updates the specified Question object.

Deleting Question
Method: DELETE
URI Comments

./questions/{question_id} Deletes the specified Question object.

DOMAIN-ASSET RELATED APIs 558

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Question

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
current_revision String ref R/O
latest_revision String ref R/O
modified_by String ref R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
revisions List<String> refvector R/O
generic Boolean boolean R/W This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
localized_name Map<String, String> stringmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 559

 Centric 8 REST API DEVELOPER GUIDE

QuestionRevision
Creating QuestionRevision
Method: POST
URI Comments

./question_revisions/{question_revision_id} Creates a new Revision for the specified

/revise Question_revision_id.

Reading QuestionRevision
Method: GET
URI Comments

./questions_revisions/{question_ Retrieves the specified QuestionRevision object.

revision_id}
./questions_revisions[?[skip=m][ Retrieves the QuestionRevision objects which match the
[&]limit=n] <filter_parameters>.

[&<filter_parameters>]..]

Updating QuestionRevision
Method: PUT
URI Comments

./questions_revisions/{question_revisio Updates the specified QuestionRevisionobject.

n_id}
./questions_revisions/{question_revisio Update the specified QuestionRevision object
n_id}?action=<action_name> and changes the revision state based on the
actions enum list:

APPROVED, REVERT, CLOSED, FREEZE

Method: DELETE Unsupported

QuestionRevision does not support Delete.

DOMAIN-ASSET RELATED APIs 560

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of QuestionRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_number Integer integer R/O
cnt_documents Integer integer R/O
is_current Boolean boolean R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
documents List<String> reflist R/O
modified_by String ref R/O
pending_2_user String ref R/O
pending_user String ref R/O
revert_user String ref R/O
review_user String ref R/O
sub_questions List<String> refvector R/O
allow_not_applicable Boolean boolean R/W
description String string R/W
localized_description Map<String, stringmap R/W
String>
points_possible Double double R/W
revision_comment String string R/W
comments List<String> reflist R/W
images Map<String, refmap R/W
String>
referenced_documents List<String> reflist R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

• This attribute in bold Green requires module: Operations to be installed. Otherwise, it is ignored.

DOMAIN-ASSET RELATED APIs 561

 Centric 8 REST API DEVELOPER GUIDE

QuestionSubsection
Creating QuestionSubsection
Method: POST
URI Comments

./question_subsections Creates a new QuestionSubsection object.

Reading QuestionSubsection
Method: GET
URI Comments

./questions_subsections/{questio Retrieves the specified QuestionSubsection object.

n_subsection_id}
./questions_subsections[?[skip=m Retrieves the QuestionSubsection objects which match
][[&]limit=n][&<filter_parameter the <filter_parameters>.
s>]..]

Updating QuestionSubsection
Method: PUT
URI Comments

./questions_subsections/{question_ Updates the specifiedQuestionSubsection object.

subsection_id}

Deleting QuestionSubsection
Method: DELETE
URI Comments

./questions_subsections/{question_ Deletes the specifiedQuestionSubsection object.

subsection_id}

DOMAIN-ASSET RELATED APIs 562

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of QuestionSubsection

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires
module: Operations to be
installed. Otherwise, it is ignored.
questions List<String> refvector R/O This attribute requires
module: Operations to be
installed. Otherwise, it is ignored.
active Boolean boolean R/W This attribute requires
module: Operations to be
installed. Otherwise, it is ignored.
localized_name Map<String, String> stringmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 563

 Centric 8 REST API DEVELOPER GUIDE

RecipeDataSheetRevision
Reading RecipeDataSheetRevision
Method: GET
URI Comments

./recipe_data_sheet_revisions/{recipe_d Retrieve the specified

ata_sheet_revision_id}
./recipe_data_sheet_revisions[?[skip=m
][[&]limit=n][&...]]
./recipe_data_sheet_revisions/{recipe_
data_sheet_revision_id}/items[?[skip=m
][[&]limit=n][&...]]
RecipeDataSheetRevision object.
Retrieve the RecipeDataSheetRevision objects
which match <filter parameters> specified as
query string values.
Retrieve the specified
RecipeDataSheetRevision object's
RecipeLineItem objects which match specified
as query string values.

Attribute Summary

Attribute Type Oject Read Description

Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
id CNL R/O C8 System ID
amount_after_h2o_loss double R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
approval_time time R/O
integer R/O
effective_end time R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
effective_start time R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
h2o_amount_before_loss double R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
h2o_loss_amount double R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
h2o_loss_pct double R/O This attribute requires module:
FormulatedProduct to be

DOMAIN-ASSET RELATED APIs 564

 Centric 8 REST API DEVELOPER GUIDE

installed. Otherwise, it is
ignored.
is_current boolean R/O
is_managed_by_ec boolean R/O This attribute requires module:
EngineeringChange to be
installed. Otherwise, it is
ignored.
pdf url R/O
pending_2_time time R/O
pending_time time R/O
proofing_time time R/O
release_version string R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
total_amount double R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
usable boolean R/O
approver ref User R/O

items refvector RecipeLine R/O This attribute requires module:

Item FormulatedProduct to be
installed. Otherwise, it is
ignored.
modified_by ref User R/O This attribute requires module:
FormulatedProduct to be
installed. Otherwise, it is
ignored.
pending_2_user ref User R/O
pending_user ref User R/O
phase ref _CS_Phas R/O
e
proofing_user ref User R/O
recipe_food_label_revi ref FoodLabel R/O This attribute requires module:
sion DataSheet FormulatedProduct to be
Revision installed. Otherwise, it is
ignored.
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
workflow_execution ref ActionItem R/O
description string R/O
revision_comment string R/O
pages refvector DataSheet R/O
Page

DOMAIN-ASSET RELATED APIs 565

 Centric 8 REST API DEVELOPER GUIDE

workflow_holder ref RecipeDat R/O

aSheet
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 566

 Centric 8 REST API DEVELOPER GUIDE

ReviewColorway
Creating ReviewColorway
Method: POST
URI Comments

./colorways/{colorway_id}/data_sheets/ Creates a new ReviewColorway object as a

child of specified Colorway.
review_colorways

Reading ReviewColorway
Method: GET
URI Comments

./colorways/{colorway_id}/data_ Retrieves the ReviewColorway objects, children of the

sheets/ specified Colorway and match the <filter_parameters>.

review_colorways[?[skip=m][[&]l
imit=n][&...]]
./review_colorways/{review_colo Retrieves the specified ReviewColorway object.
rway_id}

./review_colorways[?[skip=m][[& Retrieves the ReviewColorway objects which match the

]limit=n] <filter_parameters>.

[&<filter_parameters>]..]

Updating ReviewColorway
Method: PUT
URI Comments

./review_colorways/ Updates the specified ReviewColorway object.

{review_colorway_id}

Deleting ReviewColorway
Method: DELETE
URI Comments

./review_colorways/ Deletes the specified ReviewColorway object.

{review_colorway_id}

DOMAIN-ASSET RELATED APIs 567

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewColorway

Attribute Data Type Ref. Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
current_revision ref ReviewC R/O
olorwayR
evision
latest_revision ref ReviewC R/O
olorwayR
evision
modified_by ref User R/O
revisions refvector ReviewC R/O
olorwayR
evision
action_date time R/W
can_track_by_calendar boolean R/W
description string R/W
iteration integer R/W
received_date time R/W
requested_date time R/W
sub_type enum R/W
data_sheet_samples reflist Sample R/W
for_product_source ref ProductS R/W
ource
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 568

 Centric 8 REST API DEVELOPER GUIDE

ReviewColorwayRevision
Creating ReviewColorwayRevision
Method: POST
URI Comments

./review_colorway_revisions/ Creates a new revision for the specified

ReviewColorwayRevision.
{review_colorway_revision_id}/revise

Reading ReviewColorwayRevision
Method: GET
URI Comments

./review_colorway_revisions/ Retrieves the specified ReviewColorwayRevision object.

{review_colorway_revision_id}

./review_colorway_revisions Retrieves the ReviewColorwayRevision objects which match the

[?[skip=m] <filter_parameters>

[[&]limit=n][[&<filter_paramet
ers>]..]

Updating ReviewColorwayRevision
Method: PUT
URI Comments

./review_colorway_revisions/ Updates the specified ReviewColorwayRevision object.

{review_colorway_revision_id}
./review_colorway_revisions/
{review_colorway_revision_id}
?action={action_name}
Updates the specified ReviewColorwayRevision object and changes
the revision state based on the actions enum list: APPROVED,
ABANDONED, FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

ReviewColorwayRevision does not support Delete.

DOMAIN-ASSET RELATED APIs 569

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewColorwayRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref ReviewColorway R/O
Revision
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 570

 Centric 8 REST API DEVELOPER GUIDE

ReviewSKU
Creating ReviewSKU
Method: POST
URI Comments

./skus/{sku_id}/data_sheets/review_sku Creates a new ReviewSKU object as a child of

specified SKU.

Reading ReviewSKU
Method: GET
URI Comments

./review_skus/{review_sku_id} Retrieves the specified ReviewSKU object.

./skus/{sku_id}/data_sheets/ Retrieves the ReviewSKU objects, children of the

review_skus[?[skip=m][[&]limit=
n][&<filter_parameters>]..]
./review_skus[?[skip=m][[&]limi
t=n][&<filter_parameters>]..]
specified SKU and match the <filter_parameters>.
Retrieves the ReviewSKU objects which match the
<filter_parameters>.

Updating ReviewSKU
Method: PUT
URI Comments

./review_skus/{review_sku_id} Updates the specified ReviewSKU object.

Deleting ReviewSKU
Method: DELETE
URI Comments

./review_skus/{review_sku_id} Deletes the specified ReviewSKU object.

DOMAIN-ASSET RELATED APIs 571

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewSKU

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
iteration integer R/O
requested_date time R/O
current_revision ref ReviewS R/O
KURevisi
on
latest_revision ref ReviewS R/O
KURevisi
on
modified_by ref User R/O
revisions refvector ReviewS R/O
KURevisi
on
action_date time R/W
can_track_by_calendar boolean R/W
description string R/W
received_date time R/W
sub_type enum R/W
data_sheet_samples reflist Sample R/W
for_product_source ref ProductS R/W
ource
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 572

 Centric 8 REST API DEVELOPER GUIDE

ReviewSKURevision
Creating ReviewSKURevision
Method: POST
URI Comments

./review_sku_revisions/ Creates a revision for the specified

ReviewSKURevision object.
{review_sku_revision_id}/revise

Reading ReviewSKURevision
Method: GET
URI Comments

./review_sku_revisions/ Retrieves the specified ReviewSKURevision

{review_sku_revision_id}
./review_sku_revisions[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
object.
Retrieves the ReviewSKURevision objects, which
match the <filter_parameters>.

Updating ReviewSKURevision
Method: PUT
URI Comments

./review_sku_revisions/ Updates the specified ReviewSKURevision object.

{review_sku_revision_id}
./review_sku_revisions/
{review_sku_revision_id}
?action={action_name}
Updates the specified ReviewSKURevision object and
change the revision state as per action parameter. The
allowed values are: APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION

Method: DELETE unsupported

ReviewSKURevision does not support Delete.

DOMAIN-ASSET RELATED APIs 573

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewSKURevision

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref ReviewSKURevision R/O
modified_by ref User R/O
pages refvector DataSheetPage R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 574

 Centric 8 REST API DEVELOPER GUIDE

ReviewStyle
Creating ReviewStyle
Method: POST
URI Comments

./styles/{style_id}/data_sheets Creates a new ReviewStyle object as a child of

specified Style.
/review_styles

Reading ReviewStyle
Method: GET
URI Comments

./review_skus/{review_sku_id} Retrieves the specified ReviewStyle object.

./skus/{sku_id}/data_sheets/ Retrieves the ReviewStyle objects, children of the

specified SKU and match the <filter_parameters>.
review_skus[?[skip=m][[&]limit=
n]

[&<filter_parameters>]..]
./review_skus[?[skip=m][[&]limi Retrieves the ReviewStyle objects which match the
t=n] <filter_parameters>.

[&<filter_parameters>]..]

Updating ReviewStyle
Method: PUT
URI Comments

./review_skus/{review_sku_id} Updates the specified ReviewStyle object.

Deleting ReviewStyle
Method: DELETE
URI Comments

./review_skus/{review_sku_id} Deletes the specified ReviewStyle object.

DOMAIN-ASSET RELATED APIs 575

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewStyle

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
iteration integer R/O
current_revision ref ReviewStyleRevision R/O
data_sheet_samples reflist Sample R/O
latest_revision ref ReviewStyleRevision R/O
modified_by ref User R/O
next_iter ref ReviewStyle R/O
prev_iter ref ReviewStyle R/O
revisions refvector ReviewStyleRevision R/O
action_date time R/W
can_track_by_calen boolean R/W
dar
description string R/W
final_inspection_r boolean R/W This attribute requires
elevant module: AQL to be installed.
Otherwise, it is ignored.
received_date time R/W
requested_date time R/W
sub_type enum R/W
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 576

 Centric 8 REST API DEVELOPER GUIDE

ReviewStyleRevision
Creating ReviewStyleRevision
Method: POST
URI Comments

./review_style_revisions/ Creates a new revision for the specified

ReviewStyleRevision.
{review_style_revision_id}/revise

Reading ReviewStyleRevision
Method: GET
URI Comments

./review_style_revisions/ Retrieves the specified ReviewStyleRevision object.

{review_style_revision_id}

./review_style_revisions Retrieves the ReviewStyleRevision objects which match

[?[skip=m][[&]limit=n] the <filter_parameters>

[[&<filter_parameters>]..]

Updating ReviewStyleRevision
Method: PUT
URI Comments

./review_style_revisions/ Updates the specified ReviewStyleRevision object.

{review_style_revision_id}
./review_style_revisions/
{review_style_revision_id}
?action={action_name}
Updates the specified ReviewStyleRevision object and
changes the revision state based on the actions enum list:
APPROVED, ABANDONED, FREEZE, REOPEN, REVIEW,
PURGEREVISION, PURGERESETREVISION

Method: DELETE unsupported

ReviewStyleRevision does not support DELETE method.

DOMAIN-ASSET RELATED APIs 577

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ReviewStyleRevision

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
revision_comment string R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 578

 Centric 8 REST API DEVELOPER GUIDE

Role
Creating Role
Method: POST
URI Comments

./roles Creates a new SalesDivision object.

Reading Role
Method: GET
URI Comments

./roles/{role_id} Retrieves the specified Role object.

./roles[?[skip=m][[&]limit=n] Retrieves the Role objects which match the

<filter_parameters>.
[&<filter_parameters>]..]

Updating Role
Method: PUT
URI Comments

./roles/{role_id} Updates the specified Role object.

Deleting Role
Method: DELETE
URI Comments

./roles/{role_id} Deletes the specified Role object.

DOMAIN-ASSET RELATED APIs 579

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Role

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at string time R/O Last time this object was
modified.
node_name string string R/W Display name for the object.
used_by_acl boolean R/O
modified_by ref User R/O
preferences ref SitePreferences R/O
sub_groups reflist Role R/O
enable_breadcrumb_sear boolean R/W
ch
manage_preferences boolean R/W
used_by_online_crew boolean R/W
__members__ reflist User R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 580

 Centric 8 REST API DEVELOPER GUIDE

Routing
Creating Routing
Method: POST
URI Comments

./styles/{style_id}/data_sheets/routings Creates a new Routing object as a child of

Style.
./materials/{material_id}/data_sheets/ro Creates a new Routing object as a child of
utings Material.

Reading Routing
Method: GET
URI Comments

./styles/{style_id}/data_sheets/routings Retrieves the Routing objects referenced by

Style, which match the <filter_parameters>.
[?[skip=m][[&]limit=n][&...]]

./materials/{material_id}/data_sheets Retrieves the Routing objects referenced by

Material, which match the <filter_parameters>.
/routings[?[skip=m][[&]limit=n][&...]]

./routings/{routing_id} Retrieves the specified Routing object.

./routings[?[skip=m][[&]limit=n] Retrieves the Routing objects which match the

<filter_parameters>.
[&<filter_parameters>]..]

Updating Routing
Method: PUT
URI Comments

./routings/{routing_id} Updates the specified Routing object.

Deleting Routing
Method: DELETE
URI Comments

./routings/{routing_id} Deletes the specified Routing object.

DOMAIN-ASSET RELATED APIs 581

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Routing

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
current_revision ref RoutingRevision R/O
latest_revision ref RoutingRevision R/O
modified_by ref User R/O
revisions refvector RoutingRevision R/O
can_track_by_calendar boolean R/W
description string R/W
images reflist Image R/W
routing_factories reflist Factory R/W
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 582

 Centric 8 REST API DEVELOPER GUIDE

RoutingGroup
Creating RoutingGroup
Method: POST
URI Comments

./routing_groups Creates a new RoutingGroup object.

Reading RoutingGroup
Method: GET
URI Comments

./routing_groups/{routing_group_id} Retrieves the specified RoutingGroup object.

./routing_groups[?[skip=m][[&]limit=n] Retrieves the RoutingGroup objects which

match the <filter_parameters>.
[&<filter_parameters>]..]

Updating RoutingGroup
Method: PUT
URI Comments

./routing_groups/{routing_group_id} Updates the specified RoutingGroup object.

Deleting RoutingGroup
Method: DELETE
URI Comments

./routing_groups/{routing_group_id} Deletes the specified RoutingGroup object.

DOMAIN-ASSET RELATED APIs 583

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of RoutingGroup

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 584

 Centric 8 REST API DEVELOPER GUIDE

RoutingItem
Creating RoutingItem
Method: POST
URI Comments

./routing_revisions/{routing_revision_id} Creates a new RoutingItem object as a child

/items of RoutingRevision.

Reading RoutingItem
Method: GET
URI Comments

./routing_revisions/{routing_revision_id} Retrieves the RoutingItem objects referenced

/items by RoutingRevision, which match the
<filter_parameters>.
[?[skip=m][[&]limit=n][&...]]

./routing_items/{routing_item_id} Retrieves the specified RoutingItem object.

./routing_items[?[skip=m][[&]limit=n] Retrieves the RoutingItem objects which

match the <filter_parameters>.
[&<filter_parameters>]..]

Updating RoutingItem
Method: PUT
URI Comments

./routing_items/{routing_item_id} Updates the specified RoutingItem object.

Deleting RoutingItem
Method: DELETE
URI Comments

./routing_items/{routing_item_id} Deletes the specified RoutingItem object.

DOMAIN-ASSET RELATED APIs 585

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of RoutingItem

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
group_number integer R/O
sequence_number integer R/O
modified_by ref User R/O
comment string R/W
id string R/W
pcs_per_hr double R/W
actual ref SourcingCapability; R/W
SubRoutingRevision
only_for_product_alter refset ProductAlternative R/W
natives
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 586

 Centric 8 REST API DEVELOPER GUIDE

RoutingRevision
Creating RoutingRevision
Method: POST
URI Comments

./routing_revisions/{routing_revision_id} Creates a revision for the specified

/revise RoutingRevision object.

Reading RoutingRevision
Method: GET
URI Comments

./routing_revisions/{routing_revision_id} Retrieves the specified RoutingRevision

object.
./routing_revisions[?[skip=m][[&]limit=n] Retrieves the RoutingRevision objects which
match the <filter_parameters>.
[&<filter_parameters>]..]

Updating RoutingRevision
Method: PUT
URI Comments

./routing_revisions/{routing_revision_id} Updates the specified RoutingRevision

object.
./routing_revisions/{routing_revision_id} Updates the specified RoutingRevision
? object and change the revision state as per
action parameter. The allowed values are:
action={action_name} [APPROVED, ABANDONED, FREEZE,
REOPEN, REVIEW, PURGEREVISION,
PURGERESETREVISION]

Method: DELETE unsupported

RoutingRevision is a Create, Update only endpoint. It does

not support the DELETE method.

DOMAIN-ASSET RELATED APIs 587

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of RoutingRevision

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref RoutingRevision R/O
items refvector RoutingItem; R/O
DSLineDivider
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 588

 Centric 8 REST API DEVELOPER GUIDE

SalesDivision
Creating SalesDivision
Method: POST
URI Comments

./sales_divisions Creates a new SalesDivision object.

Reading SalesDivision
Method: GET
URI Comments

./sales_divisions/{sales_division_id} Retrieves the specified SalesDivision

object.
./sales_divisions[?[skip=m][[&]limit=n][& Retrieves the SalesDivision objects
<filter_parameters>]..] which match the <filter_parameters>
included in the resource_path.

Updating SalesDivision
Method: PUT
URI Comments

./sales_divisions/{sales_division_id} Updates the specified SalesDivision object.

Deleting SalesDivision
Method: DELETE
URI Comments

./sales_divisions/{sales_division_id} Deletes the specified SalesDivision object.

DOMAIN-ASSET RELATED APIs 589

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesDivision

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
cnt_documents integer R/O
address string R/W
address_1 string R/W
address_2 string R/W
city string R/W
company string R/W
email string R/W
fax string R/W
job_title string R/W
language string R/W
localized_address string R/W
mobile string R/W
payment_term string R/W
phone_number string R/W
photocopy_number string R/W
postal_code string R/W
purpose string R/W
state enum R/W
supplier_number string R/W
trade_term enum R/W
website string R/W
country ref Country R/W
images refmap Image R/W
province_state ref ProvinceState R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 590

 Centric 8 REST API DEVELOPER GUIDE

SalesMarket
Creating SalesMarket
Method: POST
URI Comments

./sales_markets Creates a new SalesMarket object.

Reading SalesMarket
Method: GET
URI Comments

./sales_markets/{sales_market_id} Retrieves the specified SalesMarket object.

./sales_markets[?[skip=m][[&]limit=n] Retrieves the SalesMarket objects which match

[& <filter_parameters>]..] the <filter_parameters> included in the
resource_path.

Updating SalesMarket
Method: PUT
URI Comments

./sales_markets/{sales_market_id} Updates the specified SalesMarket object.

Deleting SalesMarket
Method: DELETE
URI Comments

./sales_divisions/{sales_market_id} Deletes the specified SalesMarket object.

DOMAIN-ASSET RELATED APIs 591

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesMarket

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object
was modified.
node_name String string R/W Display name for the
object.
modified_by String ref R/O
enable_discount Boolean boolean R/W
sales_order_enabled Boolean boolean R/W
use_looks Boolean boolean R/W
use_tools Boolean boolean R/W
Currency** String ref C/O
sm_customers List<String> reflist R/W
sm_sales_divisions List<String> reflist R/W
crew ref Crew R/W
Crew_type ref CrewType R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

• ** represents OOTB mandatory attribute.

• The attribute in bold blue color requires the module CollectionBook to be installed, otherwise the attribute is ignored.

DOMAIN-ASSET RELATED APIs 592

 Centric 8 REST API DEVELOPER GUIDE

SalesOrder
Creating SalesOrder
Method: POST
URI Comments

./sales_orders Creates a new SalesOrder object.

Reading SalesOrder
Method: GET
URI Comments

./sales_orders/{sales_order_id} Retrieves the specified SalesOrder object.

./sales_orders[?[skip=m][[&]limit=n][ Retrieves the SalesOrder objects which match the
& <filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating SalesOrder
Method: PUT
URI Comments

./sales_orders/{sales_order_id} Updates the specified SalesOrder object.

Deleting SalesOrder
Method: DELETE
URI Comments

./sales_orders/{sales_order_id} Deletes the specified SalesOrder object.

DOMAIN-ASSET RELATED APIs 593

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesOrder

Attribute Data Ref. Read Description

Type Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.

node_name String string R/W Display name for the object.

discount_total Double double R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
grand_total Double double R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
is_released Boolean boolean R/O
item_total_price Double double R/O
item_total_quantity Integer integer R/O
release_date String time R/O
total_units_ordered Integer integer R/O This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
line_items List<Stri reflist R/O
ng>
modified_by String ref R/O
released_by String ref R/O
so_purchased_order String ref R/O
cancel_by String time R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
complete_ship_by String time R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
control_number String string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
count_sales_volume Boolean boolean R/W
delivery String string R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
discount_fixed Double double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
discount_pct Double double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
freight Double double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
insurance Double double R/W This attribute requires
module: CollectionBook to be installed.
Otherwise, it is ignored.
is_template Boolean boolean R/W This attribute requires
module: CollectionBook to be installed.

DOMAIN-ASSET RELATED APIs 594

 Centric 8 REST API DEVELOPER GUIDE

Otherwise, it is ignored.
misc_cost Double double R/W
notes String string R/W
order_date String time R/W
payment_term String string R/W
sku_based_order** Boolean boolean C/O
sales_order_note String string R/W
so_purchased_order String ref R/O
special_instructions String string R/W
start_ship String time R/W
suggested_buyer String string R/W
suggested_buyer_bill_to String string R/W
suggested_buyer_ship_to String string R/W
suggested_buyer_vat_code String string R/W
suggested_payment_term String string R/W
target_date String time R/W
tax Double double R/W
buyer String ref R/W
market** String ref C/O
seller String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• ** represents OOTB mandatory attribute.

• The attribute in bold blue color requires the module CollectionBook to be installed, otherwise the attribute is ignored.

DOMAIN-ASSET RELATED APIs 595

 Centric 8 REST API DEVELOPER GUIDE

SalesOrderLineItem
Creating SalesOrderLineItem
Method: POST
URI Comments

./sales_orders/{sales_order_id}/line_items Creates a new SalesOrderLineItem

object as a child of SalesOrder

Reading SalesOrderLineItem
Method: GET
URI Comments

./sales_orders/{sales_order_id}/line_ Retrieve the SalesOrderLineItem objects

items
[?[skip=m][[&]limit=n][&...]]
./sales_order_line_items/{sales_order
_line_item_id}
./sales_order_line_items[?[skip=m][[&
]limit=n][& <filter_parameters>]..]
referenced by SalesOrder which match filter
parameters specified as query string values.
Retrieves the specified SalesOrderLineItem
object.
Retrieves the SalesOrderLineItem objects which
match the <filter_parameters> included in the
resource_path.

Updating SalesOrderLineItem
Method: PUT
URI Comments

./sales_order_line_items/{sales_order_l Updates the specifiedSalesOrderLineItem

ine_item_id} object.

Deleting SalesOrderLineItem
Method: DELETE
URI Comments

./sales_order_line_items/{sales_order_l Deletes the specifiedSalesOrderLineItem object.

ine_item_id}

DOMAIN-ASSET RELATED APIs 596

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesOrderLineItem

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
price Double double R/O
sales_volume Integer integer R/O
total_price Double double R/O
total_quantity Integer integer R/O
modified_by String ref R/O
soli_order String ref R/O
soli_skus List<String> reflist R/O
sales_order_sizes List<String> refvector R/O
discount_pct Double double R/W
quantity_per_size List<Integer> integerve R/W
ctor
soli_colorway String ref R/W This attribute is disabled if
module: CollectionBook is installed.

• The attribute in bold blue color requires the module CollectionBook to be installed, otherwise the attribute is ignored.

DOMAIN-ASSET RELATED APIs 597

 Centric 8 REST API DEVELOPER GUIDE

SalesOrderLineItemSKU
Creating SalesOrderLineItemSKU
Method: POST
URI Comments

./sales_orders/{sales_order_id}/soli_skus Creates a new

SalesOrderLineItemSKU object as a
child of SalesOrder

Reading SalesOrderLineItemSKU
Method: GET
URI Comments

./sales_orders/{sales_order_id}/soli_ Retrieve the SalesOrderLineItemSKUobjects

skus[?[skip=m][[&]limit=n][&...]] referenced by SalesOrder which match filter
parameters specified as query string values.
./sales_order_line_item_skus/ Retrieves the specified SalesOrderLineItemSKU
object.
{sales_order_line_item_sku_id}
./sales_order_line_item_skus[?[skip=m Retrieves the SalesOrderLineItemSKU objects
] which match the <filter_parameters> included in
the resource_path.
[[&]limit=n][& <filter_parameters>]..]

Updating SalesOrderLineItemSKU
Method: PUT
URI Comments

./sales_order_line_item_skus/{sales_ord Updates the

er_line_item_sku_id} specifiedSalesOrderLineItemSKUobject.

Deleting SalesOrderLineItemSKU
Method: DELETE
URI Comments

./sales_order_line_item_skus/{sales_ord Deletes the

er_line_item_sku_id} specifiedSalesOrderLineItemSKUobject.

DOMAIN-ASSET RELATED APIs 598

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SalesOrderLineItemSKU

Attribute Data Ref. Read Description

Type Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
price Double double R/O
total_price Double double R/O
modified_by String ref R/O
product_size String ref R/O
soli_orders String ref R/O
quantity Integer integer R/W
solisku String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 599

 Centric 8 REST API DEVELOPER GUIDE

Sample
Creating Sample
Method: POST

URI Comments

./product_sources/{product_ Creates a new Sample object as a child of ProductSource.

source_id}/samples

Reading Sample
Method: GET
URI Comments

./product_sources/{product_source Retrieve the Sample objects referenced by

_id}/samples ProductSource which match filter parameters specified
as query string values.
[?[skip=m][[&]limit=n][&<filter_pa
rameters>]..]
./samples/{sample_id} Retrieves the specified Sample object.
./samples[?[skip=m][[&]limit=n][& Retrieves the Sample objects which match the
] <filter_parameters> included in the resource_path.

[&<filter_parameters>..]

Updating Sample
Method: PUT
URI Comments

./samples/{sample_id} Updates the specified Sample object.

Deleting Sample
Method: DELETE
URI Comments

./samples/{sample_id} Deletes the specified Sample object.

DOMAIN-ASSET RELATED APIs 600

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Sample

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
sample_bom_reset_time time R/O
storage_bin_number string R/O
storage_name string R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
sample_sr_line_item ref SRLineItem R/O
cnt_documents integer R/O
description string R/W
iteration integer R/W
request_number string R/W
requested_qty double R/W
sample_notes string R/W
sample_received_date time R/W
sample_review_date time R/W
sample_status enum R/W
sample_type enum R/W
created_styles reflist Style R/W
product_color ref Colorway R/W
product_size ref ProductSize R/W
responsible_users reflist User R/W
sample_factory ref Factory R/W
sample_product_alternative ref ProductAlter R/W
native
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 601

 Centric 8 REST API DEVELOPER GUIDE

SamplingPlan
Creating SamplingPlan
Method: POST
URI Comments

./sampling_plans Creates a new SamplingPlan object.

Reading SamplingPlan
Method: GET
URI Comments

./sampling_plans/{sampling_plan_id} Retrieve the specified SamplingPlan object.

./sampling_plans[?[skip=m][[&]limit Retrieves the SamplingPlan objects which match the

=n][&][&<filter_parameters>..] <filter_parameters> included in the resource_path.

Updating SamplingPlan
Method: PUT
URI Comments

./sampling_plans/{sampling_plan_id} Updates the specified SamplingPlan object.

Deleting SamplingPlan
Method: DELETE
URI Comments

./sampling_plans/{sampling_plan_id} Deletes the specified SamplingPlan object.

DOMAIN-ASSET RELATED APIs 602

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SamplingPlan

Attribute Data Type Ref. Read Description

Type Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
items List<String> refvector R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
modified_by String ref R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
description String string R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
inspection_level String enum R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
sampling_plan_acceptance_limits List<String> refvector R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• CNL: Centric Node Locator, an unique id of the object node, can be used in Node Browser.
• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 603

 Centric 8 REST API DEVELOPER GUIDE

SamplingPlanItem
Creating SamplingPlanItem
Method: POST

URI Comments

./sampling_plans/{sampling_plan_id}/items Creates a new SamplingPlanItem object for

the specified SamplingPlan object.

Reading SamplingPlanItem
Method: GET
URI Comments

./sampling_plans/{sampling_plan_id} Retrieves the SamplingPlanItem objects referenced

/items[?[skip=m][[&]limit=n][&][&<f
ilter_parameters>..]
./sampling_plan_items/{sampling_pla
n_item_id}
./sampling_plan_items[?[skip=m][[&]
limit=n][&][&<filter_parameters>..]
by SamplingPlan, which match the filter parameters
Retrieve the specified SamplingPlanItem object.
Retrieves the SamplingPlanItem objects which match
the filter parameters.

Updating SamplingPlanItem
Method: PUT
URI Comments

./sampling_plan_items/{sampling_plan_item_id} Updates the

specifiedSamplingPlanItem object.

Deleting SamplingPlanItem
Method: DELETE
URI Comments

./sampling_plan_items/{sampling_plan_item_id} Deletes the specifiedSamplingPlanItem

object.

DOMAIN-ASSET RELATED APIs 604

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SamplingPlanItem

Attribute Data Type Ref. Read Description

Type Write
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
carton_qty Integer integer R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
error_acceptance_limits List<Integer integerve R/W This attribute requires
> ctor module: AQL to be installed.
Otherwise, it is ignored.
lot_size Integer integer C/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
sample_qty Integer integer R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 605

 Centric 8 REST API DEVELOPER GUIDE

Season
Creating Season
Method: POST

URI Comments

./seasons Creates a new Season object.

Reading Season
Method: GET
URI Comments

./seasons/{season_id} Retrieves the specified Season object.

./seasons[?[skip=m][[&]limit=n][& Retrieves the Season objects which match the

<filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating Season
Method: PUT
URI Comments

./seasons/{season_id} Updates the specified Season object.

Deleting Season
Method: DELETE
URI Comments

./seasons/{season_id} Deletes the specified Season object.

DOMAIN-ASSET RELATED APIs 606

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Season

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
cnt_colorway integer R/O Number of Colorways under the Season.
cnt_style integer R/O Number of Styles under the Season.
hierarchy reflist Category1 R/O The list of Category 1s' ids that belong to
the Season.
issues reflist Issue; R/O
Operation
sIssue
modified_by ref User R/O
code string R/W The code of the Season.
description string R/W The description of the Season.
status enum R/W The Season's Status.
referenced_docume reflist Document R/W
nts
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 607

 Centric 8 REST API DEVELOPER GUIDE

SelectSet
Creating SelectSet
Method: POST
URI Comments

./select_sets Creates a new SelectSet object.

./styles/{style_id}/select_set Creates a new SelectSet object as a child of Style.

./materials/{material_id}/select_set Creates a new SelectSet object as a child of

Material.

Reading SelectSet
Method: GET
URI Comments

./styles/{style_id}/select_set[?[sk Retrieves the SelectSet objects referenced by Style

ip=m] and matches the filter parameters.

[[&]limit=n][&
<filter_parameters>]..]

./materials/{material_id}/select_se Retrieves the SelectSet objects referenced by

t[?[skip=m][[&]limit=n][& Material and matches the filter parameters.
<filter_parameters>]..]

./select_sets/{select_set_id} Retrieves the specified SelectSet object.

./select_sets[?[skip=m][[&]limit=n] Retrieves the SelectSet objects which match the

<filter_parameters> included in the resource_path.
[& <filter_parameters>]..]

Updating SelectSet
Method: PUT
URI Comments

./select_sets/{select_set_id} Updates the specified SelectSet object.

DOMAIN-ASSET RELATED APIs 608

 Centric 8 REST API DEVELOPER GUIDE

Deleting SelectSet
Method: DELETE
URI Comments

./select_sets/{select_set_id} Deletes the specified SelectSet object.

Attribute List of SelectSet

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
pdf String url R/O
dp_template String ref R/W
email_history_items List<String> reflist R/O
file_history String ref R/O
items List<String> refvector R/O
modified_by String ref R/O
use_cover_sheet Boolean boolean R/W
comments List<String> reflist R/W
cover_sheet_view String ref R/W
images Map<String, refmap R/W
String>
query_filter String ref R/W
subtype String ref C/O
_url_base_template String string R/O File (image, pdf, document) retrieval URL
template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 609

 Centric 8 REST API DEVELOPER GUIDE

SelectSetItem
Creating SelectSetItem
Method: POST
URI Comments

./select_sets/{select_set Creates a new SelectSetItem object as a child of SelectSet

_id}/items

Reading SelectSetItem
Method: GET
URI Comments

./select_sets/{select_set Retrieves the SelectSetIyem objects referenced by

_id}/items[?[skip=m][[&]limit=n][& SetectSet, which also matches the
<filter_parameters>]..] <filter_parameters> included in the resource_path.

./select_set_items/{select_set_item Retrieves the specified SelectSetItem object.

_id}

./select_set_items[?[skip=m][[&]lim Retrieves the SelectSetIyem objects which match the

it=n][& <filter_parameters>]..] <filter_parameters> included in the resource_path.

Updating SelectSetItem
Method: PUT
URI Comments

./select_set_items/{select_set_item_id} Updates the specified SelectSetItem object.

Deleting SelectSetItem
Method: DELETE
URI Comments

./select_set_items/{select_set_item_id} Deletes the specified SelectSetItem object.

DOMAIN-ASSET RELATED APIs 610

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SelectSetItem

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
item String ref R/W
modified_by String ref R/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 611

 Centric 8 REST API DEVELOPER GUIDE

SelectSetSubtype
Reading SelectSetSubtype
Method: GET
URI Comments

./select_set_subtypes/{select_set_ Retrieves the specified SelectSetSubtype object .

subtype_id}
./select_set_subtypes[?[skip=m][[ Retrieves the SelectSetSubtype objects which match
&]limit=n] the filter parameter.

[& <filter_parameters>]..]

Method: POST, PUT & DELETE are unsupported

SelectSetSubtype is a read-only endpoint.

Attribute List of SelectSetSubtype

Attribute Data Type Ref. Type Read Description
Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/O Name of the local object
applied_on String time R/O
modified Boolean boolean R/O
published Boolean boolean R/O
setup_applied_on String time R/O
setup_modified Boolean boolean R/O
modified_by String ref R/O
active Boolean boolean R/W
setup_active Boolean boolean R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 612

 Centric 8 REST API DEVELOPER GUIDE

Shape
Creating Shape
Method: POST
URI Comments

./shapes Creates a new Shape object.

./shape_security_groups/{shape_security Creates a new Shape object as a child of
_group_id}/shapes ShapeSecurityGroup

Reading Shape
Method: GET
URI Comments

./shapes/{shape_id} Retrieves the specified Shape object.

./shapes[?[skip=m][[&]limit=n][& Retrieves the Shape objects which match the

<filter_parameters>]..]
./shape_security_groups/{shape_security_
group_id}/shapes[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
<filter_parameters> included in the
resource_path.
Retrieves the Shape objects referenced by
ShapeSecurityGroup and match the
<filter_parameters.

Updating Shape
Method: PUT
URI Comments

./shapes/{shape_id} Updates the specified Shape object.

Deleting Shape
Method: DELETE
URI Comments

./shapes/{shape_id} Deletes the specified Shape object.

DOMAIN-ASSET RELATED APIs 613

 Centric 8 REST API DEVELOPER GUIDE

Attribute list of Shape

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object
was modified.
node_name String string R/W Display name for the
object.
documents List<String> reflist R/O
modified_by String ref R/O
product_sources List<String> refset R/O
shape_master String ref R/O
code String string R/W
description String string R/W
images Map<String, String> refmap R/W
issues List<String> reflist R/W
shape_seasons List<String> reflist R/W
shape_size_range String ref R/W
shape_tool String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 614

 Centric 8 REST API DEVELOPER GUIDE

ShapeMaster
Creating ShapeMaster
Method: POST
URI Comments

./shape_security_groups/{shape_securit Creates a new ShapeMaster object as a child of

y_group_id}/ ShapeSecurityGroup.

security_group_shapes

Reading ShapeMaster
Method: GET
URI Comments

./shape_security_groups/ Retrieve the ShapeMaster objects referenced

by Shape which match filter parameters
{shape_security_group_id}/security_gro specified as query string values.
up_shapes

[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]

./shape_masters/{shape_master_id} Retrieves the specified ShapeMaster object.

./shape_masters[?[skip=m][[&]limit=n][& Retrieve the ShapeMaster objects which match

<filter_parameters>]..] filter parameters specified as query string
values.

Updating ShapeMaster
Method: PUT
URI Comments

./shape_masters/{shape_master_id} Updates the specified ShapeMaster object.

Method: DELETE is Unsupported

ShapeMaster does not support Delete.

DOMAIN-ASSET RELATED APIs 615

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShapeMaster

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
all_seasons Boolean boolean R/O
modified_by String ref R/O
shapes List<String> reflist R/O
active Boolean boolean R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 616

 Centric 8 REST API DEVELOPER GUIDE

ShapeSecurityGroup
Creating ShapeSecurityGroup
Method: POST
URI Comments

./shape_security_groups Creates a new ShapeSecurityGroup object.

Reading ShapeSecurityGroup
Method: GET
URI Comments

./shape_security_groups/{shape_security_ Retrieves the specified ShapeSecurityGroup

group_id} object.
./shape_security_groups[?[skip=m][[&]lim Retrieves the ShapeSecurityGroup objects
it=n][& <filter_parameters>]..] which match the <filter_parameters> included
in the resource_path.

Updating ShapeSecurityGroup
Method: PUT
URI Comments

./shape_security_groups/{shape_security Updates the specified ShapeSecurityGroup

_group_id} object.

Deleting ShapeSecurityGroup
Method: DELETE
URI Comments

./shape_security_groups/{shape_security Deletes the specified ShapeSecurityGroup

_group_id} object.

DOMAIN-ASSET RELATED APIs 617

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShapeSecurityGroup

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
security_group_shapes reflist ShapeMaster R/O
description string R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 618

 Centric 8 REST API DEVELOPER GUIDE

SharedCrew
Reading SharedCrew
Method: GET
URI Comments

./shared_crews/{shared_crew_id} Retrieves the specified SharedCrew object.

./shared_crews[?[skip=m][[&]limit=n][ Retrieve the SharedCrew objects which match filter

&<filter_parameters>]..] parameters specified as query string values.

Updating SharedCrew
Method: PUT
URI Comments

./shared_crews/{shared_crews_id} Updates the specified SharedCrew object.

Method: POST, DELETE are Unsupported

ShapeMaster is a read and update only endpoint.

Attribute List of SharedCrew

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
assignments List<String> reflist R/O
modified_by String ref R/O
parent_crew List<String> reflist R/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 619

 Centric 8 REST API DEVELOPER GUIDE

SharedTeam
Creating SharedTeam
Method: POST
URI Comments

./shared_teams Creates a new SharedTeam object.

Reading SharedTeam
Method: GET
URI Comments

./shared_teams/{shared_team_id} Retrieves the specified SharedTeam

object.
./shared_teams[?[skip=m][[&]limit=n][& Retrieves the SharedTeam object which
<filter_parameters>]..] matches the <filter_parameters> included
in the resource_path.

Updating SharedTeam
Method: PUT
URI Comments

./shared_teams/{shared_team_id} Updates the specified SharedTeam object.

Deleting SharedTeam
Method: DELETE
URI Comments

./shared_teams/{shared_team_id} Deletes the specified StaredTeam object.

DOMAIN-ASSET RELATED APIs 620

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SharedTeam

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
crew ref SharedCrew R/O
crew_type ref CrewType R/O
modified_by ref User R/O
active boolean R/W
for_level enum C/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 621

 Centric 8 REST API DEVELOPER GUIDE

Shipment
Creating Shipment
Method: POST
URI Comments

./shipment_terms/{shipment_terms_id}/sh Creates a new Shipment object as a child of

ipments ShipmentTerms.

Reading Shipment
Method: GET
URI Comments

./shipment_terms/{shipment_terms_id}/ Retrieves the Shipment objects referenced

shipments[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./shipments/{shipment_id}
./shipments[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
by ShipmentTerms which match filter
parameters
Retrieves the specified Shipment object.
Retrieves the Shipment objects which
match filter parameters

Updating Shipment
Method: PUT
URI Comments

./shipments/{shipment_id} Updates the specified Shipment

object.

Deleting Shipment
Method: DELETE
URI Comments

./shipments/{shipment_id} Deletes the specified Shipment object.

DOMAIN-ASSET RELATED APIs 622

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Shipment

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
carton_quantity Double double R/O
extension Double double R/O
freeze_status Boolean boolean R/O
modified_by String ref R/O
shipment_product String ref R/O
_shipment
quantity Double double R/W
order String ref C/O This attribute may only be set when
the object is created.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 623


ShipmentQCIssue
Creating ShipmentQCIssue
Method: POST
URI
./shipment_terms/{shipment_term_id}
/issues
Reading ShipmentQCIssue
Method: GET
URI
./shipment_terms/{shipment_term_id}/
issues[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./shipment_qc_issues/{shipment_qc_is
sues_id}
./shipment_qc_issues[?[skip=m][[&]li
mit=n][& <filter_parameters>]..]
Updating ShipmentQCIssue
Method: PUT
URI
./shipment_qc_issues/{shipment_qc_issues_id}
Deleting ShipmentQCIssue
Method: DELETE
URI
./shipment_qc_issues/{shipment_qc_issues_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new ShipmentQCIssue object as a child of
ShipmentTerm.
Comments
Retrieves the ShipmentQCIssue objects referenced
by ShipmentTerm and matches the filter parameters
Retrieves the specified ShipmentQCIssue object.
Retrieves the ShipmentQCIssue objects which
match filter parameters
Comments
Updates the specified
ShipmentQCIssue object.
Comments
Deletes the specified
ShipmentQCIssue object.
624
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShipmentQCIssue

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 625

 Centric 8 REST API DEVELOPER GUIDE

ShipmentTerm
Creating ShipmentTerm
Method: POST
URI Comments

./purchase_orders/{purchase_order_id} Creates a new ShipmentTerm object as a child of

/ PurchaseOrder.

owned_shipment_terms
./shipment_terms Creates a new ShipmentTerm object

Reading ShipmentTerm
Method: GET
URI Comments

./purchase_orders/{purchase_order_id Retrieves the ShipmentTerm objects referenced by

}/ PurchaseOrder which match filter parameters

owned_shipment_terms[?[skip=m][[&]li
mit=n]

[& <filter_parameters>]..]
./shipment_terms/{shipment_term_id} Retrieves the specified ShipmentTerm object.
./shipment_terms[?[skip=m][[&]limit= Retrieves the ShipmentTerm objects which match
n] filter parameters.

[& <filter_parameters>]..]

Updating ShipmentTerm
Method: PUT

URI Comments

./shipment_terms/{shipment_term_id} Updates the specified ShipmentTerm

object.

Deleting ShipmentTerm
Method: DELETE
URI Comments

./shipment_terms/{shipment_term_id} Deletes the specified ShipmentTerm

object.

DOMAIN-ASSET RELATED APIs 626

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShipmentTerm

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
actual_lead_time integer R/O
freeze_status boolean R/O
mode enum R/O
ship_date_variance integer R/O
shipment_value double R/O
total_cartons_shipped double R/O
alternative_stuffing_loca ref Contact R/O
tion
comments reflist Comment R/O
documents reflist Document R/O
issues reflist ShipmentQC R/O
Issue
modified_by ref User R/O
purchased_orders reflist PurchasedOr R/O
der
shipment_terms_product_sh reflist ProductShip R/O
ipments ment
shipments reflist Shipment R/O
stuffing_location ref Contact R/O
cnt_documents integer R/O
actual_final_date time R/W
cargo_reading_date time R/W
confirmed_ship_date time R/W
container_number string R/W
disposition string R/W
edi_export boolean R/W
estimated_time_arrival time R/W
expected_ship_date time R/W
factory_out_bound_date time R/W
final_result enum R/W
planned_final_date time R/W
reciept_by_forwarder_date time R/W
requested_ship_date time R/W
ten_plus_two_notes string R/W
vessel_name string R/W
container ref ShippingCon R/W
tainer

DOMAIN-ASSET RELATED APIs 627

 Centric 8 REST API DEVELOPER GUIDE

port_of_destination ref ShippingPort R/W

port_of_origin ref ShippingPort R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 628

 Centric 8 REST API DEVELOPER GUIDE

ShippingContainer
Creating ShippingContainer
Method: POST
URI Comments

./shipping_containers Creates a new ShippingContainer object.

Reading ShippingContainer
Method: GET
URI Comments

./shipping_containers/{ Retrieves the specified ShippingContainer

shipping_container_id} object.
./shipping_containers[?[skip=m][[&]limit=n Retrieves the ShippingContainer objects
][& <filter_parameters>]..] which match the <filter_parameters>
included in the resource_path.

Updating ShippingContainer
Method: PUT
URI Comments

./shipping_containers/{shipping_container_id} Updates the specified

ShippingContainer object.

Deleting ShippingContainer
Method: DELETE
URI Comments

./shipping_containers/{shipping_container_id} Deletes the specified

ShippingContainer object.

DOMAIN-ASSET RELATED APIs 629

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShippingContainer

Attribute Data Ref. Type Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
calc_volume_cbm Double double R/O
modified_by String ref R/O
max_volume_cbm Double double R/W
max_weight_lbs Double double R/W
packing_efficiency Double double R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 630

 Centric 8 REST API DEVELOPER GUIDE

ShippingPort
Creating ShippingPort
Method: POST
URI Comments

./shipping_ports Creates a new ShippingPort object.

Reading ShippingPort
Method: GET
URI Comments

./shipping_ports/{shipping_port_id} Retrieves the specified ShippingPort object.

./shipping_ports[?[skip=m][[&]limit=n][& Retrieves the ShippingPort objects which

<filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating ShippingPort
Method: PUT
URI Comments

./shipping_ports/{shipping_port_id} Updates the specified ShippingPort

object.

Deleting ShippingPort
Method: DELETE
URI Comments

./shipping_ports/{shipping_port_id} Deletes the specified ShippingPort

object.

DOMAIN-ASSET RELATED APIs 631

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShippingPort

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
cnt_documents integer R/O
address string R/W
address1 string R/W
address2 string R/W
city string R/W
company string R/W
email string R/W
fax string R/W
job_title string R/W
language string R/W
localized_address string R/W
mobile string R/W
payment_term string R/W
phone_number string R/W
photocopy_number string R/W
postal_code string R/W
purpose string R/W
state enum R/W
supplier_number string R/W
tax_id string R/W
trade_term enum R/W
website string R/W
country ref Country R/W
images refmap Image R/W
port_of_origin ref ShippingPort R/W
province_state ref ProvinceState R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 632

 Centric 8 REST API DEVELOPER GUIDE

ShippingRate
Creating ShippingRate
Method: POST
URI Comments

./shipping_rates Creates a new ShippingRate object.

Reading ShippingRate
Method: GET
URI Comments

./shipping_rates/{ shipping_rate_id} Retrieves the specified ShippingRate

object.
./shipping_rates[?[skip=m][[&]limit=n][& Retrieves the ShippingRate objects which
<filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating ShippingRate
Method: PUT
URI Comments

./shipping_rates/{shipping_rate_id} Updates the specified ShippingRate

object.

Deleting ShippingRate
Method: DELETE
URI Comments

./shipping_rates/{shipping_rate_id} Deletes the specified ShippingRate

object.

DOMAIN-ASSET RELATED APIs 633

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ShippingRate

Attribute Data Ref. Read Description

Type Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
dimensional_weight_factor Double double R/W
notes String string R/W
rate Double double R/W
shipment_type String enum C/O
container String ref R/W
port_of_destination String ref R/W
port_of_origin String ref R/W

• The attribute in bold brown color represents OOTB mandatory attribute.

• C/O: Attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 634

 Centric 8 REST API DEVELOPER GUIDE

SizeChart
Creating SizeChart
Method: POST
URI Comments

./styles/{style_id}/data_sheets/size_charts Creates a new SizeChart object as a child

of Style.
./shapes/{shape_id}/data_sheets/size_charts Creates a new SizeChart object as a child
of Shape.
./size_charts Creates a new SizeChart object.

Reading SizeChart
Method: GET
URI Comments

./size_charts/{size_chart_id} Retrieves the specified SizeChart object.

./styles/{style_id}/data_sheets/ Retrieves the SizeChart objects referenced by Style

and match the <filter_parameters>.
size_charts[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./shapes/{shape_id}/data_sheets/ Retrieves the SizeChart objects referenced by Shape
and match the <filter_parameters>.
size_charts[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./size_charts[?[skip=m][[&]limit=n] Retrieves the SizeChart objects which match the
[& <filter_parameters>]..] <filter_parameters>.

Updating SizeChart
Method: PUT

URI Comments

./size_charts/{size_chart_id} Updates the specified SizeChart

object.

Deleting SizeChart
Method: DELETE
URI Comments

./size_charts/{size_chart_id} Deletes the specified SizeChart object.

DOMAIN-ASSET RELATED APIs 635

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeChart

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
current_revision ref SizeChart R/O
Revision
data_sheet_samples reflist Sample R/O
latest_revision ref SizeChart R/O
Revision
modified_by ref User R/O
revisions refvector SizeChart R/O
Revision
shape_size_chart ref SizeChart R/O
style_size_charts reflist SizeChart R/O
can_track_by_calendar boolean R/W
description string R/W
final_inspection_relevant boolean R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
pattern enum R/W
subtype ref SizeChart C/O
Subtype
for_product_source ref ProductSo R/W
urce
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

• C/O: Attributes may only be set when the object is created.

DOMAIN-ASSET RELATED APIs 636

 Centric 8 REST API DEVELOPER GUIDE

SizeChartDimension
Creating SizeChartDimension
Method: POST
URI Comments

./size_chart_revisions/ Creates a new SizeChartDimension object as a child of

SizeChartRevision.
{size_chart_revision_id}/items

Reading SizeChartDimension
Method: GET
URI Comments

./size_chart_revisions/{size_chart_r Retrieves the SizeChartDimension objects

evision_id}/ referenced by SizeChartRevision and match the
<filter_parameters>.
items[?[skip=m][[&]limit=n]

[& <filter_parameters>]..]

./size_chart_dimensions/{size_chart_ Retrieves the specified SizeChartDimension

dimension_id} objects.

./size_chart_dimensions[?[skip=m] Retrieves the SizeChartDimension objects which

match the <filter_parameters>.
[[&]limit=n][&<filter_parameters>]..]

Updating SizeChartDimension
Method: PUT

URI Comments

./size_chart_dimensions/ Updates the specified SizeChartDimension object.

{size_chart_dimension_id}

Deleting SizeChartDimension
Method: DELETE
URI Comments

./size_chart_dimensions/ Deletes the specified SizeChartDimension object.

{size_chart_dimension_id}

DOMAIN-ASSET RELATED APIs 637

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeChartDimension

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
final_inspection_relevant boolean R/O This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
review_comment string R/O
stretch double R/O
modified_by ref User R/O
blanks boolean R/W
comment string R/W
increments doubleve R/W
ctor
inspection_tolerance double R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
inspection_tolerance_negat double R/W This attribute requires
ive module: AQL to be installed.
Otherwise, it is ignored.
shrinkage double R/W
tolerance double R/W
tolerance_negative double R/W
actual ref ApparelDi R/W
mension
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 638

 Centric 8 REST API DEVELOPER GUIDE

SizeChartReview
Creating SizeChartReview
Method: POST
URI Comments

./size_chart_revisions/ Creates a new SizeChartReview object as a child of

SizeChartRevision.

{size_chart_revision_id}/

size_chart_reviews

./size_chart_reviews Creates a new SizeChartReview object.

Reading SizeChartReview
Method: GET
URI Comments

./styles/{style_id}/data_sheets/ Retrieves the SizeChartReview objects referenced

by Style and match the <filter_parameters>.
size_chart_reviews[?[skip=m][[&]
limit=n]

[&<filter_parameters>]..]

./size_chart_reviews/{size_chart_rev Retrieves the specified SizeChartReview object.

iew_id}

./size_chart_reviews[?[skip=m] Retrieves the SizeChartReview objects which

match the <filter_parameters>.
[[&]limit=n][&<filter_parameters>]..]

Updating SizeChartReview
Method: PUT

URI Comments

./size_chart_reviews/{size_chart_revi Updates the specified SizeChartReview object.

ew_id}

DOMAIN-ASSET RELATED APIs 639

 Centric 8 REST API DEVELOPER GUIDE

Deleting SizeChartReview
Method: DELETE
URI Comments

./size_chart_reviews/{size_chart_revi Deletes the specified SizeChartReview object.

ew_id}

Attribute List of SizeChartReview

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
base_review_size ref SizeChartRevie R/O
wSize
current_revision ref SizeChartRevie R/O
wRevision
data_sheet_samples reflist Sample R/O
latest_revision ref SizeChartRevie R/O
wRevision
modified_by ref User R/O
review_size_chart ref SizeChartRevis R/O
ion
review_sizes refvector SizeChartRevie R/O
wSize
revisions refvector SizeChartRevie R/O
wRevision
style ref Style R/O
can_track_by_calen boolean R/W
dar
description string R/W
sub_type enum R/W
review_request ref SupplierReque C/O This attribute requires
st module: ProductSpecSourcing to
be installed. Otherwise, it is
ignored.
review_supplier ref Supplier C/O This attribute requires
module: ProductSpecSourcing to
be installed. Otherwise, it is
ignored.
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 640

 Centric 8 REST API DEVELOPER GUIDE

SizeChartReviewDimension
Reading SizeChartReviewDimension
Method: GET
URI Comments

./size_chart_dimensions/{size_chart_dimens Retrieves the SizeChartReviewDimension

ion_id}/review_data[?[skip=m][[&]limit=n] objects referenced by
SizeChartDimension, which match the
[&<filter_parameters>]..] <filter_parameters> included in the
resource_path.
./size_chart_review_dimensions/ Retrieves the specified
SizeChartReviewDimension object.
{size_chart_review_dimension_id}
./size_chart_review_dimensions[?[skip=m] Retrieves the SizeChartReviewDimension
objects which match the
[[&]limit=n][&<filter_parameters>]..] <filter_parameters>.

Method: POST, PUT, DELETE unsupported

SizeChartReviewDimension is a read-only endpoint.

Attribute List of SizeChartReviewDimension

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
pattern double R/O
pattern_with_shrin double R/O
kage
revised double R/O
revised_pattern double R/O
revised_pattern_wi double R/O
th_shrinkage
target double R/O
modified_by ref User R/O
review_size ref SizeChartRevie R/O
wSize
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 641

 Centric 8 REST API DEVELOPER GUIDE

SizeChartReviewRevision
Reading SizeChartReviewRevision
Method: GET
URI Comments

./size_chart_review_revisions/ Retrieves the specified

{size_chart_review_revision_id}
./size_chart_review_revisions[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
SizeChartReviewRevision object.
Retrieves the SizeChartReviewRevision
objects which match the <filter_parameters>.

Method: POST, PUT, DELETE unsupported

SizeChartReviewRevision is a read-only endpoint.

DOMAIN-ASSET RELATED APIs 642

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeChartReviewRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref SizeChartReview R/O
Revision
items refvector DSLineDivider R/O
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/O
revision_comment string R/O
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 643

 Centric 8 REST API DEVELOPER GUIDE

SizeChartReviewSize
Reading SizeChartReviewSize
Method: GET
URI Comments

./size_chart_reviews/{size_chart_review_id Retrieves the SizeChartReviewSize

}/ objects referenced by SizeChartReview,
which match the <filter_parameters>
base_review_size[?[skip=m][[&]limit=n] included in the resource_path.
[&<filter_parameters>]..]

./size_chart_review_sizes/{size_chart_revie Retrieves the specified

w_size_id} SizeChartReviewSize object.
./size_chart_review_sizes[?[skip=m] Retrieves the SizeChartReviewSize
objects which match the
[[&]limit=n][&<filter_parameters>]..] <filter_parameters> included in the
resource_path.

Method: POST, PUT, DELETE unsupported

SizeChartReviewSize is a read-only endpoint.

Attribute List of SizeChartReviewSize

Attribute Data Ref. Type Read Only Description

Type
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/O Display name for the object.
modified_by ref User R/O
review_size ref ProductSize R/O
review_size_sample refvector Sample R/O
s
review_size_sub_si ref SizeChartSubS R/O
ze_range izeRange
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 644

 Centric 8 REST API DEVELOPER GUIDE

SizeChartRevision
Creating SizeChartRevision
Method: POST
URI Comments

./size_chart_revisions/{size_chart_rev Create a revision for the specified

ision_id}/revise SizeChartRevision object.

Reading SizeChartRevision
Method: GET
URI Comments

./size_chart_revisions/{size_chart_re Retrieves the specified SizeChartRevision object.

vision_id}

./size_chart_revisions[?[skip=m][[&]l Retrieves the SizeChartRevision objects which

imit=n] match the <filter_parameters>
[&<filter_parameters>]..]

Updating SizeChartRevision
Method: PUT
URI Comments

./size_chart_revisions/{size_chart_ Updates the specified SizeChartRevision object.

revision_id}
./size_chart_revisions/ Update the specified SizeChartRevision object and
changes the revision state based on the actions enum
{size_chart_revision_id}?action={ac list:
tion_name} APPROVED, ABANDONED, FREEZE, REOPEN, REVIEW,
PURGEREVISION, PURGERESETREVISION

Method: DELETE is Unsupported

SizeChartRevision does not support Delete.

DOMAIN-ASSET RELATED APIs 645

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeChartRevision

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
dimension_1_type enum R/O
dimension_2_type enum R/O
group_changed boolean R/O
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_review ref SizeChart R/O
Review
current_revision ref SizeChart R/O
Revision
items refvector SizeChart R/O
Dimension
;
DSLineDiv
ider
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review ref SizeChart R/O
Review
review_user ref User R/O
size_chart_dimension_1 refvector ProductSi R/O
_sizes ze
size_chart_dimension_2 refvector ProductSi R/O
_sizes ze
size_chart_sub_size_ra refvector SizeChart R/O
nges SubSizeR
ange
state_change_user ref User R/O

DOMAIN-ASSET RELATED APIs 646

 Centric 8 REST API DEVELOPER GUIDE

description string R/W

grainline_designation enum R/W
revision_comment string R/W
warp_shrinkage double R/W
weave_shrinkage double R/W
group ref ProductGr R/W
oup
images refmap Image R/W
size_range ref SizeRang R/W
e
sizes refvector ProductSi R/W
ze
base_size ref ProductSi R/W
ze
subrange_increment ref Increment R/W
_url_base_template string R/O File (image, pdf, document)
retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 647

 Centric 8 REST API DEVELOPER GUIDE

SizeChartSubtype
Creating SizeChartSubtype
Method: POST
URI Comments

./size_chart_subtypes Create a new SizeChartSubtype object.

Reading SizeChartSubtype
Method: GET
URI Comments

./size_chart_subtypes/{size_chart_subtype_i Retrieve the specified SizeChartSubtype

d} object.
./size_chart_subtypes[?[skip=m] Retrieve the SizeChartSubtype objects
which match <filter parameters> specified
[[&]limit=n][&<filter_parameters>]..] as query string values.

Updating SizeChartSubtype
Method: PUT
URI Comments

./size_chart_subtypes/{size_chart_subtype_i Update the specified SizeChartSubtype

d} object.

Deleting SizeChartSubtype
Method: DELETE
URI Comments

./size_chart_subtypes/{size_chart_subtype_i Delete the specified SizeChartSubtype

d} object.

DOMAIN-ASSET RELATED APIs 648

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeChartSubtype

Attribute Data Ref. Read Description

Type Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string C/O Display name for the object.
applied_on time R/O
modified boolean R/O
published boolean R/O
modified_by ref User R/O
active boolean R/W
lock_shape_dimension_list boolean R/W
lock_shape_dimension_values boolean R/W
lock_shape_tolerance boolean R/W
validation_rule_group_name string R/W
workflow_name string R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory create only attribute.

DOMAIN-ASSET RELATED APIs 649

 Centric 8 REST API DEVELOPER GUIDE

SizeCurve
Creating SizeCurve
Method: POST
URI Comments

./size_ranges/{size_range_id}/size_curves Creates a new SizeCurve object as a child

of SizeRange.

Reading SizeCurve
Method: GET
URI Comments

./size_ranges/{size_range_id}/size_curves[? Retrieves the SizeCurve objects

[skip=m][[&]limit=n][&...]] referenced by SizeRange which match
filter parameters specified as query string
values.
./size_curves/{size_curve_id} Retrieves the specified SizeCurve object.

./size_curves[?[skip=m][[&]limit=n][&...]] Retrieves the SizeCurve objects which

match <filter parameters> specified as
query string values.

Updating SizeCurve
Method: PUT
URI Comments

./size_curves/{size_curve_id} Updates the specified SizeCurve object.

Deleting SizeCurve
Method: DELETE
URI Comments

./size_curves/{size_curve_id} Deletes the specified SizeCurve object.

DOMAIN-ASSET RELATED APIs 650

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeCurve

Attribute Data Ref. Read Description

Type Type Only
id CNL R/O C8 System ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
description string R/W
quantity_per_size integervec R/W
tor
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 651

 Centric 8 REST API DEVELOPER GUIDE

SizeLabel
Creating SizeLabel
Method: POST
URI Comments

./lib_size_labels/{lib_size_label_id} Creates a new SizeLabel object as a child of

/elements LibSizeLabel.
./size_labels Creates a new SizeLabel object.

Reading SizeLabel
Method: GET
URI Comments

./lib_size_labels/{lib_size_label_id}/ Retrieves the SizeLabel objects referenced by

elements LibSizeLabel which match the
<filter_parameters>.
[?[skip=m][[&]limit=n][&<filter_parame
ters>]..]

./size_labels/{size_label_id} Retrieves the specified SizeLabel object.

./size_labels[?[skip=m][[&]limit=n] Retrieves the SizeLabel objects which match

the <filter_parameters>.
[&<filter_parameters>]..]

Updating SizeLabel
Method: PUT

URI Comments

./size_labels/{size_label_id} Updates the specified SizeLabel object.

Deleting SizeLabel
Method: DELETE
URI Comments

./size_labels/{size_label_id} Deletes the specified SizeLabel object.

Attribute List of SizeLabel

DOMAIN-ASSET RELATED APIs 652

 Centric 8 REST API DEVELOPER GUIDE

Attribute DataType Ref. Type Access Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
Node_name string R/W Display name for the object.
Sys_id string R/O
modified_by ref User R/O
sizes reflist SizeLabelSize R/O
active boolean R/W
comment string R/W
description string R/W
height double R/W
height_image double R/W
images refmap Image R/W
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 653

 Centric 8 REST API DEVELOPER GUIDE

SizeLabelSize
Creating SizeLabelSize
Method: POST
URI Comments

./size_labels/{size_ Creates a new SizeLabelSize object as a child of SizeLabel.

label_id}/sizes

Reading SizeLabelSize
Method: GET
URI Comments

./size_labels/{size_label_id}/sizes Retrieves the SizeLabelSize objects referenced by

[?[skip=m][[&]limit=n][& SizeLabel, which match the <filter_parameters>.
<filter_parameters>]..]

./size_label_sizes/{size_label_size Retrieves the specified SizeLabelSize object.

_id}

./size_label_sizes[?[skip=m][[&]lim Retrieves the SizeLabelSize objects which match the

it=n] <filter_parameters>.
[& <filter_parameters>]..]

Updating SizeLabelSize
Method: PUT

URI Comments

./size_label_sizes/{size_label_size_id} Updates the specified SizeLabelSize object.

Deleting SizeLabelSize
Method: DELETE
URI Comments

./size_label_sizes/{size_label_size_id} Deletes the specified SizeLabelSize object.

DOMAIN-ASSET RELATED APIs 654

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeLabelSize

Attribute DataType Ref. Type Access Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
Node_name string R/W Display name for the object.
Modified_by ref User R/O
sort_code integer R/W
images refmap Image R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 655

 Centric 8 REST API DEVELOPER GUIDE

SizeMap
Creating SizeMap
Method: POST
URI Comments

./size_ranges/{size_range_id}/size_maps Creates a new SizeMap object as a child of

SizeRange.

Reading SizeMap
Method: GET
URI Comments

./size_maps/{size_map_id} Retrieves the specified SizeMap object.

./size_maps[?[skip=m][[&]limit=n] Retrieves the SizeMap objects which match the

[& <filter_parameters>]..]
./size_ranges/{size_range_id}/size_
maps[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
<filter_parameters> included in the resource_path.
Retrieves the SizeMap objects referenced by
SizeRange which match the <filter_parameters>
included in the resource_path.

Updating SizeMap
Method: PUT

URI Comments

./size_maps/{size_map_id} Updates the specified SizeMap object.

Deleting SizeMap
Method: DELETE
URI Comments

./size_maps/{size_map_id} Deletes the specified SizeMap object.

DOMAIN-ASSET RELATED APIs 656

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeMap

Attribute Data Type DataType BO Type Access Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the
object.

modified_by String ref User R/O

size_map_sizes List<String> reflist SizeMapSize R/O

active Boolean boolean R/W

target_size_range String ref SizeRange C/O

links (_links) Map refmap R/O C8 Ref to URL Lookup

map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 657

 Centric 8 REST API DEVELOPER GUIDE

SizeMapSize
Creating SizeMapSize
Method: POST
URI Comments

./size_maps/{size_map_id}/size_map_sizes Creates a new SizeMapSize object as a child

of SizeRange.

Reading SizeMapSize
Method: GET
URI Comments

./size_maps/{size_map_id}/size_map_ Retrieves the specified SizeMapSize object

sizes[?[skip=m][[&]limit=n][& referenced by SizeMap which match the
<filter_parameters>]..] <filter_parameters> included in the resource_path.

./size_map_sizes/{size_map_size_id} Retrieves the specified SizeMapSize object.

./size_maps_sizes/[?[skip=m][[&] Retrieves the SizeMapSize objects which match the
<filter_parameters> included in the resource_path.
limit=n][& <filter_parameters>]..]

Updating SizeMapSize
Method: PUT

URI Comments

./size_map_sizes/{size_map_size_id} Updates the specified SizeMapSize object.

Deleting SizeMapSize
Method: DELETE
URI Comments

./size_map_sizes/{size_map_size_id} Deletes the specified SizeMapSize object.

DOMAIN-ASSET RELATED APIs 658

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeMapSize

Attribute Data Type DataType BO Type Access Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/W Display name for the
object.

modified_by String ref User R/O

source_size String ref ProductSize R/W

target_sizes List<String> refset ProductSize R/W

links (_links) Map refmap R/O C8 Ref to URL Lookup

map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 659

 Centric 8 REST API DEVELOPER GUIDE

SizeRange
Creating SizeRange
Method: POST
URI Comments

./size_ranges Creates a new SizeRange object.

Reading SizeRange
Method: GET
URI Comments

./size_ranges/{size_range_id} Retrieves the specified SizeRange object.

./size_ranges[?[skip=m][[&]limit=n][& Retrieves the SizeRange objects which

<filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating SizeRange
Method: PUT

URI Comments

./size_ranges/{size_range_id} Updates the specified SizeRange object.

Deleting SizeRange
Method: DELETE
URI Comments

./size_ranges/{size_range_id} Deletes the specified SizeRange object.

DOMAIN-ASSET RELATED APIs 660

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeRange

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
type String enum R/O
description String string R/W
dimension_1_type String enum R/W
dimension_2_type String enum R/W
is_two_dim Boolean boolean C/O
ok_for_material Boolean boolean R/W
ok_for_size_chart Boolean boolean R/W
ok_for_style Boolean boolean R/W
type String enum C/O
active_sizes List reflist R/W
base_size String ref R/W
sizes List refvector R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 661

 Centric 8 REST API DEVELOPER GUIDE

SizeSpec
Creating SizeSpec
Method: POST
URI Comments

./size_specs Creates a new SizeSpec object.

Reading SizeSpec
Method: GET
URI Comments

./size_specs/{ size_spec_id} Retrieves the specified SizeSpec object.

./size_specs[?[skip=m][[&]limit=n][& Retrieves the SizeSpec objects which

<filter_parameters>]..] match the <filter_parameters>

Updating SizeSpec
Method: PUT

URI Comments

./size_specs/{size_spec_id} Updates the specified SizeSpec object.

Deleting SizeSpec
Method: DELETE
URI Comments

./size_specs/{size_spec_id} Deletes the specified SizeSpec object.

DOMAIN-ASSET RELATED APIs 662

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SizeSpec

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
sys_id String string R/O
modified_by String ref R/O
active Boolean boolean R/W
description String string R/W
tags List stringvector R/W
images Map refmap R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 663

 Centric 8 REST API DEVELOPER GUIDE

SKU
Creating SKU
Method: POST
URI Comments

./styles/{style_id}/realized_products Creates a new SKU object as a child of Style.

Reading SKU
Method: GET
URI Comments

./skus/{sku_id} Retrieves the specified SKU object.

./skus[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./styles/{style_id}/realized_products
[?[skip=m][[&]limit=n]
Retrieves the SKU objects which match the
<filter_parameters>.
Retrieve the SKU objects referenced by Style
which match the filter parameters specified as
query string values.

[&<filter_parameters>]..]

Updating SKU
Method: PUT

URI Comments

./skus/{sku_id} Updates the specified SKU object.

Deleting SKU
Method: DELETE
URI Comments

./skus/{sku_id} Deletes the specified SKU object.

DOMAIN-ASSET RELATED APIs 664

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SKU

Data Read
Attribute Ref. Type Description
Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object
was modified.
node_name string R/W Display name for the
object.
carry_over boolean R/O
customer_earliest_target_date time R/O
customer_total_order_qty double R/O
earliest_target_date time R/O
gtin string R/O
gtin_checksum string R/O
gtin_manufacturer_code string R/O
gtin_product_code string R/O
master_carton_i_2of_5 string R/O
master_carton_i_2of_5_checksum string R/O
master_carton_i_2of_5_leading_digit string R/O
master_carton_i_2of_5_pack_code string R/O
pallet_i_2of_5 string R/O
pallet_i_2of_5_checksum string R/O
pallet_i_2of_5_leading_digit string R/O
pallet_i_2of_5_pack_code string R/O
total_order_qty double R/O
category_1 ref Category1 R/O
category_2 ref Category2 R/O
collection ref Collection R/O
comments reflist Comment R/O
documents reflist Document R/O
modified_by ref User R/O
parent_season ref Season R/O
style ref Style R/O
cnt_documents integer R/O
active boolean R/W This attribute requires
module: Calendar to be
installed. Otherwise, it is
ignored.
sku_status enum R/W
realized_color ref Colorway R/W
realized_size ref ProductSize R/W
sku_quote ref SupplierIte R/W
m
images refmap Image R/W
referenced_documents reflist Document R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 665

 Centric 8 REST API DEVELOPER GUIDE

SKUMaterial
Creating SKUMaterial
Method: POST
URI Comments

./materials/{material_id}/realized_prod Creates a new SKUMaterial object as a child of

ucts Material.

Reading SKUMaterial
Method: GET
URI Comments

./sku_materials/{sku_material_id} Retrieves the specified SKUMaterial object.

./sku_materials[?[skip=m][[&]limit=n][& Retrieves the SKUMaterial objects which

<filter_parameters>]..]
./materials/{material_id}/realized_produ
cts[?[skip=m][[&]limit=n][&<filter_param
eters>]..]
match the <filter_parameters> included in the
resource_path.
Retrieve the SKUMaterial objects referenced
by Material which match the filter parameters
specified as query string values.

Updating SKUMaterial
Method: PUT

URI Comments

./sku_materials/{sku_material_id} Updates the specified SKUMaterial object.

Deleting SKUMaterial
Method: DELETE
URI Comments

./sku_materials/{sku_material_id} Deletes the specified SKUMaterial object.

DOMAIN-ASSET RELATED APIs 666

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SKUMaterial

Data Ref. Read

Attribute Description
Type Type Only
id String CNL R/O Centric Node Locator.
Last time this object was
_modified_at String time R/O
modified.
node_name String string R/W Display name for the object.
calculated_stock_level Double double R/O
earliest_target_date String time R/O
fulfilled_qty Double double R/O
last_known_stock_level Double double R/O
pending_non_reserved_qty Double double R/O
pending_reserved_qty Double double R/O
received_qty Double double R/O
total_order_qty Double double R/O
sku_status String enum R/W
realized_color String ref R/W
realized_size String ref R/W
sku_quote String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 667

 Centric 8 REST API DEVELOPER GUIDE

SKUMaterialSource
Reading SKUMaterialSource
Method: GET
URI Comments

./sku_material_sources/ Retrieves the specified SKUMaterialSource

{sku_material_source_id}
./sku_material_sources[?[skip=m]
[[&]limit=n][& <filter_parameters>]..]
object.
Retrieves the SKUMaterialSource objects which
match the <filter_parameters> included in the
resource_path.

Updating SKUMaterialSource
Method: PUT

URI Comments

./sku_material_sources/ Updates the specified SKUMaterialSource

object.
{sku_material_source_id}

Method: POST & DELETE unsupported

SKUMaterialSource only Create and Read access.

Attribute List of SKUMaterialSource

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
sku ref SKUMaterial R/O
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 668

 Centric 8 REST API DEVELOPER GUIDE

SKUSource
Reading SKUSource
Method: GET
URI Comments

./sku_sources/{sku_source_id} Retrieves the specified SKUSource object.

./sku_sources[?[skip=m][[&]limit=n] Retrieves the SKUSource objects which match

the <filter_parameters>.
[& <filter_parameters>]..]

Updating SKUSource
Method: PUT

URI Comments

./sku_sources/{sku_source_id} Updates the specified SKUSource object.

Method: POST & DELETE unsupported

SKUSource does not support Create or Delete.

Attribute List of SKUSource

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
sku ref SKUMaterial R/O
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 669

 Centric 8 REST API DEVELOPER GUIDE

SMProduct
Reading SMProduct
Method:GET
URI Comments

./sm_products/{sm_product_id} Retrieves the specified SMProduct object.

./sm_products[?[skip=m][[&]limit=n] Retrieves the SMProduct objects which match the

<filter_parameters>.
[&<filter_parameters>]..]

Updating SMProduct
Method:PUT
URI Comments

./sm_products/{sm_product_id} Updates the specified SMProduct object.

Deleting SMProduct
Method:DELETE
URI Comments

./sm_products/{sm_product_id} Deletes the specified SMProduct object.

Method: POST is unsupported

SMProduct does not support Create.

Attribute List of SMProduct

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name string R/O Display name for the object.
This attribute requires
available module: CollectionBook to
boolean R/O
be installed. Otherwise, it is
ignored.
color_retail_price This attribute requires
_max float R/O
module: CollectionBook to

DOMAIN-ASSET RELATED APIs 670

 Centric 8 REST API DEVELOPER GUIDE

be installed. Otherwise, it is
ignored.
This attribute requires
color_retail_price module: CollectionBook to
_min float R/O
be installed. Otherwise, it is
ignored.
This attribute requires
color_retail_price module: CollectionBook to
_range string R/O
be installed. Otherwise, it is
ignored.
This attribute requires
color_wholesale_pr module: CollectionBook to
ice_max float R/O
be installed. Otherwise, it is
ignored.
This attribute requires
color_wholesale_pr module: CollectionBook to
ice_min float R/O
be installed. Otherwise, it is
ignored.
This attribute requires
color_wholesale_pr module: CollectionBook to
ice_range string R/O
be installed. Otherwise, it is
ignored.
This attribute requires
has_promo module: CollectionBook to
boolean R/O
be installed. Otherwise, it is
ignored.
This attribute requires
sales_volume module: CollectionBook to
integer R/O
be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
modified_by ref User R/O
be installed. Otherwise, it is
ignored.
This attribute requires
model_code module: CollectionBook to
string R/W
be installed. Otherwise, it is
ignored.
This attribute requires
retail_price module: CollectionBook to
double R/W
be installed. Otherwise, it is
ignored.
This attribute requires
state module: CollectionBook to
enum R/W
be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
wholesale_price double R/W
be installed. Otherwise, it is
ignored.
This attribute requires
is_primary module: CollectionBook to
boolean R/W
be installed. Otherwise, it is
ignored.

DOMAIN-ASSET RELATED APIs 671

 Centric 8 REST API DEVELOPER GUIDE

This attribute requires

colors SMProductC module: CollectionBook to
reflist R/W
olor be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
looks refset SalesLook R/W
be installed. Otherwise, it is
ignored.
This attribute requires
original_sales_col SalesCollecti module: CollectionBook to
lection ref R/W
on be installed. Otherwise, it is
ignored.
This attribute requires
related_products module: CollectionBook to
reflist SMProduct R/W
be installed. Otherwise, it is
ignored.
This attribute requires
smsk_us SMProductS module: CollectionBook to
reflist R/W
KU be installed. Otherwise, it is
ignored.
This attribute requires
sales_product_size module: CollectionBook to
s refvector ProductSize R/W
be installed. Otherwise, it is
ignored.
This attribute requires
sales_size_range module: CollectionBook to
ref SizeRange R/W
be installed. Otherwise, it is
ignored.
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 672

 Centric 8 REST API DEVELOPER GUIDE

SMProductColor
Reading SMProductColor
Method:GET
URI Comments

./sm_product_colors/{sm_product_color Retrieves the specified SMProductColor object.

_id}
./sm_products[?[skip=m][[&]limit=n] Retrieves the SMProductColor objects which
match the <filter_parameters>.
[&<filter_parameters>]..]

Updating SMProductColor
Method:PUT
URI Comments

./sm_product_colors/{sm_product_color_id} Updates the specified SMProductColor

object.

Deleting SMProductColor
Method:DELETE
URI Comments

./sm_product_colors/{sm_product_color_id} Deletes the specified SMProductColor

object.

Method: POST is unsupported

SMProductColor does not support Create

DOMAIN-ASSET RELATED APIs 673

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SMProductColor

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name string R/O Display name for the object.
This attribute requires
available module: CollectionBook to
boolean R/O
be installed. Otherwise, it is
ignored.
This attribute requires
sales_volume module: CollectionBook to
integer R/O
be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
state enum R/O
be installed. Otherwise, it is
ignored.
This attribute requires
line_items SalesOrderLi module: CollectionBook to
reflist R/O
neItem be installed. Otherwise, it is
ignored.
This attribute requires
MCProductC module: CollectionBook to
master_color ref R/O
olor be installed. Otherwise, it is
ignored.
This attribute requires
modified_by module: CollectionBook to
ref User R/O
be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
retail_price double R/W
be installed. Otherwise, it is
ignored.
This attribute requires
wholesale_price module: CollectionBook to
double R/W
be installed. Otherwise, it is
ignored.
This attribute requires
color_promos module: CollectionBook to
refset SalesPromo R/W
be installed. Otherwise, it is
ignored.
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 674

 Centric 8 REST API DEVELOPER GUIDE

SMProductSKU
Reading SMProductSKU
Method:GET
URI Comments

./sm_product_skus/{sm_product_sku_id} Retrieves the specified SMProductSKU object.

./sm_product_skus[?[skip=m][[&]limit= Retrieves the SMProductSKU objects which

n] match the <filter_parameters>.

[&<filter_parameters>]..]

Updating SMProductSKU
Method:PUT
URI Comments

./sm_product_skus/{sm_product_sku_id} Updates the specified SMProductSKU

object.

Method: POST & DELETE are unsupported

SMProductSKU does not support Create or Delete.

DOMAIN-ASSET RELATED APIs 675

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SMProductSKU

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name string R/O Display name for the object.
This attribute requires
available module: CollectionBook to
boolean R/O
be installed. Otherwise, it is
ignored.
This attribute requires
sales_volume module: CollectionBook to
integer R/O
be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
state enum R/O
be installed. Otherwise, it is
ignored.
This attribute requires
color SMProductC module: CollectionBook to
ref R/O
olor be installed. Otherwise, it is
ignored.
This attribute requires
SalesOrderLi module: CollectionBook to
line_items_sku reflist R/O
neItemSKU be installed. Otherwise, it is
ignored.
This attribute requires
master_sku MCProductS module: CollectionBook to
ref R/O
KU be installed. Otherwise, it is
ignored.
This attribute requires
module: CollectionBook to
modified_by ref User R/O
be installed. Otherwise, it is
ignored.
This attribute requires
product_size module: CollectionBook to
ref ProductSize R/O
be installed. Otherwise, it is
ignored.
This attribute requires
retail_price module: CollectionBook to
double R/W
be installed. Otherwise, it is
ignored.
This attribute requires
wholesale_price module: CollectionBook to
double R/W
be installed. Otherwise, it is
ignored.
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 676

 Centric 8 REST API DEVELOPER GUIDE

SourcingCapability
Creating SourcingCapability
Method: POST
URI Comments

./sourcing_capabilities Creates a new SourcingCapability object as a

child of Material.

Reading SourcingCapability
Method: GET
URI Comments

./sourcing_capabilities Retrieves the specified SourcingCapability

/{sourcing_capability_id} object.
./sourcing_capabilities[?[skip=m] Retrieves the SourcingCapability objects which
[[&]limit=n][& <filter_parameters>]..] match the <filter_parameters>.

Updating SourcingCapability
Method: PUT

URI Comments

./sourcing_capabilities Updates the specified SourcingCapability object.

/{sourcing_capability_id}

Deleting SourcingCapability
Method: DELETE
URI Comments

./sourcing_capabilities Deletes the specified SourcingCapability object.

/{sourcing_capability_id}

DOMAIN-ASSET RELATED APIs 677

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SourcingCapability

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at Last time this object was
time R/O
modified.
node_name Display name for the
string R/W
object.
sys_id string R/O
modified_by ref User R/O
active boolean R/W
capability_type enum R/W
description string R/W
sourcing_item_for enum R/W
images refmap Image R/W
routing_group ref RoutingGroup R/W
tags refmap Tag R/W
links (_links) C8 Ref to URL Lookup
refmap R/O
map.

DOMAIN-ASSET RELATED APIs 678

 Centric 8 REST API DEVELOPER GUIDE

SpecDataSheetSubtype
Creating SpecDataSheetSubtype
Method: POST
URI Comments

./spec_data_sheet_subtypes Create a new SpecDataSheetSubtype object.

Reading SpecDataSheetSubtype
Method: GET
URI Comments

./spec_data_sheet_subtypes/ Retrieves the specified SpecLibraryItem object.

{spec_data_sheet_subtype_id
./spec_library_items[?[skip=m] Retrieves the SpecLibraryItem objects which
match the <filter_parameters> included in the
[[&]limit=n][&<filter_parameters>].. resource_path.

Updating SpecDataSheetSubtype
Method: PUT

URI Comments

./spec_data_sheet_subtypes/ Update the specified SpecDataSheetSubtype

object.
{spec_data_sheet_subtype_id}

Deleting SpecDataSheetSubtype
Method: DELETE
URI Comments

./spec_data_sheet_subtypes/ Delete the specified SpecDataSheetSubtype

object.
{spec_data_sheet_subtype_id}

DOMAIN-ASSET RELATED APIs 679

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecDataSheetSubtype

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/O Display name for the
object.
applied_on String time R/O
modified Boolean boolean R/O
published Boolean boolean R/O
modified_by String ref R/O
active Boolean boolean R/O
enable_value_attributes Boolean boolean R/W
setup_description StringMa R/W
p
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 680


SpecificationDataSheet
Creating SpecificationDataSheet
Method: POST
URI
./materials/{material_id}/data_sheets/
specification_data_sheets
./styles/{style_id}/data_sheets/
specification_data_sheets
./specification_data_sheets
./specification_data_sheet_revisions/{
specification_data_sheet_revision_id}/
items
Reading SpecificationDataSheet
Method: GET
URI
./materials/{material_id}/data_sheets/
specification_data_sheets[?[skip=m]
[[&]limit=n] [&<filter_parameters>]..]
./styles/{style_id}/data_sheets/
specification_data_sheets[?[skip=m]
[[&]limit=n] [&<filter_parameters>]..]
./specification_data_sheets/
{specification_data_sheet_id}
./specification_data_sheets[?[skip=m]
[[&]limit=n] [&<filter_parameters>]..]
Updating SpecificationDataSheet
Method: PUT
URI Comments
./specification_data_sheets/ Updates the specified SpecificationDataSheet object.
{specification_data_sheet_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new SpecificationDataSheet object as
a child of Material.
Creates a new SpecificationDataSheet object as
a child of Style.
Creates a new SpecificationDataSheet object.
Creates a new SpecificationDataSheet object as
a child of SpecificationDataSheetRevision.
Comments
Retrieves the SpecificationDataSheet
objects referenced by Material which
match filter parameters specified as query
string values.
Retrieves the SpecificationDataSheet
objects referenced by Style which match
filter parameters specified as query string
values.
Retrieve the specified
SpecificationDataSheet object.
Retrieve the SpecificationDataSheet
objects which match <filter parameters>
specified as query string values.
681
 Centric 8 REST API DEVELOPER GUIDE

Deleting SpecificationDataSheet
Method: DELETE
URI Comments

./specification_data_sheets/ Deletes the specified SpecificationDataSheet object.

{specification_data_sheet_id}

Attribute List of SpecificationDataSheet

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
latest_revision String ref R/O
modified_by String ref R/O
revisions List<String> refvector R/O
can_track_by_calendar Boolean boolean R/W
description String string R/W
final_inspection_relevant Boolean boolean R/W This attribute requires module: AQL to
be installed. Otherwise, it is ignored.
subtype String ref C/O
for_product_source ref ProductS R/W
ource
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color is mandatory in POST method.

DOMAIN-ASSET RELATED APIs 682

 Centric 8 REST API DEVELOPER GUIDE

SpecificationDataSheetItem
Reading SpecificationDataSheetItem
Method: GET
URI Comments

./specification_data_sheet_items/ Retrieves the specified

{specification_data_sheet_item_id} SpecificationDataSheetItem object.

./specification_data_sheet_items[?[skip=m] Retrieves the SpecificationDataSheetItem

[[&]limit=n][&<filter_parameters>]..] objects which match the
<filter_parameters>

Updating SpecificationDataSheetItem
Method: PUT
URI Comments

./specification_data_sheet_items/ Updates the specified

{specification_data_sheet_item_id} SpecificationDataSheetItem object.

Deleting SpecificationDataSheetItem
Method: DELETE
URI Comments

./specification_data_sheet_items/ Deletes the specified

{specification_data_sheet_item_id} SpecificationDataSheetItem object.

Method: POST is unsupported

SpecificationDataSheetItem does not support

Create.

DOMAIN-ASSET RELATED APIs 683

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationDataSheetItem

Attribute Data Ref. Read Description

Type Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
actual ref Specifica R/O
tionSecti
onItem
modified_by ref User R/O
comment string R/W
final_inspection_relevant boolean R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
section ref Specifica C/O
tionSecti
on
definition ref Specifica C/O
tionItemD
efinition
value_boolean boolean R/W
value_double double R/W
value_int integer R/W
value_string string R/W
value_lookup_item ref LookupIt R/W
em
value_lookup_item_list reflist LookupIt R/W
em
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold blue color is mandatory in POST method to create a new object.

DOMAIN-ASSET RELATED APIs 684

 Centric 8 REST API DEVELOPER GUIDE

SpecificationDataSheetResponseItem
Reading SpecificationDataSheetResponseItem
Method: GET
URI Comments

./specification_data_sheet_response_items/{ Retrieve the specified

specification_data_sheet_response_item_id}
./specification_data_sheet_response_items
[?[skip=m][[&]limit=n][&<filter_parameters
>]..]
SpecificationDataSheetResponseItem
object.
Retrieve the
SpecificationDataSheetResponseItem
objects which match <filter parameters>
specified as query string values.

Updating SpecificationDataSheetResponseItem
Method: PUT
URI Comments

./specification_data_sheet_response_items Updates the specified

/{specification_data_sheet_response_item_ SpecificationDataSheetSupplierResponseI
id} tem object.

Method: POST & DELETE unsupported

SpecificationDataSheetSupplierResponseItem does not support

Create and Delete

DOMAIN-ASSET RELATED APIs 685

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationDataSheetResponseItem

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
Section ref ResponseSection R/O
spec_data_sheet_item ref SpecificationData R/O
SheetItem
spec_definition ref SpecificationItem R/O
Definition
host_note string R/W
is_matched_value boolean R/W
supplier_note string R/W
value_boolean boolean R/W
value_double double R/W
value_int integer R/W
value_string string R/W
value_lookup_item ref LookupItem R/W
value_lookup_item_lis reflist LookupItem R/W
t
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 686


SpecificationDataSheetRevision
Creating SpecificationDataSheetRevision
Method: POST
URI
./specification_data_sheet_revisions/
{specification_data_sheet_revision_id}
/revise
Reading SpecificationDataSheetRevision
Method: GET
URI
./specification_data_sheet_revisions/
{specification_data_sheet_revision_id}
./specification_data_sheet_revisions
[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
Updating SpecificationDataSheetRevision
Method: PUT
URI
./specification_data_sheet_revisions/
{specification_data_sheet_revision_id}
./specification_data_sheet_revisions/
{specification_data_sheet_revision_id}
?action={action_name}
Method: DELETE is unsupported
SpecificationDataSheetIRevision does not support Delete.
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new revision for the specified
SpecificationDataSheetRevision object.
Comments
Retrieves the specified
SpecificationDataSheetRevision object.
Retrieves the SpecificationDataSheetRevision
objects which match the <filter_parameters>
Comments
Updates the specified
SpecificationDataSheetRevision object.
Update the specified
SpecificationDataSheetRevision object
and changes the revision state based on
the actions enum list [APPROVED,
ABANDONED, FREEZE, REOPEN,
REVIEW, PURGEREVISION,
PURGERESETREVISION]
687
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_numbe integer R/O
r
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
all_sections refvector SpecificationSe R/O
ction
approver ref User R/O
items refvector SpecificationDa R/O
taSheetItem
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
description string R/W
revision_comment string R/W
shared_sections refset SpecificationSe R/W
ction
_url_base_template string R/O File (image, pdf, document) retrieval
URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 688

 Centric 8 REST API DEVELOPER GUIDE

SpecificationDataSheetSupplierResponse
Reading SpecificationDataSheetSupplierResponse
Method: GET
URI Comments

./specification_data_sheet_supplier_respons Retrieves the specified

es/ SpecificationDataSheetSupplierResponse
{specification_data_sheet_supplier_response object.
_id}
./specification_data_sheet_supplier_respon Retrieves the
ses SpecificationDataSheetSupplierResponse
objects which match <filter parameters>
[?[skip=m][[&]limit=n][&<filter_parameters specified as query string value.
>]..]

Updating SpecificationDataSheetSupplierResponse
Method: PUT
URI Comments

./specification_data_sheet_supplier_respo Updates the specified

nses/ SpecificationDataSheetSupplierResponse
{specification_data_sheet_supplier_respon object.
se_id}

Method: POST & DELETE unsupported

SpecificationDataSheetSupplierResponse is a read and update only

endpoint. It does not support Create, Update or Delete.

DOMAIN-ASSET RELATED APIs 689

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationDataSheetResponseItem

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
current_revision ref SpecificationDataSh R/O
eetSupplierRespons
eRevision
latest_revision ref SpecificationDataSh R/O
eetSupplierRespons
eRevision
modified_by ref User R/O
revisions refvector SpecificationDataSh R/O
eetSupplierRespons
eRevision
srli_response ref SRLineItem R/O
supplier_items refset SupplierItem R/O
description string R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 690

 Centric 8 REST API DEVELOPER GUIDE

SpecificationDataSheetSupplierResponseRevision
Creating SpecificationDataSheetSupplierResponseRevision
Method: POST
URI Comments

./specification_data_sheet_supplier_re Creates revision for the specified

sponse_revisions/ specification_data_sheet_supplier_response_rev
ision_id object.
{specification_data_sheet_supplier_res
ponse_revision_id}/

revise

Reading SpecificationDataSheetSupplierResponseRevision
Method: GET
URI Comments

./specification_data_sheet_supplier_re Retrieves the specified

sponse_revisions/ SpecificationDataSheetSupplierResponseRevisi
on object.
{specification_data_sheet_supplier_res
ponse_revision_id}

./specification_data_sheet_supplier_re Retrieves the

sponse_revisions SpecificationDataSheetSupplierResponseRevisi
on objects which match <filter parameters>
[?[skip=m][[&]limit=n][&<filter_parame specified as query string values.
ters>]..]

Updating SpecificationDataSheetSupplierResponseRevision
Method: PUT
URI Comments

./specification_data_sheet_supplier_respo Updates the specified

nse_revisions/ SpecificationDataSheetSupplierRespons
eRevision object.
{specification_data_sheet_supplier_respon
se_revision_id}

./specification_data_sheet_supplier_respo Update the specified

nse_revisions/ SpecificationDataSheetSupplierRespons
eRevision object and changes the
{specification_data_sheet_supplier_respon revision state based on the actions enum
se_revision_id} list [APPROVED, ABANDONED,
FREEZE, REOPEN, REVIEW,
?action={action_name} PURGEREVISION,
PURGERESETREVISION]

DOMAIN-ASSET RELATED APIs 691

 Centric 8 REST API DEVELOPER GUIDE

Method: DELETE is unsupported

SpecificationDataSheetSupplierResponseRevision does not support

Delete.

Attribute List of SpecificationDataSheetRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
approval_time time R/O
clarification_number integer R/O
is_current boolean R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref SpecificationDataS R/O
heetSupplierRespo
nseRevision
items refvector SpecificationDataS R/O
heetResponseItem
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
response_sections refvector ResponseSection R/O
revert_user ref User R/O
review_user ref User R/O
spec_data_sheet_revi ref SpecificationDataS R/O
sion heetRevision
state_change_user ref User R/O
description string R/W
quote_fob_price double R/W
quote_moq_initial integer R/W
revision_comment string R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 692

 Centric 8 REST API DEVELOPER GUIDE

SpecificationItemDefinition
Creating SpecificationItemDefinition
Method: POST
URI Comments

./specification_item_definitions Create a new SpecificationItemDefinition

object.

Reading SpecificationItemDefinition
Method: GET
URI Comments

./specification_item_definitions/ Retrieve the specified

{ specification_item_definition_id} SpecificationItemDefinition object.

./specification_item_definitions Retrieve the SpecificationItemDefinition

[?[skip=m][[&]limit=n] objects which match the
[&<filter_parameters>]..] <filter_parameters> included in the
resource_path.

Updating SpecificationItemDefinition
Method: PUT
URI Comments

./specification_item_definitions/ Updates the specified

{ specification_item_definition_id} SpecificationItemDefinition object.

Deleting SpecificationItemDefinition
Method: DELETE
URI Comments

./specification_item_definitions/ Deletes the specified

{ specification_item_definition_id} SpecificationItemDefinition object.

DOMAIN-ASSET RELATED APIs 693

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationItemDefinition

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was

modified.
node_name string R/O Display name for the object.

sys_id string R/O

modified_by ref User R/O

value_attribute_definition ref valueAttrib

uteDefiniti
on
active boolean R/W

code string R/W

description string R/W

final_inspection_relevant boolean R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
images refmap Image R/W
subtype ref SpecificationDa C/O
taSheetSubtyp
e
tags refmap Tag R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 694

 Centric 8 REST API DEVELOPER GUIDE

SpecificationSection
Creating SprecificationSection
Method: POST
URI Comments

./specification_data_sheet_revisions/{spe Create a new SpecificationSection

cification_data_sheet_revision_id}/all_se object as a child of
ctions/specification_section SpecificationDataSheetRevision.

Reading SpecificationSection
Method: GET
URI Comments

./specification_data_sheet_revisions/{sp Retrieve the SpecificationSection objects

ecification_data_sheet_revision_id}/all_
sections/specification_section[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./specification_sections/{
specification_section_id}
referenced by
SpecificationDataSheetRevision which match
filter parameters specified as query string
values.
Retrieve the specified SpecificationSection
object.

./specification_item_definitions[?[skip= Retrieve the SpecificationSection objects

m][[&]limit=n][&<filter_parameters>]..] which match the <filter_parameters> included
in the resource_path.

Updating SpecificationSection
Method: PUT
URI Comments

./specification_sections/{ Updates the specified

specification_section_id} SpecificationItemDefinition object.

Deleting SpecificationSection
Method: DELETE
URI Comments

./specification_sections/{ Deletes the specified

specification_section_id} SpecificationItemDefinition object.

DOMAIN-ASSET RELATED APIs 695

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationSection

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.

_modified_at String time R/O Last time this object was

modified.
node_name String string R/O Display name for the object.

sys_id String string R/O

modified_by String ref R/O

section_items List<String> refvecto R/O

r
active Boolean boolean R/W

description String string R/W

definition String ref C/O

images Map<String, String> refmap R/W

tags Map<String, String> refmap R/W

links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 696

 Centric 8 REST API DEVELOPER GUIDE

SpecificationSectionDefinition
Creating SpecificationSectionDefinition
Method: POST
URI Comments

./specification_section_definitions Create a new SpecificationSectionDefinition

object.

Reading SpecificationSectionDefinition
Method: GET
URI Comments

./specification_section_definitions/{ Retrieve the specified

specification_section_definition_id} SpecificationSectionDefinition object.
./specification_section_definitions[?[skip Retrieve the SpecificationSectionDefinition
=m][[&]limit=n][&<filter_parameters>]..] objects which match the <filter_parameters>
included in the resource_path.

Updating SpecificationSectionDefinition
Method: PUT
URI Comments

./specification_section_definitions/{spe Updates the specified

cification_section_definition_id} SpecificationSectionDefinition object.

Deleting SpecificationSectionDefinition
Method: DELETE
URI Comments

./specification_section_definitions/{spe Deletes the specified

cification_section_definition_id} SpecificationSectionDefinition object.

DOMAIN-ASSET RELATED APIs 697

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationSectionDefinition

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.

_modified_at String time R/O Last time this object was

modified.
node_name String string R/O Display name for the object.

sys_id String string R/O

modified_by String ref R/O

shared_sections List<String> refset R/O

active Boolean boolean R/W

description String string R/W

images Map<String, String> refmap R/W

subtype String ref C/O

tags Map<String, String> refmap R/W

links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 698


SpecificationSectionItem
Creating SpecificationSectionItem
Method: POST
URI
./specification_sections/
{specification_section_id}/
section_items
Reading SpecificationSectionItem
Method: GET
URI
./specification_sections/
{specification_section_id}/
section_items[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./specification_section_items/
{specification_section_item_id}/
./specification_section_items[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
Updating SpecificationSectionItem
Method: PUT
URI
./specification_section_items/{specifica
tion_section_item_id}
Deleting SpecificationSectionItem
Method: DELETE
URI
./specification_section_items/{specifica
tion_section_item_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a new SpecificationSectionItem as a
child of SpecificationSection object.
Comments
Retrieve the specified
SpecificationSectionItem object referenced
by SpecificationSection which match filter
parameters.
Retrieve the specified
SpecificationSectionItem object
Retrieve the SpecificationSectionItem
objects which match filter parameters.
Comments
Updates the specified
SpecificationSectionItem object.
Comments
Deletes the specified
SpecificationSectionItem object.
699
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecificationSectionItem

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was

modified.
node_name string R/W Display name for the object.

special boolean R/O

modified_by ref User R/O

applicable_value_lookup_i reflist LookupItem R/O

tems
description string R/W
final_inspection_relevant boolean R/W This attribute requires
module: AQL to be installed.
Otherwise, it is ignored.
definition ref SpecificationItemD C/O
efinition
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 700

 Centric 8 REST API DEVELOPER GUIDE

SpecLibraryItem Deprecated
Creating SpecLibraryItem
Method: POST
URI Comments

./spec_library_items Creates a new SpecLibraryItem object.

Reading SpecLibraryItem
Method: GET
URI Comments

./spec_library_items/{spec_library_item_id} Retrieves the specified SpecLibraryItem

object.
./spec_library_items[?[skip=m][[&]limit=n] Retrieves the SpecLibraryItem objects which
[&<filter_parameters>]..] match the <filter_parameters> included in the
resource_path.

Updating SpecLibraryItem
Method: PUT

URI Comments

./spec_library_items/{spec_library_item_id} Updates the specified SKUMaterial object.

Deleting SpecLibraryItem
Method: DELETE
URI Comments

./spec_library_items/{spec_library_item_id} Deletes the specified SKUMaterial object.

DOMAIN-ASSET RELATED APIs 701

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SpecLibraryItem

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
sys_id String string R/O System ID
active Boolean boolean R/W Active Item
code String string R/W
description String string R/W
final_inspection_relevant Boolean boolean R/W Used if AQL is installed, else ignored
tags List stringvector R/W
library_item_sds_subtype String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

• The attribute in bold blue color is mandatory in POST method to create a new SpecLibraryItem object.

DOMAIN-ASSET RELATED APIs 702

 Centric 8 REST API DEVELOPER GUIDE

SRLineItem
Creating SRLineItem
Method: POST
URI Comments

./supplier_requests/{supplier_request_i Create a new SRLineItem object as a child

d}/sr_line_items of SupplierRequest.

Reading SRLineItem
Method: GET
URI Comments

./supplier_requests/{supplier_request_id}/ Retrieve the SRLineItem objects

sr_line_items[?[skip=m][[&]limit=n][&<filt referenced by SupplierRequest which
er_parameters>]..] match filter parameters specified as query
string values.
./sr_line_items/{sr_line_item_id} Retrieve the specified SRLineItem object.

./sr_line_items[?[skip=m][[&]limit=n][&<fi Retrieve the SRLineItem objects which

lter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating SRLineItem
Method: PUT
URI Comments

./sr_line_items/{sr_line_item_id} Updates the specified SRLineItem object.

Deleting SRLineItem
Method: DELETE
URI Comments

./sr_line_items/{sr_line_item_id} Deletes the specified SRLineItem object.

DOMAIN-ASSET RELATED APIs 703

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SRLineItem

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.

_modified_at String time R/O Last time this object was

modified.
node_name String string R/O Display name for the
object.
alternate_files Map urlmap R/O
category_1 String string R/O

category_2 String string R/O

code String string R/O

collection String string R/O

pdf String url R/O

season String string R/O

sr_line_item_product String ref R/W
sr_line_item_samples List reflist R/O
description String string R/W

message String string R/W

links (_links) Map refmap R/O C8 Ref to URL Lookup

map.
_url_base_template String string R/O File (image, pdf, document)
retrieval URL template.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 704

 Centric 8 REST API DEVELOPER GUIDE

Stock Order
Creating StockOrder
Method: POST
URI Comments

./supplier_requests/{supplier_request_i Create a new StockOrder object as a child

d}/stock_order of SupplierRequest.

Reading StockOrder
Method: GET
URI Comments

./supplier_requests/{supplier_request_id}/ Retrieve the StockOrder objects referenced

stock_order[?[skip=m][[&]limit=n][&...]] by SupplierRequest which match filter
parameters specified as query string
values.
./ stock_orders/{stock_order_id} Retrieve the specified StockOrder object.

./stock_orders[?[skip=m][[&]limit=n][&...] Retrieve the StockOrder objects which

] match <filter_parameters> specified as
query string values.

Updating StockOrder
Method: PUT
URI Comments

./stock_orders/{stock_order_id} Updates the specified StockOrder object.

Deleting StockOrder
Method: DELETE
URI Comments

./stock_orders/{stock_order_id} Deletes the specified StockOrder object.

DOMAIN-ASSET RELATED APIs 705

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of StockOrder

Attribute Data Type Object Read Only Description

id CNL R/O C8 System ID

_modified_at time R/O Last time this object was

modified.
node_name string R/O Display name for the
object.
baseline_date_time time R/O
state enum R/O

state_change_date_time time R/O

modified_by ref User R/O

deliver_by time R/W

fulfiller_comment string R/W

is_reservation boolean R/W

priority enum R/W
requester_comment stirng R/W
baseline_change_user ref User R/W

so_requester ref User R/W

so_season ref Season R/W

so_state_change_user ref User R/W File (image, pdf, document)

retrieval URL template.
so_warehouse ref Supplier R/W
links(_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 706


Style
Creating or Copying a Style
Method: POST
URI
./collections/{collection_id}
/hierarchy
./supplier_requests/
{supplier_request_id}
/sr_line_item_product
./styles/copy
./styles/{style_id}/copy_colo
rway
Copying a Colorway to a Style
Method: POST
URI
./styles/copy_colorway
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new Style object as a child of the specified
Collection.
Creates a new Style object as a child of the
SupplierRequest
Makes a copy of the Style as per data payload
information. Pass the source Style information in the data
payload as shown below:
{
“from_style_id” : ”C1234”,
“style_copy_options_id” : ”C42345”,
“node_name” : “New Copied Style from C1234”
}
Copies an existing colorway from the original style to the
carriedover style.
Comments
Carry Over Colorway:
"colorway_id": "centric://APPAREL/Colorway/8_3",
"to_style_id": "centric://APPAREL/Style/8",
"node_name": "string77",
707
 Centric 8 REST API DEVELOPER GUIDE

"description": "string",

"color_specification":
"centric://APPAREL/ColorSpecification/14",

"add_to_bom": true,

"carry_over_skus": true

Reading Style
Method: GET
URI Comments

./collections/{collection_id}/hierarchy Retrieves the Style objects owned by Collection

[?[skip=m][[&]limit=n][&<filter_paramet
ers>]..]
./supplier_requests/{supplier_request_
id}/
sr_line_item_product[?[skip=m][[&]limi
t=n]
[&<filter_parameters>]..]
which match the <filter_parameters> included in
the resource_path.
Retrieves the Style objects owned by
SupplierRequest which match the
<filter_parameters> included in the
resource_path.

./styles/{style_id} Retrieves the specified Style object.

./styles[?[skip=m][[&]limit=n] Retrieves the Style objects which match the

[&<filter_parameters>]..] <filter_parameters> included in the
resource_path.

Updating/moving Style
Method: PUT
URI Comments

./styles/{style_id} Updates the specified Style object.

”append_images” is a global header.
If the user changes the “append_images” header value:
True: Add to existing images in the object.
False: Default behavior, that is, the images are passed as part
of the API call will be overwritten over the existing ones.

DOMAIN-ASSET RELATED APIs 708

 Centric 8 REST API DEVELOPER GUIDE

./styles/move Moves a specific style from a Collection to another Collection.

pass the Style id and the new parent

Collection id in the data payload as
follows in the Json payload example:

{
“parent_id”:”string”,
“style_id”:”string”
}

Deleting Style
Method: DELETE
URI Comments

./styles/{style_id} Deletes the specified Style object.

Attribute List of Style

Attribute Data Ref. Type Read Description

Type Only
id String CNL R/O Centric Node Locator.

_modified_at time R/O Last time this object was

modified.
node_name string R/W Display name for the
object.
bom_main_material_count integer R/O
carry_over boolean R/O
cnt_colorway integer R/O
cnt_customer_purchase_order integer R/O
cnt_order integer R/O
cnt_purchased_order integer R/O
earliest_target_date time R/O
inline boolean R/O
is_size_owner boolean R/O
original_season string R/O

DOMAIN-ASSET RELATED APIs 709

 Centric 8 REST API DEVELOPER GUIDE

Attribute Data Ref. Type Read Description

Type Only
total_order_volume double R/O
total_shipment_qty double R/O
bom_main_materials refset Material R/O
bom_materials refset Material R/O
carried_over_from_styles reflist Style R/O
category_1 ref Category1 R/O
category_2 ref Category2 R/O
collection ref Collection R/O
comments reflist Comment R/O
copied_from ref Style R/O
created_from_sample ref Sample R/O
data_sheets reflist PropertiesDataSheet; R/O
Artwork; SizeChart;
DataSheetSizeLabel;
SpecDataSheet;
ReviewStyle; TestRun;
ApparelBOM; Routing;
ImageDataSheet;
SizeChartReview
documents reflist Document R/O
issues reflist Issue; OperationsIssue R/O
modified_by ref User R/O

parent_season ref Season R/O

product_colors reflist Colorway R/O
product_sizes refvector ProductSize R/O
product_sources refset ProductSource R/O
production_colorways refset Colorway R/O

realized_products reflist SKU R/O

sample_colorways refset Colorway R/O
product_sales_regions reflist ProductSalesRegion R/O
style_mpv ref MerchProductVersion R/O This attribute requires
module: Merchandising to
be installed. Otherwise, it
is ignored.
cnt_documents integer R/O
style_supplier_attributes ref StyleSupplierAttributes R/O
active boolean R/W
code string R/W
description string R/W
development_type enum R/W

fob_calc double R/W

fob_negotiated double R/W
main_materials string R/W
sample_cost double R/W

actual_size_range ref SizeRange R/W

DOMAIN-ASSET RELATED APIs 710

 Centric 8 REST API DEVELOPER GUIDE

Attribute Data Ref. Type Read Description

Type Only
assigned_agents reflist Supplier R/W
authority_bom ref ApparelBOM R/W
classifier_3 ref Classifier3 R/W
default_color ref Colorway R/W
default_size ref ProductSize R/W
images refmap Image R/W
marketing_main_material ref Material R/W This attribute requires
module: CollectionBook t
o be installed. Otherwise,
it is ignored.
product_alternatives reflist ProductAlternative R/W
product_type ref StyleType C/O
production_quote ref SupplierItem R/W

purchased_order_products reflist purchasedOrderProducts R/W

sample_quote ref SupplierItem R/W
shape ref Shape R/W
size_set_sample_sizes reflist ProductSize R/W

theme ref Theme R/W

designated_product_source ref ProductSource R/W
mass_copy boolean R/W
referenced_documents reflist Document R/W
referenced_documents reflist Document R/W
crew ref Crew R/W
crew_type ref CrewType R/W
ok_variation_by_bom_size boolean R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.
style_copy_options_id R/O Style template id.
This attribute accepts
“style_copy_options” id.

• The attribute in bold brown color represents OOTB mandatory attribute.

Attribute Value Considerations

The production_quote and sample_quote attributes, if present, then they

must:

• Reference a valid active SupplierItem for the Style.

• The SupplierItem referenced as *_quote's product_source must belong to
the the Style.
• The current SupplierItemRevision referenced via *_quote must be in a
valid state: [DRAFT, PENDING, or APPROVED].
• If the *_quote specifies a product_source, the product_source must be
active.

DOMAIN-ASSET RELATED APIs 711

 Centric 8 REST API DEVELOPER GUIDE

StyleCopyOption
Reading StyleType
Method: GET
URI Comments

./style_copy_options/ Retrieves the specified StyleCopyOption object.

{style_copy_option_id}
./style_copy_options[?[skip=m] Retrieves the StyleCopyOption objects which
[[&]limit=n][& <filter_parameters>]..] match the <filter_parameters> included in the
resource_path.

Method: POST, PUT, DELETE unsupported

StyleCopyOption is a read-only endpoint. It does not

support Create, Update or Delete.

Attribute List of StyleCopyOption

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
index stringvector R/O
options_value_paths stringvector R/O
root_sub_type_name string R/O
root_type string R/O

root_types stringvector R/O

modified_by ref User R/O
ok_for_adoption boolean R/W
ok_for_merchandising_ boolean R/W This attribute requires module: Merchandising to
carryover be installed. Otherwise, it is ignored.
options_locked boolean R/W
options_visible boolean R/W
root_sub_type ref C/O
__revision_behavior enum R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 712

 Centric 8 REST API DEVELOPER GUIDE

StyleType
Creating StyleType
Method: POST
URI Comments

./style_types Creates a new StyleType object.

Reading StyleType
Method: GET
URI Comments

./style_types/{style_type_id} Retrieves the specified StyleType object.

./style_types[?[skip=m][[&]limit=n] Retrieves the StyleType objects which

[& <filter_parameters>]..] match the <filter_parameters> included in
the resource_path.

Updating StyleType
Method: PUT
URI Comments

./style_types/{style_type_id} Updates the specified StyleType object.

Deleting StyleType
Method: DELETE
URI Comments

./style_types/{style_type_id} Deletes the specified StyleType object.

DOMAIN-ASSET RELATED APIs 713

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of StyleType

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/O Display name for the object.
allow_create_c boolean R/O
olor_spec_on_c
olorway
published Boolean boolean R/O Indicates whether the StyleType has been
published for production use.
modified_by ref User R/O
enable_sku_sou boolean R/O
rces
enable_style_s boolean R/O
upplier_attrib
utes
available Boolean boolean R/O Indicates whether the StyleType is active.
has_color Boolean boolean R/O Indicates whether the StyleType allows colors.
has_size Boolean boolean R/O Indicates whether the StyleType allows size.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 714

 Centric 8 REST API DEVELOPER GUIDE

StyleSupplierAttributes
Reading StyleSupplierAttributes
Method: GET
URI Comments

./style_supplier_attributes/ Retrieves the specified StyleSupplierAttribute object.

{style_supplier_attributes_id}
./style_supplier_attributes Retrieves the StyleSupplierAttribute objects which match
[?[skip=m][[&]limit=n] the <filter_parameters>.
[& <filter_parameters>]..]

Updating StyleSupplierAttributes
Method: PUT
URI Comments

./style_supplier_attributes/ Updates the specified StyleSupplierAttribute object.

{style_supplier_attributes_id}

Method: POST, DELETE are Unsupported

StyleSupplierAttributes is a read and Update only

endpoint.

Attribute List of StyleSupplierAttributes

Attribute Data Type Ref. Type Access Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 715

 Centric 8 REST API DEVELOPER GUIDE

SubQuestion
Creating SubQuestion
Method: POST
URI Comments

./question_revisions/{question_revisio Creates a new SubQuestion object as a

n_id}/sub_questions child of QuestionRevision.

Reading SubQuestion
Method: GET
URI Comments

./question_revisions/{question_revision_id} Retrieve the SupplierDiscount objects

/sub_questions[?[skip=m][[&]limit=n][&<filt
er_parameters>]..]
./supplier_discounts/{supplier_discount_id}
./supplier_discounts[?[skip=m][[&]limit=n][
& <filter_parameters>]..]
referenced by Supplier which matches the
<filter_parameters>.
Retrieves the specified SupplierDiscount
object.
Retrieves the SupplierDiscount objects
which matches the <filter_parameters>

Updating SubQuestion
Method: PUT
URI Comments

./supplier_discounts/{supplier_discount_id} Updates the specified SupplierDiscount

object.

Deleting SubQuestion
Method: DELETE
URI Comments

./supplier_discounts/{supplier_discount_id} Deletes the specified SupplierDiscount

object.

DOMAIN-ASSET RELATED APIs 716

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SubQuestion

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires
module: Operations to be installed.
Otherwise, it is ignored.
applicable_question_ String enum C/O This attribute requires
response module: Operations to be installed.
Otherwise, it is ignored.
localized_name Map<String, stringmap R/W
String>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 717

 Centric 8 REST API DEVELOPER GUIDE

SubRouting
Creating SubRouting
Method: POST
URI Comments

./sub_routings Creates a new SubRouting object.

Reading SubRouting
Method: GET
URI Comments

./sub_routings/{sub_routing_id} Retrieve the specified SubRouting object.

./sub_routings[?[skip=m][[&]limit=n] Retrieves the SubRouting objects which matches
[& <filter_parameters>]..] the <filter_parameters>.

Updating SubRouting
Method: PUT
URI Comments

./sub_routings/{sub_routing_id} Updates the specified SubRouting object.

Deleting SubRouting
Method: DELETE
URI Comments

./sub_routings/{sub_routing_id} Deletes the specified SubRouting object.

DOMAIN-ASSET RELATED APIs 718

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SubRouting

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
current_revision ref SubRouting R/O
Revision
latest_revision ref SubRouting R/O
Revision
modified_by ref User R/O
revisions refvector SubRouting R/O
Revision
active boolean R/W
can_track_by_calendar boolean R/W
description string R/W
for_product_source ref ProductSource R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 719

 Centric 8 REST API DEVELOPER GUIDE

SubRoutingItem
Creating SubRoutingItem
Method: POST
URI Comments

./sub_routing_revisions/{sub_routing_ Creates a new SubRoutingItem object as a

revision_id}/items child of SubRoutingRevision.

Reading SubRoutingItem
Method: GET
URI Comments

./sub_routing_items/ Retrieve the specified SubRoutingItem object.

{sub_routing_item_id}
./sub_routing_revisions/
{sub_routing_revision_id}/items
[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./sub_routing_items[?[skip=m]
[[&]limit=n][& <filter_parameters>]..]
Retrieves the SubRoutingItem objects referenced
by SubRoutingRevision, which matches the
<filter_parameters>.
Retrieves the SubRoutingItem objects which
matches the <filter_parameters>.

Updating SubRoutingItem
Method: PUT
URI Comments

./sub_routing_items/ Updates the specified SubRoutingItem object.

{sub_routing_item_id}

Deleting SubRoutingItem
Method: DELETE
URI Comments

./sub_routing_items/ Deletes the specified SubRoutingItem object.

{sub_routing_item_id}

DOMAIN-ASSET RELATED APIs 720

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SubRoutingItem

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
group_number integer R/O
sequence_number integer R/O
modified_by ref User R/O
comment string R/W
actual ref SourcingCapability; R/W
SubRoutingRevision
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 721

 Centric 8 REST API DEVELOPER GUIDE

SubRoutingRevision
Creating SubRoutingRevision
Method: POST
URI Comments

./sub_routing_revisions/{sub_routing_ Creates a new revision for the specified

revision_id}/revise SubRoutingRevision.

Reading SubRoutingRevision
Method: GET
URI Comments

./sub_routing_revisions/{sub_routing_ Retrieve the specified SubRoutingRevision object.

revision_id}
./sub_routing_revisions[?[skip=m][[&] Retrieves the SubRoutingRevision objects which
limit=n][& <filter_parameters>]..] matches the <filter_parameters>.

Updating SubRoutingRevision
Method: PUT
URI Comments

./sub_routing_revisions/ Updates the specified SubRoutingItem object.

{sub_routing_revision_id}
./sub_routing_revisions/
{sub_routing_revision_id}
?action={action_name}
Updates the specified SubRoutingItem object and change the
state based on the action parameter value. The valid values are
[ APPROVED, ABANDONED, FREEZE, REOPEN, REVIEW,
PURGEREVISION, PURGERESETREVISION]

Method: DELETE is unsupported

SubRoutingRevision does not support Delete.

DOMAIN-ASSET RELATED APIs 722

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SubRoutingRevision

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
approval_time time R/O
clarification_numb integer R/O
er
is_current boolean R/O
pdf url R/O
pending_2_time time R/O
pending_time time R/O
revert_time time R/O
review_time time R/O
state enum R/O
state_change_time time R/O
usable boolean R/O
approver ref User R/O
current_revision ref SubRoutingRevision R/O
items refvector DSLineDivider; R/O
SubRoutingItem
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
description string R/W
revision_comment string R/W
routing_group ref RoutingGroup R/W
_url_base_template string R/O File (image, pdf,
document) retrieval URL
template.
links (_links) refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 723

 Centric 8 REST API DEVELOPER GUIDE

Supplier
Creating Supplier
Method: POST
URI Comments

./suppliers Creates a new Supplier object.

Reading Supplier
Method: GET
URI Comments

./suppliers/{supplier_id} Retrieves the specified Supplier object.

./suppliers[?[skip=m][[&]limit=n][& Retrieves the Supplier objects which match the

<filter_parameters>]..] <filter_parameters> included in the
resource_path.

Updating Supplier
Method: PUT
URI Comments

./suppliers/{supplier_id} Updates the specified Supplier object.

Deleting Supplier
Method: DELETE
URI Comments

./suppliers/{supplier_id} Deletes the specified Supplier object.

DOMAIN-ASSET RELATED APIs 724

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Supplier

Attribute Data Type Ref. Type Read Only Description

id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
actual_lead_time integer R/O
compliant boolean R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
offline boolean R/O
on_time double R/O
po_count integer R/O
ship_date_variance integer R/O
agent ref Supplier R/O
comments reflist Comment R/O
contacts refvector Contact R/O
documents reflist Document R/O
cnt_documents integer R/O
modified_by ref User R/O
address string R/W
address_1 string R/W
address_2 string R/W
city string R/W
classification enum R/W
commission_pct double R/W
company string R/W
currency string R/W
email string R/W
fax string R/W
is_agent boolean R/W
is_supplier boolean R/W
is_warehouse boolean R/W
job_title string R/W
language string R/W
lead_time string R/W
localized_address string R/W
lock string R/W
moq_initial integer R/W
moq_reorder integer R/W
mobile string R/W
payment_term string R/W
phone_number string R/W
photocopy_number string R/W
postal_code string R/W
purpose string R/W
state enum R/W
supplier_number string R/W
supplier_payer_number string R/W
telex string R/W

DOMAIN-ASSET RELATED APIs 725

 Centric 8 REST API DEVELOPER GUIDE

trade_term enum R/W

type_code string R/W
type_desc string R/W
website string R/W
country ref Country R/W
default_discount ref SupplierDiscou R/W
nt
discounts reflist SupplierDiscou R/W
nt
factories reflist Factory R/W
images refmap Image R/W
province_state ref ProvinceState R/W
suppliers reflist Supplier R/W
all_agents reflist Supplier R/W
sales_region_agents refmap Supplier R/W
referenced_documents reflist Document R/W
operations_reviews reflist SupplierReview R/W This attribute requires
module: Operations to be
installed. Otherwise, it is
ignored.
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 726

 Centric 8 REST API DEVELOPER GUIDE

SupplierContractualDocument
Creating SupplierContractualDocument
Method: POST
URI Comments

./suppliers/{supplier_id}/supplier_c_docs Creates a new

SupplierContractualDocument object as
a child of Supplier.

Reading SupplierContractualDocument
Method: GET
URI Comments

./suppliers/{supplier_id}/supplier_c_docs Retrieves the specified

[?[skip=m][[&]limit=n][&<filter_parameters>]..]
./supplier_contractual_documents/
{supplier_contractual_document_id}
SupplierContractualDocument object
referenced by Supplier and match
the <filter_parameters>.
Retrieves the specified
SupplierContractualDocument

./supplier_contractual_documents Retrieves the

[?[skip=m][[&]limit=n][&<filter_parameters>]..] SupplierContractualDocument
objects which match the
<filter_parameters> included in the
resource_path.

Updating SupplierContractualDocument
Method: PUT
URI Comments

./supplier_contractual_documents/ Updates the specified

{supplier_contractual_document_id} SupplierContractualDocument object.

Deleting SupplierContractualDocument
Method: DELETE
URI Comments

./supplier_contractual_documents/ Deletes the specified

{supplier_contractual_document_id} SupplierContractualDocument object.

DOMAIN-ASSET RELATED APIs 727

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierContractualDocument

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
kpi enum R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
usable_for_supplier boolean R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
visible_for_supplier boolean R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
current_revision ref Supplier R/O
Contract
ualDocu
mentRevi
sion
latest_revision ref Supplier R/O
Contract
ualDocu
mentRevi
sion
modified_by ref User R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
phase_current_revisio refmap Supplier R/O
ns Contract
ualDocu
mentRevi
sion
description string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
required boolean R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
source_type enum C/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
factory ref Factory R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
revisions refvector Supplier R/W
Contract
ualDocu
mentRevi
sion
subtype ref Supplier C/O This attribute requires module: Quality to be
Contract installed. Otherwise, it is ignored.
ualDocu
mentSubt
ype
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 728

 Centric 8 REST API DEVELOPER GUIDE

SupplierDiscount
Creating SupplierDiscount
Method: POST
URI Comments

./suppliers/{supplier_id}/discounts Creates a new SupplierDiscount object as a

child of Supplier.

Reading SupplierDiscount
Method: GET
URI Comments

./suppliers/{supplier_id}/discounts[?[skip= Retrieve the SupplierDiscount objects

m][[&]limit=n][&<filter_parameters>]..]
./supplier_discounts/{supplier_discount_id}
./supplier_discounts[?[skip=m][[&]limit=n][
& <filter_parameters>]..]
referenced by Supplier which matches
the <filter_parameters> .
Retrieves the specified SupplierDiscount
object.
Retrieves the SupplierDiscount objects
which matches the <filter_parameters>

Updating SupplierDiscount
Method: PUT
URI Comments

./supplier_discounts/{supplier_discount_id} Updates the specified SupplierDiscount

object.

Deleting SupplierDiscount
Method: DELETE
URI Comments

./supplier_discounts/{supplier_discount_id} Deletes the specified SupplierDiscount

object.

DOMAIN-ASSET RELATED APIs 729

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierDiscount

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.

_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
active Boolean boolean R/W
discount_pct Double double R/W
effective_to String time R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 730


SupplierItem
Creating SupplierItem
Method: POST
URI
./product_sources/{product_source_id}/
supplier_items
Reading SupplierItem
Method: GET
URI
./product_sources/{product_source_id}/
supplier_items[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
./supplier_items/{supplier_item_id}
./supplier_items[?[skip=m][[&]limit=n]
[& <filter_parameters>]..]
Updating SupplierItem
Method: PUT
URI
./supplier_items/{supplier_item_id}
Deleting SupplierItem
Method: DELETE
URI
./supplier_items/{supplier_item_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new SupplierItem object as a
child of ProductSource.
Comments
Retrieve the SupplierItem objects referenced
by ProductSource which matches the
<filter_parameters> .
Retrieves the specified SupplierItem object.
Retrieves the SupplierItem objects which
matches the <filter_parameters>
Comments
Updates the specified SupplierItem object.
Comments
Deletes the specified SupplierItem object.
731
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierItem

Attribute Data Ref. Read Only Description

Type Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
offline Boolean boolean R/O
offline_import_error String string R/O
sq_selected Boolean boolean R/O
current_revision String ref R/O
documents List<String reflist R/O
>
latest_revision String ref R/O
modified_by String ref R/O
revisions List<String refvector R/O
>
cnt_documents Integer integer R/O
description String string R/W
quote_sr_line_item String ref R/W
referenced_documents List<String reflist R/W
>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 732


SupplierItemRevision
Creating revision for SupplierItemRevision
Method: POST
URI
./supplier_item_revisions/{supplier_it
em_revision_id}/revise
Reading SupplierItemRevision
Method: GET
URI
./supplier_item_revisions/
{supplier_item_revision_id}
./supplier_item_revisions[?[skip=m][[&]
limit=n][& <filter_parameters>]..]
Updating SupplierItemRevision
Method: PUT
URI
./supplier_item_revisions/
{supplier_item_revision_id}
./supplier_item_revisions/
{supplier_item_revision_id}?
action={action_name}
Method: DELETE is unsupported
SupplierItemRevision does not support Delete.
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a revision for the specified
SupplierItemRevision object.
Comments
Retrieve the SupplierItemRevision object.
Retrieves the SupplierItemRevision objects
which matches the <filter_parameters>
Comments
Updates the specified SupplierItemRevision
object.
Updates the specified SupplierItemRevision
object and changes the revision state based on
the actions enum list: [APPROVED,
ABANDONED, FREEZE, REOPEN, REVIEW,
PURGEREVISION, PURGERESETREVISION]
733
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierItemRevision

Attribute Data Type Ref. Access Description

Type
id String CNL R/O Centric Node Locator.
modified_at String time R/O Last time this object was
modified.
node_name String string R/O Display name for the object.
approval_time String time R/O
carton_volume_cubic_inches Double double R/O
carton_volume_cubic_meters Double double R/O
clarification_number Integer integer R/O
commission_per_item Double double R/O
duty_calculated Double double R/O
duty_per_item Double double R/O
fob_discount Double double R/O
fob_price Double double R/O
inner_pack_volume_cubic_meters Double double R/O
is_current Boolean boolean R/O
items_per_carton Integer integer R/O
landed_cost Double double R/O
pdf String url R/O
parcel_dimensional_weight Double double R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
shipment_type String enum R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
duty_rates reflist DutyRate R/O
Usage
master ref SupplierIt R/O
em
modified_by ref User R/O
pending_2_user ref User R/O
pending_user ref User R/O
revert_user ref User R/O
review_user ref User R/O
state_change_user ref User R/O
carton_depth_cm Double double R/W

DOMAIN-ASSET RELATED APIs 734

 Centric 8 REST API DEVELOPER GUIDE

carton_height_cm Double double R/W

carton_weight_lb Double double R/W
carton_width_cm Double double R/W
comment String string R/W
commission_pct Double double R/W
description String string R/W
duty_additional Double double R/W
duty_rate Double double R/W
duty_status String enum R/W
fob_full_price Double double R/W
freight_per_item Double double R/W
inner_pack_depth_cm Double double R/W
inner_pack_height_cm Double double R/W
inner_pack_width_cm Double double R/W
inner_packs_per_carton Integer integer R/W
insurance_markup Double double R/W
insurance_per_item Double double R/W
insurance_premium Double double R/W
items_per_container Integer integer R/W
items_per_inner_pack Integer integer R/W
lead_time String string R/W
moq_initial Integer integer R/W
moq_reorder Integer integer R/W
moq_per_color Integer integer R/W
other_cost_per_item Double double R/W
packaging_code String enum R/W
revision_comment String string R/W
royalty_per_item Double double R/W
sample_cost Double double R/W
shipment_type enum enum R/W
supplier_item_state enum enum R/W
uom String enum R/W
unit_packaged_weight Double double R/W
colors reflist Colorway R/W
;
ColorMat
erial
product_sizes reflist ProductS R/W
ize
quote_bom ref ApparelB R/W
OM;
MaterialB
OM

DOMAIN-ASSET RELATED APIs 735

 Centric 8 REST API DEVELOPER GUIDE

quote_cost_scenario ref CostSce R/O

nario
quote_factory String ref R/W
quote_product_alternative ref ProductA R/W
lternative
quote_routing ref Routing R/W
quote_shipping_port ref Shipping R/W
Port
seasons reflist Season R/W
shipping_rate ref Shipping R/W
Rate
supplier_discount String ref R/W
_url_base_template String string R/O File (image, pdf, document)
retrieval URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup
map.

DOMAIN-ASSET RELATED APIs 736

 Centric 8 REST API DEVELOPER GUIDE

SupplierRequest
Creating SupplierRequest
Method: POST
URI Comments

./supplier_requests Create a new SupplierRequest object.

Reading SupplierRequest
Method: GET
URI Comments

./supplier_requests/{supplier_request_id} Retrieve the specified SupplierRequest object.

./supplier_requests[?[skip=m][[&]limit=n][ Retrieve the SupplierRequest objects which

&<filter_parameters>]..] match filter parameters specified as query
string values.

Updating SupplierRequest
Method: PUT
URI Comments

./supplier_requests/{supplier_request_id} ./supplier_requests/{supplier_request_id}

Deleting SupplierRequest
Method: DELETE
URI Comments

./supplier_requests/{supplier_request_id} Delete the specified SupplierRequest object.

Attribute Value Considerations

• The SupplierRequest state attribute value must start in draft state and then
by subsequent PUT requests, be transitioned to issued, etc.
• The specified srdp_template type (Style or Material) must match the parent
of the SupplierRequest.

DOMAIN-ASSET RELATED APIs 737

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierRequest

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
state_change_time time R/O
crew ref SupplierRequ R/O
estCrew
crew_type ref CrewType R/O
line_items reflist SRLineItem R/O
modified_by ref User R/O
state_change_user ref User R/O
inspiration_style_type ref StyleType R/O
cnt_responses integer R/O
reissue_response_reope enumlist R/O
n_states
due_date time R/W
request_type enum C/O
state enum R/W Use special state 'Reissue' in a PUT
request to request re-issue of the
SupplierRequest. The SupplierRequest
remains in the 'Issued' state after this
special request.
submit_quotes_to_wf boolean R/W
initiated_by_agent ref Supplier R/W
requester ref User R/W
srdp_template ref DataPackage R/W DataPackageTemplate reference.
Template
sr_sources reflist ProductSourc R/W List of references to ProductSources.
e
sr_suppliers reflist Supplier R/W List of references to source Suppliers.
sr_template ref SupplierRequ C/O SupplierRequestTemplate reference.
estTemplate
stock_order ref StockOrder R/W
product_sales_region_s ref ProductSales R/W
pec RegionSpec
copy_quote_attributes_ boolean R/W
to_style
copy_quote_images_to_s enum R/W
tyle
crew ref Crew R/W
crew_type ref CrewType R/W
copied_from_sr ref SupplierRequ R/W
est
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 738

 Centric 8 REST API DEVELOPER GUIDE

SupplierRequestTemplate
Creating SupplierRequestTemplate
Method: POST
URI Comments

./supplier_request_templates Create a new SupplierRequestTemplate object.

Reading SupplierRequestTemplate
Method: GET
URI Comments

./supplier_request_templates/{supplier_req Retrieve the specified

uest_template_id} SupplierRequestTemplate object.
./supplier_request_templates[?[skip=m][[&] Retrieve the SupplierRequestTemplate
limit=n][&<filter_parameters>]..] objects which match filter parameters
specified as query string values.

Updating SupplierRequestTemplate
Method: PUT
URI Comments

./supplier_request_templates/{supplier Update the specified SupplierRequestTemplate

_request_template_id} object

Deleting SupplierRequestTemplate
Method: DELETE
URI Comments

./supplier_request_templates/{supplier Delete the specified SupplierRequestTemplate

_request_template_id} object.

DOMAIN-ASSET RELATED APIs 739

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierRequestTemplate

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/O Display name for the object.
modified_by String ref R/O
request_type String enum R/W
sample_type String enum R/W
submit_quotes_to_wf Boolean boolean R/W
srtdp_template String ref R/W
srt_quotes List<String> reflist R/W
srt_suppliers List<String> reflist R/W
inspiration_style_type String ref R/W
quote_create_option String enum R/W
sr_notify_groups List<String> refset R/W
sample_create_option String enum R/W
sample_quantity Integer integer R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 740

 Centric 8 REST API DEVELOPER GUIDE

SupplierReview
Creating SupplierReview
Method: POST
URI Comments

./suppliers/{supplier_id}/operations Create a new SupplierReview object as a child

_reviews of Supplier.

Reading SupplierReview
Method: GET
URI Comments

./suppliers/{supplier_id}/operations_revie Retrieve the SupplierReview objects

ws[?[skip=m][[&]limit=n][&<filter_paramete
rs>]..]
./supplier_reviews/{supplier_review_id}
./supplier_reviews[?[skip=m][[&]limit=n][&
<filter_parameters>]..]
referenced by Supplier which match filter
parameters specified as query string
values.
Retrieve the specified SupplierReview
object.
Retrieve the SupplierReview objects which
match filter parameters specified as query
string values.

Updating SupplierReview
Method: PUT
URI Comments

./supplier_reviews/{supplier_review_id} Update the specified SupplierReview object

Deleting SupplierReview
Method: DELETE
URI Comments

./supplier_reviews/{supplier_review_id} Delete the specified SupplierReview

object.

DOMAIN-ASSET RELATED APIs 741

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of SupplierReview

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/O Display name for the object.
num_flagged Integer integer R/O
num_questions Integer integer R/O
num_responded Integer integer R/O
pdf String url R/O
points_possible Double double R/O
points_scored Double double R/O
score Double double R/O
state String enum R/O
state_change_time String time R/O
modified_by String ref R/O
review_issues List<String> reflist R/O
sections List<String> refvector R/O
fiscal_year String string R/W
notes String string R/W
owner_contact String string R/W
quarter Integer integer R/W
review_date String time R/W
or_template_revision** String ref C/O
review_event String ref C/O
reviewer String ref R/W
_url_base_template String string R/O File (image, pdf, document) retrieval
URL template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold Green color requires module: Quality to be installed. Otherwise, it is ignored.
• The attribute in bold Blue color requires module: Quality to be installed. Otherwise, it is ignored.
• ** is mandatory in POST method to create a new SpecLibraryItem object.

DOMAIN-ASSET RELATED APIs 742

 Centric 8 REST API DEVELOPER GUIDE

Test
Creating Test
Method: POST
URI Comments

./test_run_revisions/ Creates a new Test object as a child of

{test_run_revision_id}tests TestRunRevision.
./tests Create a new Test object.

Reading Test
Method: GET
URI Comments

./tests/{test_id} Retrieves the specified Test object.

./tests[?[skip=m][[&]limit=n] Retrieve the Test objects which matches

[&<filter_parameters>]..] the <filter_parameters> .
./test_run_sections/{test_run_section_id} Retrieve the Test objects referenced by
/tests[?[skip=m][[&]limit=n][&<filter_par TestRunSection and matches the
ameters>]..] <filter_parameters>.

Updating Test
Method: PUT
URI Comments

./tests/{test_id} Updates the specified Test object.

Deleting Test
Method: DELETE
URI Comments

./tests/{test_id} Deletes the specified Test object.

DOMAIN-ASSET RELATED APIs 743

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Test

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
actual_comment String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
actual_method String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
actual_result String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
comment String string R/W
status String enum R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
actual String ref R/W
comments List<String> reflist R/W
documents List<String> reflist R/W
images Map<String, refmap R/W
String>
original String ref R/W
test_color String ref R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
test_sample String ref R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
test_supplier String ref R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
test_user String ref R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 744

 Centric 8 REST API DEVELOPER GUIDE

TestRun
Creating TestRun
Method: POST
URI Comments

./styles/{style_id}/data_sheets/ Create a new TestRun object as a child of

test_runs Style.
./materials/{material_id}/data_sheets/ Create a new TestRun object as a child of
test_runs Material.
./test_runs Create a new TestRun.

Reading TestRun
Method: GET
URI Comments

./test_runs/{test_run_id} Retrieve the specified TestRun object.

./test_runs[?[skip=m][[&]limit=n][&<filter Retrieve the TestRun objects which match

_parameters>]..]
./styles/{style_id}/data_sheets/test_runs
[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./materials/{material_id}/data_sheets/
test_runs[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
filter parameters specified as query string
values.
Retrieve the TestRun objects referenced by
Style which match filter parameters
specified as query string values.
Retrieve the TestRun objects referenced by
Material which match filter parameters
specified as query string values.

Updating TestRun
Method: PUT
URI Comments

./test_runs/{test_run_id} Update the specified TestRun object

DOMAIN-ASSET RELATED APIs 745

 Centric 8 REST API DEVELOPER GUIDE

Deleting TestRun
Method: DELETE
URI Comments

./test_runs/{test_run_id} Delete the specified TestRun object.

Attribute List of TestRun

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was
modified.
node_name String string R/O Display name for the object.
current_revision String ref R/O
data_sheet_samples List<String> reflist R/O
latest_revision String ref R/O
modified_by String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
revisions List<String> refvector R/O
subtype String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
can_track_by_calendar Boolean boolean R/W
code String string R/W This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
description String string R/W
test_run_template String ref C/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
test_spec_group String ref C/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
for_product_source ref ProductS R/W
ource
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 746


TestRunRevision
Creating TestRunRevision
Method: POST
URI
./test_run_revisions/
{test_run_revision_id}/revise
Reading TestRunRevision
Method: GET
URI
./test_run_revisions/
{test_run_revision_id}
./test_run_revisions[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
Updating TestRunRevision
Method: PUT
URI
./test_run_revisions/
{test_run_revision_id}
./test_run_revisions/
{test_run_revision_id}?action={act
ion_name}
Method: DELETE is Unsupported
TestRunRevision does not support Delete.
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Create a revision for the specified
TestRunRevision object.
Comments
Retrieve the specified TestRunRevision object. If
no parameter is passed, then all objects will be
returned.
Retrieve the TestRunRevision objects which match
filter parameters specified as query string values.
Comments
Updates the specified TestRunRevision object.
Updates the specified TestRunRevision object and
changes the revision state based on the action_name,
which can have one of the valid value: [APPROVED,
REVERT, CLOSED, FREEZE]
747
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestRunRevision

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_numb Integer integer R/O
er
is_current Boolean boolean R/O
num_tests Integer integer R/O This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
pdf String url R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
modified_by String ref R/O This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
state_change_user String ref R/O
workflow_execution String ref R/O
comment Map<String, stringmap R/W This attribute requires module: Quality to
String> be installed. Otherwise, it is ignored.
description String string R/W
instructions Map<String, stringmap R/W This attribute requires module: Quality to
String> be installed. Otherwise, it is ignored.
revision_comment String string R/W
status String enum R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
all_sections List<String> refvector R/W
comments List<String> reflist R/W
documents List<String> reflist R/W
pages List<String> refvector R/W
test_run_color String ref R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
test_run_sample String ref R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
test_run_sections List<String> refvector R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
test_run_supplier String ref R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
test_run_user String ref R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.

DOMAIN-ASSET RELATED APIs 748

 Centric 8 REST API DEVELOPER GUIDE

workflow_holder String ref R/W

_url_base_template String string R/O File (image, pdf, document) retrieval URL
template.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 749


TestRunSection
Reading TestRunSection
Method: GET
URI
./test_run_sections/{test_run_section_id}
./test_run_sections[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./test_run_revisions/
{test_run_revision_id}/
test_run_sections[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
Method: POST, PUT, DELETE are Unsupported
TestRunSection is a read only endpoint.
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Retrieve the specified
TestRunSection object. If no
parameter is passed, then all objects
will be returned.
Retrieve the TestRunSection objects
which match filter parameters
specified as query string values.
Retrieve the TestRunSection objects
referenced by TestRunRevision,
which match filter parameters
specified as query string values.
750
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestRunSection

Attribute Data Type Ref. Type Read Only Description

id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
comment String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
status String enum R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
test_spec_subtype String ref R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
tests List<String> refvector R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 751

 Centric 8 REST API DEVELOPER GUIDE

TestSpec
Creating TestSpec
Method: POST
URI Comments

./test_specs Creates a new TestSpec object.

Reading TestSpec
Method: GET
URI Comments

./test_specs/{test_spec_id} Retrieves the specified TestSpec object.

./test_specs[?[skip=m][[&]limit=n][&<filt Retrieve the TestSpec objects which

er_parameters>]..] matches the <filter_parameters> .

Updating TestSpec
Method: PUT
URI Comments

./test_specs/{test_spec_id} Updates the specified TestSpec object.

Deleting TestSpec
Method: DELETE
URI Comments

./test_specs/{test_spec_id} Deletes the specified TestSpec object.

DOMAIN-ASSET RELATED APIs 752

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestSpec

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
current_revision String ref R/O
latest_revision String ref R/O
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
test_spec_groups List<String> refset R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
code String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
description String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
apply_to_types List<String> reflist R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
subtype String ref C/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
tags Map<String, refmap R/W This attribute requires module: Quality to be
String> installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

(*) - The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 753

 Centric 8 REST API DEVELOPER GUIDE

TestSpecGroup
Creating TestSpecGroup
Method: POST
URI Comments

./test_spec_groups Creates a new TestSpecGroup object.

Reading TestSpecGroup
Method: GET
URI Comments

./test_spec_groups/{test_spec_group_id} Retrieves the specified TestSpecGroup

object.
./test_spec_groups[?[skip=m][[&]limit=n][ Retrieve the TestSpecGroup objects which
&<filter_parameters>]..] matches the <filter_parameters> .

Updating TestSpecGroup
Method: PUT
URI Comments

./test_spec_groups/{test_spec_group_id} Updates the specified TestSpecGroup

object.

Deleting TestSpecGroup
Method: DELETE
URI Comments

./test_spec_groups/{test_spec_group_id} Deletes the specified TestSpecGroup

object.

DOMAIN-ASSET RELATED APIs 754

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestSpecGroup

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
active Boolean boolean R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
description String string R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
test_specs List<String> refset R/W This attribute requires module: Quality to
be installed. Otherwise, it is ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 755

 Centric 8 REST API DEVELOPER GUIDE

TestSpecRevision
Creating TestSpecRevision
Method: POST
URI Comments

./test_spec_revisions/ Creates a new revision for the specified

{test_spec_revision_id}/revise TestSpecRevision object.

Reading TestSpecRevision
Method: GET
URI Comments

./test_spec_revisions/{test_spec_revision_id} Retrieve the specific

TestSpecRevision object.
./test_spec_revisions[?[skip=m][[&]limit=n][& Retrieves the specified
...]] TestSpecRevision objects which
matche the <filter_parameters>.

Updating TestSpecRevision
Method: PUT
URI Comments

./test_spec_revisions/{test_spec_revision_id} Updates the specified

TestSpecRevision object.

Method: DELETE is Unsupported

TestSpecRevision does not support Delete.

DOMAIN-ASSET RELATED APIs 756

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestSpecRevision

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
approval_time String time R/O
clarification_num Integer integer R/O
ber
is_current Boolean boolean R/O
pending_2_time String time R/O
pending_time String time R/O
revert_time String time R/O
review_time String time R/O
state String enum R/O
state_change_time String time R/O
usable Boolean boolean R/O
approver String ref R/O
modified_by String ref R/O This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
description String string R/W
required Boolean boolean R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
revision_comment String string R/W
target_comment String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
target_method String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
target_result String string R/W This attribute requires module: Quality to be
installed. Otherwise, it is ignored.
comments List<String> reflist R/W
documents List<String> reflist R/W
images Map<String, refmap R/W
String>
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 757

 Centric 8 REST API DEVELOPER GUIDE

TestSpecSubtype
Reading TestSpecSubtype
Method: GET
URI Comments

./test_spec_subtypes/{test_spec_subtype Retrieves the specified TestSpecSubtype

_id} object.

./test_spec_subtypes[?[skip=m][[&]limit Retrieves the TestSpecSubtype objects which

=n][[&<filter_parameters>]..] match the <filter_parameters>

Method: POST, PUT & DELETE are unsupported

TestSpecSubtype is a read-only endpoint.

DOMAIN-ASSET RELATED APIs 758

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of TestSpecSubtype

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
applied_on String time R/O
modified Boolean boolean R/O
published Boolean boolean R/O
setup_applied_on String time R/O
setup_modified Boolean boolean R/O
modified_by String ref R/O This attribute requires
module: Quality to be installed.
Otherwise, it is ignored.
active Boolean boolean R/W
setup_active Boolean boolean R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 759


Theme
Creating Theme
Method: POST
URI
./materials/{material_id}/themes
./styles/{style_id}/themes
./theme_security_groups/{theme_
security_group_id}/themes
./themes?{theme_master_subtype_i
d}
Reading Theme
Method: GET
URI
./materials/{material_id}/themes
[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./styles/{style_id}/themes
[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
./theme_security_groups/{theme_
security_group_id}/themes[?[skip=m]
[[&]limit=n][&<filter_parameters>]..]
./themes/{theme_id}
./themes[?[skip=m][[&]limit=n]
[&<filter_parameters>]..]
Updating Theme
Method: PUT
URI
./themes/{theme_id}
Deleting Theme
Method: DELETE
URI
./themes/{theme_id}
DOMAIN-ASSET RELATED APIs
Centric 8 REST API DEVELOPER GUIDE
Comments
Creates a new Theme object as a child of Material.
Creates a new Theme object as a child of Style.
Creates a new Theme object as a child of
ThemeSecurityGroup.
Creates a new Theme object for the specified
ThemeMasterSubtype.
Comments
Retrieve the Theme objects referenced by
Material which matches the filter parameter
Retrieve the Theme objects referenced by Style
which matches the filter parameter
Retrieve the Theme objects referenced by
ThemeSecurityGroup which matche the filter
parameter
Retrieves the specified Theme object.
Retrieve the Theme objects which matches the
<filter_parameters>.
Comments
Updates the specified Theme object.
Comments
Deletes the specified Theme object.
760
 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Theme

Attribute Data Ref. Type Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
exception_request_status string R/O
exception_request_time time R/O
freeze_status boolean R/O
main_material_count integer R/O
main_materials string R/O
pdf url R/O
color_colorways refvector ColorColorwayContext R/O
documents reflist Document R/O
exception_request_user ref User R/O
items refvector MaterialPlanPlacement R/O
modified_by ref User R/O
owned_sections refset BOMSectionDefinition R/O
plan_color_materials refset ColorMaterial R/O
plan_materials refset Material R/O
theme_main_materials refset Material R/O
theme_new_color_specs refset ColorSpecification R/O
theme_product_alternatives reflist R/O
description string R/W
limit_color_colorways boolean R/W
limit_theme_product_alterna boolean R/W
tives
match_colors boolean R/W
sort_order integer R/W
all_sections refvector BOMSectionDefinition R/W
theme_bom_type ref ApparelBOMSubtype R/W
theme_category_1 ref Category1 R/W
theme_category_2 ref Category2 R/W
theme_collection ref Collection R/W
theme_main_color_materials refset ColorMaterial C/O
theme_season ref Season R/W
theme_seasons reflist Season R/W
theme_master ref ThemeMaster R/W
_url_base_template string R/O File retrieval URL template.
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 761

 Centric 8 REST API DEVELOPER GUIDE

ThemeMaster
Creating ThemeMaster
Method: POST
URI Comments

./theme_security_groups/{theme_security Creates a new ThemeMaster object as a

_group_id}/security_group_themes child of ThemeSecurityGroup
./theme_masters Creates a new ThemeMaster object.

Reading ThemeMaster
Method: GET
URI Comments

./theme_security_groups/{theme_security Retrieve the ThemeMaster objects

_group_id}/security_group_themes[?[skip referenced by ThemeSecurityGroup which
=m][[&]limit=n][&<filter_parameters>].. matches the <filter_parameters> .
]

./theme_masters/{theme_master_id} Retrieves the specified ThemeMaster object.

./theme_masters[?[skip=m][[&]limit=n][& Retrieve the ThemeMaster objects which

<filter_parameters>]..] matches the <filter_parameters> .

Updating ThemeMaster
Method: PUT
URI Comments

./theme_masters/{theme_master_id} Updates the specified ThemeMaster object.

Deleting ThemeMaster
Method: DELETE
URI Comments

./theme_masters/{theme_master_id} Deletes the specified ThemeMaster object.

DOMAIN-ASSET RELATED APIs 762

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ThemeMaster

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
auto_copy boolean R/O
type enum R/O
color_matching_type ref ColorMatching R/O
Type
modified_by ref User R/O
original_material ref Material R/O
active boolean R/W
composition string R/W
description string R/W
sub_themes refvector ThemeMaster R/W
subtype ref ThemeMaster C/O
Subtype
technical_composition refvector MaterialComp R/W
osition
themes reflist Theme R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

(*) - The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 763

 Centric 8 REST API DEVELOPER GUIDE

ThemeMasterSubtype
Creating ThemeMasterSubtype
Method: POST
URI Comments

./theme_master_subtypes Creates a new ThemeMasterSubtype

object.

Reading ThemeMasterSubtype
Method: GET
URI Comments

./theme_master_subtypes/ Retrieves the specified

ThemeMasterSubtype object.
{theme_master_subtype_id}

./theme_master_subtypes[?[skip=m] Retrieves the ThemeMasterSubtype objects

which match the <filter_parameters>
[[&]limit=n][[&<filter_parameters>]..]

Updating ThemeMasterSubtype
Method: PUT
URI Comments

./theme_master_subtypes/ Updates the specified ThemeMasterSubtype

object.
{theme_master_subtype_id}

Deleting ThemeMasterSubtype
Method: DELETE
URI Comments

./theme_master_subtypes/ Delete the specified ThemeMasterSubtype

object.
{theme_master_subtype_id}

ThemeMasterSubtype is a full CRUD endpoint. Update

configuration is required after each update.

DOMAIN-ASSET RELATED APIs 764

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ThemeMasterSubtype

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
applied_on String time R/O
modified Boolean boolean R/O
published Boolean boolean R/O
modified_by String ref R/O
active Boolean boolean R/W
allow_material_ Boolean boolean R/W
variation_per_c
olorway
theme_to_season String enum R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 765

 Centric 8 REST API DEVELOPER GUIDE

ThemeProductAlternative
Creating ThemeProductAlternative
Method: POST
URI Comments

./themes/{theme_id}/theme_product_ Creates a new ThemeProductAlternative as a

alternatives child of There object.

Reading ThemeProductAlternative
Method: GET
URI Comments

./themes/{theme_id}/theme_product_ Retrieve the ThemeProductAlternative objects

alternatives[?[skip=m][[&]limit=n] referenced by Theme which match filter parameters
[&<filter_parameters>]..] specified as query string values.

./theme_product_alternatives/{them Retrieves the specified ThemeProductAlternative

e_product_alternative_id} object.

./theme_product_alternatives[?[ski Retrieve the ThemeProductAlternative objects

p=m][[&]limit=n][&<filter_paramete which match the <filter_parameters>.
rs>]..]

Updating ThemeProductAlternative
Method: PUT
URI Comments

./theme_product_alternatives/{theme_pr Updates the specified ThemeProductAlternative

oduct_alternative_id} object.

Deleting ThemeProductAlternative
Method: DELETE
URI Comments

./theme_product_alternatives/{theme_pro Deletes the specified ThemeProductAlternative

duct_alternative_id} object.

DOMAIN-ASSET RELATED APIs 766

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ThemeProductAlternative

Attribute Data Type Ref. Type Read Description

Only
id String CNL R/O Centric Node Locator.
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O
style_p_as List<String> reflist R/O
active Boolean boolean R/W
description Map<String, String> stringmap R/W
theme_pa_spec String ref C/O
theme_pa_supplier String ref R/W
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 767

 Centric 8 REST API DEVELOPER GUIDE

ThemeSecurityGroup
Creating ThemeSecurityGroup
Method: POST
URI Comments

./theme_security_groups Creates a new ThemeSecurityGroup object.

Reading ThemeSecurityGroup
Method: GET
URI Comments

./theme_security_groups[?[skip=m][ Retrieves the ThemeSecurityGroup objects which

[&]limit=n][&<filter_parameters>]. match filter parameters specified as query string
.] values.

./theme_security_groups Retrieves the specified ThemeSecurityGroup object.

/{theme_security_group_id}

Updating ThemeSecurityGroup
Method: PUT
URI Comments

./theme_security_groups Updates the specified ThemeSecurityGroup object.

/{theme_security_group_id}

Deleting ThemeSecurityGroup
Method: DELETE
URI Comments

./theme_security_groups Deletes the specified ThemeProductAlternative object.

/{theme_security_group_id}

DOMAIN-ASSET RELATED APIs 768

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ThemeSecurityGroup

Attribute Data Type Ref. Type Read Description

Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the object.
modified_by ref User R/O
security_group_themes reflist ThemeMa R/O
ster
description string R/W
crew ref Crew R/W
crew_type ref CrewType R/W
links (_links) refmap R/O C8 Ref to URL Lookup map.

DOMAIN-ASSET RELATED APIs 769

 Centric 8 REST API DEVELOPER GUIDE

User
Creating User
Method: POST
URI Comments

./users Creates a new User object.

Reading User
Method: GET
URI Comments

./users/{user_id} Retrieves the specified User object.

./users[?[skip=m][[&]limit=n] Retrieves the User objects which match the

[&<filter_parameters>]..] <filter_parameters.
./users/open_sessions Returns user(s) that has open session.

Updating User
Method: PUT
URI Comments

./users/{user_id} Updates the specified User object.

Method: DELETE is unsupported

User is a create, read, update only endpoint.

DOMAIN-ASSET RELATED APIs 770

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of User

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/O Display name for the object.
foreign_id string R/O
modified_by ref User R/O
active boolean R/W Is User Active
business_phone string R/W
city string R/W
country string R/W
email string R/W
fax string R/W
first_name string R/W
home_phone string R/W
is_ldap_user boolean R/W Setting this true marks the User a
LDAP user. Necessary LDAP
configuration has to be done in
Centric Server environment.
is_sso_user boolean R/W Setting this true marks the User a
SSO user. Necessary SSO
configuration has to be done in
Centric Server.
last_name string R/W
locale string R/W
middle_name string R/W
mobile_phone string R/W
postal_code string R/W
province string R/W
send_notification_email boolean R/W
street_address string R/W
user_id string C/O
authu_type ref Authenti C/O
cationTy
pe
keycloak_secret string R/W
home_supplier ref Supplier R/W
defaults ref UserDef R/O
ault
links (_links) refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 771

 Centric 8 REST API DEVELOPER GUIDE

ValueAttributeDefinition
Reading ValueAttributeDefinition
Method: GET
URI Comments

./value_attribute_definitions/ Retrieves the specified ValueAttributeDefinition

{value_attribute_definition_id} object.

./value_attribute_definitions Retrieves the ValueAttributeDefinition objects which

[?[skip=m][[&]limit=n] match the <filter_parameters.
[&<filter_parameters>]..]

Method: POST, PUT & DELETE are unsupported

ValueAttributeDefinition is a read-only endpoint.

Attribute List of ValueAttributeDefinition

Attribute Data Type Ref. Read Description

Type Only
id String CNL R/O Centric Node Locator ID
_modified_at String time R/O Last time this object was modified.
node_name String string R/W Display name for the object.
modified_by String ref R/O This attribute requires module: AQL
to be installed. Otherwise, it is
ignored.
links (_links) Map refmap R/O C8 Ref to URL Lookup map.

• The attribute in bold brown color represents OOTB mandatory attribute.

DOMAIN-ASSET RELATED APIs 772

 Centric 8 REST API DEVELOPER GUIDE

UserDefaults
How to enable UserDefaults
Method: PUT
URI Comments

./users?manage_defaults=true Creates a new UserDefaults object.

Reading UserDefaults
Method: GET
URI Comments

./user_defaults/{user_defaults_id} Retrieves the specified user_defaults object.

./user_defaults[?[skip=m][[&]limit= Retrieves the user_defaults objects which match the

n] <filter_parameters>.

[&<filter_parameters>]..]

Updating UserDefaults
Method: PUT
URI Comments

./user_defaults/{user_defaults_id} Updates the specified user_defaults object.

Deleting UserDefaults
Method: DELETE
URI Comments

./user_defaults/{user_defaults_id} Deletes the specified user_defaults object.

Method: POST is unsupported

UserDefaults is a read, update and delete only endpoint.

DOMAIN-ASSET RELATED APIs 773

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of User

Attribute Data Type Ref. Read Description

Type Only
id CNL R/O Centric Node Locator.
_modified_at time R/O Last time this object was modified.
node_name string R/W Display name for the object.
modified_by ref User R/O

DOMAIN-ASSET RELATED APIs 774

 Centric 8 REST API DEVELOPER GUIDE

6. UTILITY API
Aggregate Store APIs
Why Aggregate Store is needed

The main use case of aggregate store is to get a list of nodes available for a ref attribute.
Currently to get a list of such nodes is done at client side. Server has no knowledge of valid
nodes for a ref attribute. Aggregate store has been designed to bring such queries at server
side, so that query definitions are available at a centralized location (server) acting as a single
source of truth.

In the most simplest of terms aggregate store is a server side implementation to get values of
ref type attributes. Previously, that logic was mostly at the client code, so there was a less
standard way of declaring it, and more importantly was not accessible to other "clients" of C8,
like PLMC, mobile apps, etc.

Aggregate Store APIs:

There are two APIs that have been developed to use the aggregate store:

1. API to give list of attributes that have aggregate store defined

a. This API has been developed to help users know for which attributes the aggregate
store exists.
b. API response contains a list of ref type attributes for which aggregate store has been
defined.
c. API response is grouped by node type.
API to give a list of permissible target node values that can be assigned to a ref type
attribute.
Aggregate Store APIs Explanation
API 1

Provides list of ref attributes for which aggregate store has defined

This API helps integration developers/users know whether an aggregate store exists for any
ref attribute.

UTILITY API 775

 Centric 8 REST API DEVELOPER GUIDE

Envision this API as a helper API to know beforehand that if an API call is made to get values
for a ref attribute, the API call will either provide the response or throw an error.

API Definition:

1. node_type : Type of node for which user wants to know the aggregate store
2. API response explanation:
a. Node type is not passed in the api:

b. Node type is passed in the api:

UTILITY API 776

 Centric 8 REST API DEVELOPER GUIDE

API 2

Gives list of permissible target nodes that can be assigned to a ref type attribute

This aggregate store api provides a list of all the PERMISSIBLE target node(s) that can be
assigned to the ref type attribute. Example:

UTILITY API 777

 Centric 8 REST API DEVELOPER GUIDE

On above style URL (C123456) , for the ref type attribute “ProductType “, aggregate store API
will give all the resulting nodes of type ProductType that can be assigned to attribute
ProductType on the URL of Style that was passed in the API.

API Definition:

API accepts two path parameters:

1. node_id: URL of the node on which you ref attribute is associated

2. attribute_id: Name of the ref attribute for which user wants the target node values
3. API response explanation:
Screenshot of sample API response.
(Note that the API response is the same as a Centric application calling aggregate store)

UTILITY API 778

 Centric 8 REST API DEVELOPER GUIDE

Below two attributes have been added for better understanding of ref values:
a. currentValues: These are values currently stored with the attribute, and are possibly
not in the result set (making them invalid).
b. disbaledUrls: These are the values that is not available for users to select.

Sequence of internal validations that happen before a successful API response:

UTILITY API 779

 Centric 8 REST API DEVELOPER GUIDE

APISearch

The APISearch is a powerful developer tool to search and locate API endpoints, payload
attributes names based on various search parameters as listed in the page.

There will be three search targets: Endpoint, API, and Attribute.

Since the response mostly for human reading, we will add two criteria to reduce the
response: endpoint_names_only and show_attr.

Reading APISearch
Method: GET
URI Comments

./api_search Retrieves the specified Version object.

Search Parameter Search Target Example

endpoint_name Endpoint StyleType

endpoint_parent Endpoint Style
endpoint_child Endpoint Issue
endpoint_version Endpoint v2
endpoint_requires_u Endpoint False
pdate_config
endpoint_skip Endpoint 0
endpoint_limit Endpoint 10
endpoint_names_only API true
api_path API /styles/issues
api_description API Returns MaterialBOMSubtype for the
given id
api_header API class_name
api_method API GET

api_query_param API param_value

api_file_load API up (or down)
show_attr Attribute true

attr_name Attribute squ_counter

UTILITY API 780

 Centric 8 REST API DEVELOPER GUIDE

attr_type Attribute String

attr_destination Attribute SalesOrder

attr_description Attribute The list of REST Resource links

attr_url_action Attribute ?Module=Publisher&Operation=Get

Direct&URL=%s
attr_module Attribute CollectionBook

• The attributes in Bold Brown indicates wildcard search

Definition of API and Endpoint parameters:

Typical response:

"name": "ContractualDocumentGroup",

"path": "contractual_document_groups",

"version": "v2",

"parents": [],

UTILITY API 781

 Centric 8 REST API DEVELOPER GUIDE

"children": [

"ContractualDocument"

],

"APIs": [

"method": "PUT",

"path": "contractual_document_groups/{contractual_document_group_id}",

"description": "Updates a specific ContractualDocumentGroup.",

"payload_type": "ContractualDocumentGroup",

"payload": [

"rest_name": "description",

"c8_name": "Description",

"description": "",

"type": "string",

"module": "Quality", ...

Method: POST, PUT, and DELETE are unsupported.

APISearch is a read only endpoint. It does not support

POST, PUT or DELETE methods.

Usage Note
To obtain a exhaustive list of C8 REST API endpoint names:
1. Execute the query: api_search?endpoint_names_only=true
The result will be an json array of dictionaries, each with one entry: the key “name”
followed by the value, which is name of the endpoint.

You will see something like the following, which is a json array of dictionaries:

UTILITY API 782

 Centric 8 REST API DEVELOPER GUIDE

"name": "ProductGroup"

},

"name": "ShippingContainer"

},

"name": "CanvasTemplate"

},

"name": "Customer"

},

"name": "ApparelBOMSubtype"

},…

The resulting list of C8 REST API endpoint names is very close to a list of C8 REST API exposed
object names, in some cases not exactly the same, cases but close enough to identify it easily.

To obtain samples of attributes of a particular datatype:

Sometimes testing requires examples of attributes of a particular datatype: String, Enum,

Integer, Float, and so on. Some of these data types are comparatively rare among the
attributes, for example, the datatype “float”, occurs in only 5 attributes across 3 objects, so
finding them by a visual search through the thousands of attributes in the C8 REST API would
be nearly impossible. APISearch, however, lets one find all instances of them.

1. Execute the query:

api_search?endpoint_names_only=false&endpoint_skip=0&endpoint_limit=10
000&attr_type=float&show_attr=true

UTILITY API 783

 Centric 8 REST API DEVELOPER GUIDE

The result will be an json array of dictionaries, each with several entries: the key “name”
followed by the value which is name of the endpoint.

Each of these will also contain a key named “APIs”, which itself contains a list of dictionaries
whose keys and values describe the endpoint uniquely, using the “method” and “path”.

This dictionary will also include an entry called “payload”, which will be limited to an attribute
of the payload of a type that satisfies the requested attribute type.

"name": "MaterialBOMRevision",

"path": "material_bom_revisions",

"version": "v3",

"parents": [],

"children": [

"PartMaterial"

],

"APIs": [

"method": "POST",

"path":
"material_bom_revisions/{material_bom_revision_id}/items/special_part_mater
ials",

"parameters": [

"material_type",

"material_name"

],

"description": "Create new PartMaterial with new special material

from the MaterialBOMRevision with specified id",

UTILITY API 784

 Centric 8 REST API DEVELOPER GUIDE

"payload_type": "PartMaterial",

"payload": [

"rest_name": "loss_pct",

"c8_name": "LossPct",

"description": "",

"type": "float"

},

"method": "POST",

"path":
"material_bom_revisions/{material_bom_revision_id}/items/part_materials",

"description": "Create new PartMaterial from the MaterialBOMRevision

with specified id.",

"payload_type": "PartMaterial",

"payload": [

"rest_name": "loss_pct",

"c8_name": "LossPct",

"description": "",

"type": "float"

UTILITY API 785

 Centric 8 REST API DEVELOPER GUIDE

},

"name": "ApparelBOMRevision",

"path": "apparel_bom_revisions",

"version": "v3",

"parents": [],

"children": [

"PartMaterial"

],

"APIs": [

"method": "POST",

"path":
"apparel_bom_revisions/{apparel_bom_revision_id}/items/special_part_materia
ls",

"parameters": [

"material_type",

"material_name"

],

"description": "Create new PartMaterial with new special material

from the ApparelBOMRevision with specified id",

"payload_type": "PartMaterial",

"payload": [

"rest_name": "loss_pct",

UTILITY API 786

 Centric 8 REST API DEVELOPER GUIDE

"c8_name": "LossPct",

"description": "",

"type": "float"

},

"method": "POST",

"path":
"apparel_bom_revisions/{apparel_bom_revision_id}/items/part_materials",

"description": "Create new PartMaterial from the ApparelBOMRevision

with specified id.",

"payload_type": "PartMaterial",

"payload": [

"rest_name": "loss_pct",

"c8_name": "LossPct",

"description": "",

"type": "float"

},

"name": "PartMaterial",

UTILITY API 787

 Centric 8 REST API DEVELOPER GUIDE

"path": "part_materials",

"version": "v3",

"parents": [

"MaterialBOMRevision",

"ApparelBOMRevision"

],

"children": [],

"APIs": [

"method": "PUT",

"path": "part_materials/{part_material_id}",

"description": "Updates a specific PartMaterial.",

"payload_type": "PartMaterial",

"payload": [

"rest_name": "loss_pct",

"c8_name": "LossPct",

"description": "",

"type": "float"

UTILITY API 788

 Centric 8 REST API DEVELOPER GUIDE

If one wants to zoom out a bit, to see just the three object names, repeat the steps above, but
at step # 2, set “endpoint_names_only” to true. The resulting response will only go as deep as
the object names, revealing that (in 7.2, at least) there are only 3.

"name": "MaterialBOMRevision"

},

"name": "ApparelBOMRevision"

},

"name": "PartMaterial"

To obtain a list of parent APIs having a reference of a particular class:

Using Style as example:

1. Run the query:

api_search?endpoint_names_only=true&endpoint_skip=0&endpoint_limit=10000
&api_description=Style&show_attr=false

The result will be an json array of dictionaries, each with one entry: the key “name” followed
by the value, which is name of an endpoint that is a parent to the class’s instantiated objects

"name": "ReviewStyleRevision"

},

UTILITY API 789

 Centric 8 REST API DEVELOPER GUIDE

"name": "StyleCopyOptions"

},

"name": "StyleSupplierAttributes"

},

"name": "ReviewStyle"

},

"name": "SupplierRequest"

},

"name": "FinalInspectionReviewStyle"

},

"name": "Style"

},

"name": "StyleType"

},

"name": "Collection"

UTILITY API 790

 Centric 8 REST API DEVELOPER GUIDE

ConfigUpdate
Update Config is trigged manually by an Administrator through Centric Web UI. To trigger the
same programmatically, use this endpoint. This will trigger a full or partial update of the
server configuration job. Once triggered, the job will run asynchronously and generally takes
several seconds to complete depending on the Centric Server data volume. The Update job,
while running, will slow down all other server operations, so use this utility sparingly, as
repeated calls can potentially impair server performance for all users. Please note, almost all
Centric business object change is immediately visible to other users without running Server
update configuration. Only a few business object need this to reflect their change to all
Centric users.

Triggering the Update-Config job

Method: POST

URI Comments

./config_update Triggers a full or partial update based on payload data as shown in

the Jason payload example below:

{
"is_full_update": false,
"due_time": "2020-05-06T22:47:42.938Z"
}

Where “is_full_update” Boolean value determines if the config

update will be full or partial.

The “due_time” is for scheduling the job

Reading Update-Configuration Job status

Method: GET
URI Comments

./config_update Returns the Update Config status in the payload.

UTILITY API 791

 Centric 8 REST API DEVELOPER GUIDE

Method: PUT & DELETE unsupported

ConfigUpdate does not support PUT or DELETE methods.

Attribute List of ConfigUpdate

Attribute Data Type Ref. Type Read Only Description

is_full_update boolean R/W Is full update or partly. Need for
POST
due_time DateTime R/W Due time. Need for POST
node_name String R/O Configuration Update name
auto_delete boolean R/O auto delete
duration Long R/O duration
ended String R/O ended
error_exception String R/O error_exception
error_message String R/O error message
auto_delete boolean R/O auto delete
progress Integer R/O progress. 1 is 100%
progress_message String R/O progress_message
started String R/O started
state String R/O state
modified_by String R/O modified by
_modified_at String R/O modified at
executable_type String R/O executable_type
due_time Time R/O due time
schedule_type String R/O schedule type
execution_time Time R/O execution time
interval_time Time R/O interval time

UTILITY API 792

 Centric 8 REST API DEVELOPER GUIDE

Count

Count returns the total number of instances of a specific object type in the Centric 8
database.

Example: ./count/style
Returns {count:5120}

Indicates there are 5120 Styles in the Centric database.

The Count utility endpoint is useful for determining pagination to be effected via the “skip”
and “limit” query parameters.

Reading Count
Method: GET
URI Comments

./count/{ObjectName}
Retrieves the total number of the specified type of Centric Business
Object in the Server. The object_name should be a valid Centric
Business Object name such as Style, Country, Season etc. If any
invalid name is passed, the endpoint will return http 404 error with
message “No such domain”.

URL: ObjectName in CamelCase

ObjectName must be in its CamelCase manifestation, capitalizing each

word, and without underscores. Effectively, it must match the internal
domain object name.

Method: POST, PUT & DELETE are unsupported

Count is a read-only endpoint. It does not support POST,

PUT or DELETE methods.

Attribute List of Count

Attribute Data Type Ref. Read Only Description

Type
count String Not a C8 R/O Count of the specified
attribute business object

UTILITY API 793

 Centric 8 REST API DEVELOPER GUIDE

Email
Creating Email
Method: POST
URI Comments

./emails Creates a new email and send it to the recipient as per information provided
in the payload.

Method: GET, PUT & DELETE are unsupported

Email is a create-only endpoint. It does not support

GET, PUT or DELETE methods.

Attribute List of Email

Attribute Data Type Ref. Type Read Only Description

reply_to_emails List string R/W Recipient email addresses
reply_to_ids List string R/W Active Host Users
subject String string R/W Subject of email
body String string R/W Message body
from String string R/W From email address
send_to_emails List string R/W Recipients email addresses
send_to_ids List string R/W Active Host Users
cc_to_emails List string R/W Copied recipient email addresses
cc_to_ids List string R/W Active Host Users
bcc_to_emails List string R/W Blind copied recipient email
addresses
bcc_to_ids List string R/W Active Host Users
attachment_docs List string R/W List of Centric Document id. The
Email API will zip each document
and attach the individual zip files to
the email.

UTILITY API 794

 Centric 8 REST API DEVELOPER GUIDE

ExportImportJob
This is an utility endpoint which will allow triggering of predefined Centric 8 Export or Import
job using REST API.

Creating ExportImportJob and uploading Job config file

Method: POST
URI Comments

./export_import_jobs Creates a new Export or Import Job object as per

./export_import_jobs/upload
./export_import_jobs/download
Payload values.
Upload new import config file. See example at the end of
this endpoint details.
Return the InputStream for the specified Job
configuration file in the payload. See example at the end
of this endpoint details.

Reading ExportImportJob
Method: GET
URI Comments

./export_import_jobs Lists all the ExportImportJobs.

./export_import_jobs/{e Return the specified ExportImportJob.

xport_import_job_id}

Updating ExportImportJob
Method: PUT
URI Comments

./export_import_jobs/{e Updates the specified Export/Import job.

xport_import_job_id}

Deleting ExportImportJob
Method: DELETE
URI Comments

./export_import_jobs/{e Deletes the specified Export/Import job.

xport_import_job_id}

UTILITY API 795

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of ExportImportJob

Attribute Data Type Ref. Read Only Description

Type
id String R/O Export/Import Job id
due_time DateTime Due time. Need for POST
node_name String
auto_delete boolean R/O auto delete
duration Long R/O duration
ended String R/O ended
error_exception String R/O error_exception
error_message String R/O error message
auto_delete boolean R/O auto delete
progress Integer R/O progress. 1 is 100%
progress_message String R/O progress_message
started String R/O started
state String R/O state
modified_by String R/O modified by
_modified_at String R/O modified at
executable_type String R/O executable_type
due_time Time due time
schedule_type String R/O schedule type
execution_time Time execution time
interval_time Time interval time

Attribute details
due_time - Next time the job will be executed. Used for schedule_type: OneTime only. All
other schedule types will calculate this field automatically.
execution_time - Specifies the time of day when the job will be executed. Used for
schedule_type: EveryDay and EveryBusinessDay")
interval_in_seconds - Interval in seconds. Used for schedule_type: EveryNumberSeconds only
schedule_type - is required to trigger the job and valid value must be from enum list Stopped,
OneTime , EveryBusinessDay, EveryDay, EveryNumberSeconds
Stopped – will stop the job
OneTime – is used in addition with “due_time”
EveryDay – is used in addition with “execution_time”
EveryBusinessDay is used in addition with “execution_time”
EveryNumberSeconds is used in addition with “interval_in_seconds”
Error messages will be displayed for missing info.
• Invalid schedule_type = 'EveryNumberdSeconds', valid value must be from enum list
Stopped, EveryBusinessDay, EveryDay, EveryNumberSeconds, OneTime",
• Attribute 'due_time' is required'. In addition to schedule_type = 'OneTime'.

UTILITY API 796

 Centric 8 REST API DEVELOPER GUIDE

• Attribute 'execution_time' is required'. In addition to schedule_type =

'EveryBusinessDay'

Example: using ExportImportJob

Pre-condition:
Import and Exports jobs are set from C8 Web app. Let us consider we have defined a job
named “Test Job” in Centric UI. This job has a job ID C7163.

Query this job using ExportImportJob:

[GET] ./export_import_jobs/C7163
and it will return the job information in the following payload

"id": "C7163",

"node_name": "Test job",

"due_time": 0,

"schedule_type": "Stopped",

"execution_time": 28800000,

"interval_time": 86400,

"auto_delete": false,

"ended": "Wed Dec 31 16:00:00 PST 1969",

"error_message": "",

"progress": 0,

"progress_message": "",

"started": "Wed Dec 31 16:00:00 PST 1969",

"state": "None",

"modified_by": "centric://REFLECTION/INSTANCE/User/Administrator",

"_modified_at": "Tue Mar 26 13:22:34 PDT 2019",

"notification_level": "",

"notification_group": "centric:",

"executable_type": "ExportExecutable"

UTILITY API 797

 Centric 8 REST API DEVELOPER GUIDE

Execute this job using ExportImportJob

[PUT] ./export_import_jobs/C7163

While passing the following payload in request body:

{
"node_name": "string",
"due_time": "2019-03-07T20:06:44.368Z",
"schedule_type": "Stopped",
"execution_time": "2019-03-07T20:06:44.368Z",
"interval_in_seconds": 0 }

Example: Uploading an Export/Import Job

File theFile = new File("C:/Doc/install/jobFile2.xml");

String host = "https://mycentricserver";

String uriString = host +

"/csi-requesthandler/api/v2/export_import_jobs/upload";

httpPost = new HttpPost(uriString);

httpPost.addHeader(HttpHeaders.ACCEPT, "application/json");

httpPost.addHeader("overwrite","true");

MultipartEntityBuilder mpeBuilder = MultipartEntityBuilder.create()

setMode(HttpMultipartMode.BROWSER_COMPATIBLE);

mpeBuilder.addBinaryBody("file", theFile);

HttpEntity multiPartEntity = mpeBuilder.build();

httpPost.setEntity(multiPartEntity);

httpResponse = closableHttpClient.execute(httpPost);

Example: Downloading an Export/Import Job

File theFile = new File("C:/Doc/install/jobFile2.xml");

String host = "https://mycentricserver";

fileName = "jobFile.xml";

String uriString = host +

"/csirequesthandler/api/v2/export_import_jobs/download";

UTILITY API 798

 Centric 8 REST API DEVELOPER GUIDE

httpPost = new HttpPost(uriString);

String json = "{ \"file_name\": " + "./import/" + fileName + " }";

stringEntity = new StringEntity(json);

stringEntity.setContentType("application/json");

httpPost.setEntity(stringEntity);

httpResponse = closableHttpClient.execute(httpPost);

InputStream in = httpResponse.getEntity().getContent();

String filePath = "C:/DocREST/" + fileName;

Files.copy(in, Paths.get(filePath),StandardCopyOption.REPLACE_EXISTING);

UTILITY API 799

 Centric 8 REST API DEVELOPER GUIDE

Job
The Job EndPoint is a read or update endpoint which allows access or modify the _CS_Job
object (not the Job configuration file). The Centric 8 job should be created and deleted using
the C8 UI and/or export/import functions. Alternatively, the Job object will be created as part
of creating it's logical parent. Update operations are supported.

Reading Jobs
Method: GET
URI Comments

./jobs[?[skip=m][[&]limit=n][[&<f Lists all the Centric 8 Job details matching filter

ilter_parameters>]..] parameters.

./jobs/{job_id} Return the specified Centric 8 Job details.

Updating Job
Method: PUT
URI Comments

./jobs/{job_id} Updates the specified Centric 8 job.

UTILITY API 800

 Centric 8 REST API DEVELOPER GUIDE

Attribute List of Job

Attribute Data Type Ref. Read Only Description

Type
id String CNL R/O Centric Node Locator ID
_modified_at time R/O Last time this object was
modified.
node_name string R/W Display name for the
object.
auto_delete boolean R/O
duration integer R/O
ended time R/O
error_exception string R/O
error_message string R/O
progress double R/O
progress_message string R/O
started time R/O
state enum R/O
modified_by ref User R/O
executable_type string R/O
due_time time R/W
execution_time time R/W
notification_level enum R/W
notification_group ref Role; R/W
Group
interval_time integer R/W
schedule_type string R/W
links (_links) refmap R/O C8 Ref to URL Lookup
map.

UTILITY API 801

 Centric 8 REST API DEVELOPER GUIDE

License
Reading License
Method: GET
URI Comments

./licenses Retrieves the Centric 8 license and installed module details

Method: POST, PUT & DELETE are unsupported

License is a read-only object.

Attribute List of License

Attribute Data Type Ref. Type Read Description

Only
provider String R/O provider
customer String R/O customer
issue_date String R/O issue date
expiration_date String R/O expiration date
installed_modules String R/O list of installed modules
installed_modules String R/O customer
modified_by String R/O modified by
type String R/O type
available_license Integer R/O available licenses
s
total_licenses Integer R/O total licenses
modified_at String R/O modified at

UTILITY API 802

 Centric 8 REST API DEVELOPER GUIDE

Log
Reading a list of Centric Log file name and details
Method: GET
URI Comments

./logs/dir Retrieves the list of all Centric logs in the payload. A JSON payload
example is shown below.
[

"file_name": "pi_rest.log",

"last_modified": "Thu Apr 15 23:12:34 PDT 2020",

"length": 0

},

"file_name": "pi_centric.log",

"last_modified": "Thu Apr 16 20:16:34 PDT 2020",

"length": 0

Getting a Log file stream to download

Method: GET
URI Comments

./logs/{log_filename} Returns the file stream to the specified Centric log file. The
following Java example shows how to use the endpoint.

Method: POST, PUT, DELETE are unsupported

Log is a Read Only endpoint.

UTILITY API 803

 Centric 8 REST API DEVELOPER GUIDE

Example: Downloading a specified Log file

This Java code snippet will illustrate how you can download and save a specific log file by using
the logs endpoint.

String host = "http://mycentricserver";

String fileName = "pi_performance.log";

String uriString = host + "/csi-requesthandler/api/v2/logs" + fileName;

System.out.println("uriString:" + uriString);

httpGet = new HttpGet(uriString);

httpResponse = closableHttpClient.execute(httpGet);

InputStream in = httpResponse.getEntity().getContent();

// save it locally

String filePath = "C:\\Doc\\REST\\" + fileName;

Files.copy(in, Paths.get(filePath), StandardCopyOption.REPLACE_EXISTING);

UTILITY API 804

 Centric 8 REST API DEVELOPER GUIDE

ObjectTree
Centric 8 business object endpoints are designed to create, query, update or delete only a
specific business object. In real life scenario, we often need to retrieve multiple related business
objects, which requires multiple calls to business object endpoints. ObjectTree endpoint allows
us to fetch parent child relation linked business objects through a single call thereby simplify
the integration code. It cannot fetch business objects which are not related.
Querying Business Object Tree
Method: POST
URI Comments

./object_tree Pass the parent child relation as the query as JSON in the http request body.

The JSON payload structure is:

{
"parent_type": "string",

"parent_id": "string",

"children": [

{"type":"<type-1>", "path":"<path-1>"},

{"type":"<type-2>", "path":"<path-2>"},

….

{"type":"<type-n>", "path":"<path-n>"}

See the examples for more details.

Method: POST, PUT, DELETE are unsupported

▪ Even though the method is POST, ObjectTree only supports

query, so it is a Read Only endpoint.

▪ Not all classes have been Rest exposed. If you make a Rest call
against such a class, user will get HTTP 400 error stating the
endpoint for that class has not been exposed.If such class is an
abstract base one, then the user can try any of derived classes
from that base one .

UTILITY API 805

 Centric 8 REST API DEVELOPER GUIDE

Example 1: using ObjectTree

We like to fetch all colorways and sku linked to a specific category2 business object named
“Etirel”. The object relationship diagram illustrates the parent child relationship between
Category2, Colorway and Sku objects.

Follow the steps to create the payload for the query.

• Run a query: ./category2s?node_name=Etirel

to determine all the attributes of that specific Category2 object. The query result will be
returned in XML or JSON format as you have requested.

• Parse the JSON or XML to get the attribute value for “id”
id = "centric%3A%2F%2FAPPAREL%2FCategory2%2FFW0809_Multisport_Etirel "
• Now construct the JSON query for the ObjectTree for that specific Category2
object, which has both Colorway and SKU as its two children. The query data
payload will look like this:

UTILITY API 806

 Centric 8 REST API DEVELOPER GUIDE

"parent_type": "Category2",

"parent_id":
"centric%3A%2F%2FAPPAREL%2FCategory2%2FFW0809_Multisport_Etirel",

"children": [

{"type":"Colorway", "path":"Hierarchy:Hierarchy:ActiveColorways"},

{"type":"SKU", "path":"Hierarchy:Hierarchy:RealizedProducts"}

The Type names, highlighted in yellow are the valid Centric business Object Endpoint
names.

The paths are highlighted in green. To determine the path to the child from the parent,
such as path to Colorway from Category2, use Centric 8 class browser tool from the Web
UI. Keep on noting the paths while navigating from the parent to the child. The paths are
highlighted in red rectangles in the screenshot below.

UTILITY API 807

 Centric 8 REST API DEVELOPER GUIDE

• Once you run the query using the ObjectTree endpoint, it will internally
traverse the Centric 8 object tree and return the parent as well as the
collection of Children as a Json payload.

Example 2:

Providing example is the best way to understand how request payload is constructed. There
are three major elements to creating the request payload:

The Request model looks like :

{
"parent_type": "string",
"parent_id": "string",
"children": [
{"type","path":""}
]
}

1. parent_type : Object type of the parent object. For example, Style,Season,Material, etc
parent_id : Id of the parent object
children: Under this attribute, user would provide the type of the object (related to
parent_type) the user wants to make call against:
c. type: Type of the object For example, Style, Season, Material, etc.

d. path: Relationship between parent object and child object. The path can go to
multiple level of relationships. Format is: Relationship:Relationship
Paths can go to multilevel of related objects.

UTILITY API 808

 Centric 8 REST API DEVELOPER GUIDE

e. Example 1:

In the below example, users can get the following information related to a style:
• product_type
<Class name>EndPoint(in this case ProductType) is not implemented" and
such class is abstract base one, then the user could try any of derived
classes from that base one. For example, if the message said that
"ProductTypeEndPoint is not implemented", then try StyleType (derived
from ProductType).

• category_1(brand)

• category_2(department)

• collection

• parent_season

• theme

• shape

"parent_type": "Style",

"parent_id": "C150288",

"children": [

{"type":"StyleType", "path":"ProductType"},
{"type":"Collection", "path":"Collection"},
{"type":"Season", "path":"ParentSeason"},
{"type":"Theme", "path":"Theme"},
{"type":"Shape", "path":"Shape"},
{"type":"Category1",
"path":"ParentSeason:Hierarchy"}

UTILITY API 809

 Centric 8 REST API DEVELOPER GUIDE

Session
Creating a new C8 API Session (login)
Method: POST
URI Comments

./session Creates a new C8 REST API Session by logging in by using a valid C8 username and
password passed as string in a JSON/XML payload in the HTTP request body. The
data model in JSON format is shown below:

"username": "<string>",

"password": "<string>"

On success the API will return a valid token in the response object. A successful login
JSON data in the http response will look like this:

"token": "SecurityTokenURL= centric://_CS_SecurityToken/. ."

The Figure 1. illustrates a typical session REST call and a return token value from the
C8 server

From this point, you can make authenticated and authorized REST API by passing the
token string through a cookie in the HTTP request header. See Figure 2.

If the authentication fails, the JSON payload will contain authentication error message.

Read, Update of Session is unsupported

Session does not support GET or PUT methods.

UTILITY API 810

 Centric 8 REST API DEVELOPER GUIDE

Deleting (invalidating) a user session (logout)

Method: DELETE
URI Comments

./session Cancels the current user session as identified by the cookie provided authentication
tokens. This is used for logging out from REST API session. The REST API will respond
with HTTP status 401 to indicate that the user is no longer authorized. See Figure 3.

Session Create Request Attributes

Ref.
Attribute Data Type Read Only Description
Type
username String string R/W C8 REST API user login name
password String string R/W C8 REST user's password

The attribute in bold brown color represents OOTB mandatory attribute

Session Create Response Attributes

Ref.
Attribute Data Type Read Only Description
Type
token String string R/O Authentication data required to manage
user access.

Figure 1. Session POST Request: passing the username and password in the request body (using Postman)

Session POST Response: receiving the security token in the response body (using Postman)

UTILITY API 811

 Centric 8 REST API DEVELOPER GUIDE

Figure 2. Example: Passing token in http header during any REST call (using Postman)

UTILITY API 812

 Centric 8 REST API DEVELOPER GUIDE

Figure 3. Example: Logging out by passing token string as cookie through http header (using Postman)

Example: AUTHENTICATING USING SESSION

Before you can access any REST endpoints, you have to get authenticated in C8 server as a
valid user by using the Session endpoint. The following example will show how to use the
Session endpoint to authenticate and get a valid security token. You can then save the security
token in a client-side cookie like a browser does and let you application automatically use the
cookie in all subsequent Centric 8 REST call, or you can programmatically pass the
authentication token via http header in every subsequent REST call. The authentication token
remains valid for a certain time as configured in your C8 application server. Once the t oken
has expired, you need to reauthenticate to get a new token and use it as before.

Endpoint POST
http://{c8server}/csi- Pass the username and password through the Http request
requesthandler/api/{ve
rsion}/session Body either in JSON or XML formatted data:

JSON Example:
{
"username":"Soumya",
"password":"C3nTr1c"
}
XML Example:
<session>
<username>Soumya</username>
<password>C3nTr1c</password>
</session>
On success, the Session API returns a new C8 session and
authentication token in the HTTP body as JSON or XML

UTILITY API 813

 Centric 8 REST API DEVELOPER GUIDE

format (as per your choice)

Example in JSON:
{
"token":
"SecurityTokenURL=centric://_CS_SecurityToken/8ae2d
2e5ac1403460b54ce725da96ddd"
}
Example in XML:
<?xml version="1.0" encoding="UTF-8"
standalone="yes"?>
<session>
<token>SecurityTokenURL=centric://_CS_SecurityTok
en/8ae26f8eac1403460b54ce726fa80185</token>
</session>
DELETE
http://{c8server}/csi- Logs out by deleting the existing session at the C8 server and
requesthandler/api/{ve
rsion}/session invalidates the previous authentication token.

UTILITY API 814

 Centric 8 REST API DEVELOPER GUIDE

Version
Reading Version
Method: GET
URI Comments

./version Retrieves the specified Version object.

Method: POST, PUT, DELETE are unsupported

Version is a read only endpoint. It does not support

POST, PUT, or DELETE methods.

Attribute List of Version

Attribute Data Ref. Read Description

Type Type Only
api String R/O REST API Version
title String R/O Composit product name and release
vendor String R/O Centric's name
version String R/O C8 Compound version identifier
product_name String R/O
product_release String R/O
product_service_pack_number String R/O
build_iteration String R/O The latest Git commit incorporated in this
build
build_time_stamp String R/O YYYYMMDD-HHMM
build_iteration_number String R/O
build_branch String R/O Git branch source for this version's build
Installed_modues String R/O List of all installed Centric modules in the
server.

UTILITY API 815

 Centric 8 REST API DEVELOPER GUIDE

ClassRelationships
This endpoint’s GET method returns a list of paths that show how the “begin” business object
class is linked to the “end” business class in the returned Json payload. It is useful for the
Centric Rest API developers to quickly determine how the Centric business classes are linked
with each other so that they can be traversed programmatically.

Querying ClassRelationship
Method: GET
URI Comments

./class_relationships Pass the following query parameters through the URL

and receive the Json response in the http response.

URL Parameter Name Type Purpose

Begin String The start business object

end String The end business object
incoming Boolean
Max_depth Integer Maximum depth relationship depth
it will search for

Example

The API displays a path between two C8 classes Category2, Department are linked to
MerchPlan

<host>/csi-
requesthandler/api/v2/class_relationship?begin=Category2&end=MerchPlan&incoming=fals
e&max_depth=7

Sample output:

"paths": [

"Category2 > Collection > Style > MerchProductVersion > MerchLevel >
MerchPlan",

UTILITY API 816

 Centric 8 REST API DEVELOPER GUIDE

"Category2 > IssueLog > Collection > Style > MerchProductVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > Colorway > MerchOptionVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion > MerchVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion > MerchSeason >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion >

MerchSecondaryVersion > MerchSecondaryPlan > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion >

MerchSecondaryVersion > MerchLevel > MerchPlan",

"Category2 > Collection > Style > Style > MerchProductVersion > MerchLevel
> MerchPlan",

"Category2 > Collection > Wbs > Colorway > MerchOptionVersion > MerchLevel
> MerchPlan",

"Category2 > Collection > Wbs > Style > MerchProductVersion > MerchLevel
> MerchPlan",

"Category2 > StructureItemDefaults > Wbs > Colorway > MerchOptionVersion

> MerchLevel > MerchPlan",

"Category2 > StructureItemDefaults > Wbs > Style > MerchProductVersion >
MerchLevel > MerchPlan",

"Category2 > StructureItemDefaults > Collection > Style >

MerchProductVersion > MerchLevel > MerchPlan"

Switch “incoming” parameter to “true” to see the incoming relationships instead.

In C8 attributes, a relationship could have one or both directions. See in class browser incoming
on the left side (green color) and the rest on the right side (red color).

UTILITY API 817

 Centric 8 REST API DEVELOPER GUIDE

The max_depth parameter is limiting how deep the relationship is explored (a higher number
will slow down the performance)

This API is restricted to the Admin role.

Possible improvements are as follows:

1. Speed up the performance

Create model file for UML viewer (xml?)
Sort output by most useful case
Display details of relationship like attr name, attr type, etc.

UTILITY API 818

 Centric 8 REST API DEVELOPER GUIDE

ClassRelationship
The API displays a path between two C8 classes.

It will help a developer, a business consultant or a customer’s admin to answer the question
on how domain classes are related.

For example, to find out how Category2 (Department) is related to MerchPlan, run the
following url:

<host>/csi-
requesthandler/api/v2/class_relationship?begin=Category2&end=MerchPlan&incoming=false&max_dep
th=7

See the output:

"paths": [

"Category2 > Collection > Style > MerchProductVersion > MerchLevel >
MerchPlan",

"Category2 > IssueLog > Collection > Style > MerchProductVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > Colorway > MerchOptionVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion > MerchVersion >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion > MerchSeason >
MerchLevel > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion >

MerchSecondaryVersion > MerchSecondaryPlan > MerchPlan",

"Category2 > Collection > Style > MerchProductVersion >

MerchSecondaryVersion > MerchLevel > MerchPlan",

"Category2 > Collection > Style > Style > MerchProductVersion > MerchLevel
> MerchPlan",

"Category2 > Collection > Wbs > Colorway > MerchOptionVersion > MerchLevel
> MerchPlan",

UTILITY API 819

 Centric 8 REST API DEVELOPER GUIDE

"Category2 > Collection > Wbs > Style > MerchProductVersion > MerchLevel
> MerchPlan",

"Category2 > StructureItemDefaults > Wbs > Colorway > MerchOptionVersion

> MerchLevel > MerchPlan",

"Category2 > StructureItemDefaults > Wbs > Style > MerchProductVersion >
MerchLevel > MerchPlan",

"Category2 > StructureItemDefaults > Collection > Style >

MerchProductVersion > MerchLevel > MerchPlan"

Switch “incoming” parameter to “true” to see the incoming relationships instead.

In C8 attribute relationship could have one or both directions. See in class browser incoming
on the left side (green color) and the rest on the right side (red color).

The max_depth parameter is limiting how deep the relationship is explored (higher number
will slow down the performance)

This API is restricted to the Admin role.

Possible improvement:

1. Speed up the performance

Create model file for UML viewer (xml?)
Sort output by most useful case
Display details of relationship like attr name, attr type, etc.

UTILITY API 820

 Centric 8 REST API DEVELOPER GUIDE

7. SAMPLE UTILITY CODES IN JAVA

DISCLAIMER: All the sample code provided in the Centric Rest API Developer Guide are “as -
is”. They are only to illustrate the usage in a specific web programming language and are
unsupported by Centric product support. Developers can freely use and modify these code
samples to suite their need.

Creating Time String Parameter

In Centric REST API, the time string has to be expressed in a certain format. For example, if you
want to filter based on _modified_at, you have to create a query parameter with correct time
string. The following java code will generate the correct time string from a Java Date.

import java.time.format.DateTimeFormatter;

import java.time.Instant;

import java.time.ZoneId;
import java.util.Date;

public class Date2String {

// Create an instance of date you want to convert and pass it to the method.
// It will return a C8 date formatted string

public String getC8DateString(Date date) {

return
DateTimeFormatter.ISO_INSTANT.withZone(ZoneId.of("UTC")).format(Instant.ofEp
ochMilli(date.getTime()));
}

Date2String() {

Date date = new Date();

System.out.println(getC8DateString(date));

public static void main(String[] ar) {

new Date2String();

SAMPLE UTILITY CODES IN JAVA 821

 Centric 8 REST API DEVELOPER GUIDE

Encoding and Decoding a URI

The C8 REST API requires special characters in URI to be double encoded before making a REST Call. An
example of double encoding will be:

Original URI: centric://APPAREL/Style/44

Single escaped URI: centric%3A%2F%2FAPPAREL%2FStyle%2F44
Double escaped URI: centric%253A%252F%252FAPPAREL%252FStyle%252F44

Java Program example to encode and decode URI

This utility program in Java makes an unencoded URI into a double escaped URI or decodes a
double escaped URI into a non-escaped URI.

import java.net.URLEncoder;

import java.net.URLDecoder;

import java.io.UnsupportedEncodingException;

public class JavaUrlEncoderSample {

public static void main(String[] args) {

String [] wkArgs = null;

if (args.length != 0) {
wkArgs = args;

} else {
System.out.println("Enter the string to encode or decode");

System.exit(0);

for (int x = 0; x < wkArgs.length; x++) {

String arg = wkArgs[x];

String step1;

String step2;

String mode = "?";

try {

if (arg.indexOf('%') >= 0) { // decode

mode = "decode";

step1 = URLDecoder.decode(arg,"UTF-8");

step2 = URLDecoder.decode(step1, "UTF-8");

SAMPLE UTILITY CODES IN JAVA 822

 Centric 8 REST API DEVELOPER GUIDE

if (step1.equals(step2)) {

System.out.println("Input arg: '"+arg+"' not double

encoded, decoded to: '" + step1 + "'.");

continue;

} else {

System.out.println("Input arg: '" + arg + "' first

decode: '" + step1 + "', second decode: '" + step2 + "'.");
continue;

} else { // encode
mode = "encode";

step1 = URLEncoder.encode(arg, "UTF-8");

if (step1.equals(arg)) {

System.out.println("Input arg: '" + arg + "' does

not require encoding.");

continue;

step2 = URLEncoder.encode(step1, "UTF-8");

System.out.println("Input arg: '" + arg + "' first

encode: '"+ step1 + "', second encode: '" + step2 + "'.");

}
} catch (UnsupportedEncodingException uee) {

System.err.println("UnsupportedEncodingException: " + uee +

" attempting to: " + mode + " argument " + wkArgs[x] + ".");
}

}
}

public String doubleEncodeString(String strToEncode) {

String step1;
String step2;

try {

step1 = URLEncoder.encode(strToEncode, "UTF-8");

if (step1.equals(strToEncode)) {

SAMPLE UTILITY CODES IN JAVA 823

 Centric 8 REST API DEVELOPER GUIDE

System.err.println("Input arg: '" + strToEncode + "' does

not require encoding.");
return null;

step2 = URLEncoder.encode(step1, "UTF-8");

System.out.println("Input arg: '" + strToEncode + "' first

encode: '"+
step1 + "', second encode: '" + step2 + "'.");

return step2;

} catch (UnsupportedEncodingException uee) {

System.err.println("UnsupportedEncodingException: " + uee + "

attempting to encode argument " + strToEncode + ".");

}
return null;

Encoding Decoding in HTML and Javascript example:

A HTML and Javascript based utility you can use to encode and decode interactively.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"

"http://www.w3.org/TR/html4/strict.dtd">

<!—Centric 8 Utility for encoding and decoding URI -->

<!-- Ver 1.0 Soumya Mitra -->

<html>

<body>
<p>Click the button to process the string.</p>

<FORM NAME="EncodeDecodeForm">

<INPUT TYPE="button" Value="Encode"

onClick="encodeFunction()">

<INPUT TYPE="text" NAME="stringToEncode" size="100" Value =

"centric://APPAREL/Style/44">
<br/><br/>

<INPUT TYPE="button" Value="Decode"

onClick="decodeFunction()">

SAMPLE UTILITY CODES IN JAVA 824

 Centric 8 REST API DEVELOPER GUIDE

<INPUT TYPE="text" NAME="stringToDecode" size="100" Value =

"centric%253A%252F%252FAPPAREL%252FStyle%252F44">
<p id="Line0"></p>

<p id="Line1"></p>

<p id="Line2"></p>

<p id="Line3"></p>

<p id="Line4"></p>

<p id="Line5"></p>

<script>

function encodeFunction() {
var uri = document.EncodeDecodeForm.stringToEncode.value;

var ecode = encodeURIComponent(uri);

var dbecode = encodeURIComponent(ecode);

document.getElementById("Line0").innerHTML = "Original string to encode:

" + uri;
document.getElementById("Line1").innerHTML = "Single encoded: " + ecode;

document.getElementById("Line2").innerHTML = "Double encoded: " +

dbecode;
}

function decodeFunction() {

var uri = document.EncodeDecodeForm.stringToDecode.value;

var sdcode = decodeURIComponent(uri);

var ddcode = decodeURIComponent(sdcode);

document.getElementById("Line3").innerHTML = "Original string to decode:

" + uri;

document.getElementById("Line4").innerHTML = "Single decoded: " +

sdcode;

document.getElementById("Line5").innerHTML = "Double decoded: " +

ddcode;
}

</script>

</body>

</html>

SAMPLE UTILITY CODES IN JAVA 825

 Centric 8 REST API DEVELOPER GUIDE

Uploading a document using DocumentRevisions

A Java example to show how to upload a document to Centric filevault by using
DocumentRevision

Uploading a 3D Document is exactly same as uploading a regular Document. A 3D Document

is a regular zip file with pre-packaged 3D model and, optionally, material information. The
“is_3d” attribute of the Document object when true, indicates the uploaded file is a Centric 3D
file. The “is_3d” = “true” will also trigger a special upload validation to prevent regular zip file
to be uploaded as 3D file. The Centric web app uses the “is_3d” attribute to launch 3D widget
to view the 3D interactively.

public HttpResultBean docUpload(File docFile, String documentRevisionId)

throws Exception {
try {

// Initializing the HttpPost for Season endpoints

String uriString = uriBase + "document_revisions/" +

documentRevisionId + "/upload";

httpPut = new HttpPut(uriString);

// ensure the response will be in JSON format

httpPut.addHeader(HttpHeaders.ACCEPT, "application/json");

MultipartEntityBuilder mpeBuilder =
MultipartEntityBuilder.create().setMode(HttpMultipartMode.BROWSER_COMPATIBLE
);

mpeBuilder.addBinaryBody("file", docFile);
HttpEntity multiPartEntity = mpeBuilder.build();
httpPut.setEntity(multiPartEntity);

// Executing the PUT

httpResponse = closableHttpClient.execute(httpPut);

// Loading HttpResultBean with Error code and communicate to the

caller

hrb = new HttpResultBean();

hrb.setResultBean(httpResponse, true);

} catch (Exception e) {
e.printStackTrace();

} finally {

SAMPLE UTILITY CODES IN JAVA 826

 Centric 8 REST API DEVELOPER GUIDE

// Closing open httpResponse

if (httpResponse != null)

httpResponse.close();

}
return hrb;

Uploading a file or a 3D Document using Documents endpoint

Uploading a file or a Centric 3D file using the Documents endpoint

Uploading a 3D Document is exactly same as uploading a regular Document as 3D Document

is a regular zip file with pre-packaged 3D model and optionally material information. The
“is_3d” attribute of the Document object when true, indicates the uploaded file is a Centric 3D
file. The “is_3d” = “true” will also trigger a special upload validation to prevent regular zip file
to be uploaded as 3D file. The Centric web app uses the “is_3d” attribute to launch 3D widget
to view the 3D interactively.

3D zip files and 3D Material zip files can be uploaded to following objects:

▪ "ColorMaterial",
▪ "Material",
▪ "MaterialSample",
▪ "Sample",
▪ "SupplierItem",
▪ "SRLineItem",
▪ "Style",
▪ "Theme"

The upload variations:

1. Create a simple document - upload normal, 3d file and 3d Material file all should work
2. Create a document with attribute is3D=true, upload normal, 3d file and 3d Material file
all should work.
3. Create a document with attribute is3D=true, upload normal, 3d file, and 3d Material
file. First, two should work but 3D Material upload can not be done for endpoints like
“shape”

SAMPLE UTILITY CODES IN JAVA 827

 Centric 8 REST API DEVELOPER GUIDE

/" set is3D=”true” for a Centric 3D file, otherwise pass is3D=”false”

public HttpResultBean 3DUpload(String is3D, File docFile,

String parentID, String docNodeName)

throws Exception {
try {

// Initializing the HttpPost for Season endpoints

String uriString = uriBase + c8Endpoints.Documents + "/parents/"
+ parentID + "/upload";

httpPut = new HttpPut(uriString);

// ensure the response will be in JSON format

httpPut.addHeader(HttpHeaders.ACCEPT, "application/json");
HttpPost httpPost = new HttpPost(uriString);

httpPost.addHeader(HttpHeaders.ACCEPT_ENCODING,

"multipart/form-data");

MultipartEntityBuilder mpeBuilder =
MultipartEntityBuilder.create().setMode(HttpMultipartMode.BROWSER_COMPATIBLE
)
mpeBuilder.addBinaryBody("file", docFile);

mpeBuilder.addTextBody("node_name", docNodeName);

mpeBuilder.addTextBody("is_3d", is3D); // <--- Add this line for a 3D

Document
HttpEntity multiPartEntity = mpeBuilder.build();

httpPost.setEntity(multiPartEntity);

// Executing the PUT

httpResponse = closableHttpClient.execute(httpPut);

// Loading HttpResultBean with Error code and messages to

// communicate to caller

hrb = new HttpResultBean();

hrb.setResultBean(httpResponse, true);

} catch (Exception e) {

e.printStackTrace();
} finally {

// Closing open httpResponse

SAMPLE UTILITY CODES IN JAVA 828

 Centric 8 REST API DEVELOPER GUIDE

if (httpResponse != null)

httpResponse.close();

return hrb;
}

SAMPLE UTILITY CODES IN JAVA 829

 Centric 8 REST API DEVELOPER GUIDE

8. JAVA SAMPLE REST CLIENT CODE

We have built a sample REST client application to illustrate the important API concepts. The
diagram below shows how a Centric REST Client application interacts with a Centric Server
(REST Service Provider) using the HTTP protocol.

The REST Client invokes the REST endpoint (HTTP URI) using appropriate HTTP methods POST,
GET, PUT, DELETE and sends the attributes/parameters by loading them in XML or JSON
payload or in HTTP header. The REST service provider performs the necessary business
transaction for the request and returns the result XML/JSON payload with an appropriate
HTTP error code such as 200 (successful HTTP request).

An HTTP client interacts with the REST service provider using HTTP, so the client can be
written by using any HTTP capable Internet programming language. The example we have
provided uses Java, however any suitable language and framework can be used make the
REST calls, such as: C++, Python etc.

All sample codes provided here are “as-is” and Centric Technical
support will not provide any assistance in setting up, debugging or
modifying these codes. You are free to change and adapt these
codes to work with your Centric Server and environment.

How to Setup Development Environment

We have used two open source libraries from Apache Foundation and Google to write this
example. It is possible to write an REST client using only out of the box JDK libraries, however
using these two open source libraries greatly simplify the communication and cookie
management so the example code becomes more readable. To try out the example code,
please download the following open source libraries from Apache and Google Maven
repositories and add them to the java IDE library path:

JAVA SAMPLE REST CLIENT CODE 830

 Centric 8 REST API DEVELOPER GUIDE

HTTP client and core library from Apache foundation

https://mvnrepository.com/artifact/org.apache.httpcomponents

Gson from Google https://mvnrepository.com/artifact/com.google.code.gson/gson

The following screenshot shows how to set the required open source jar files in Eclipse IDE
library path.

In the following section I will explain the important communication code snippets, without
going into line by line explanation of the example code. Please look into the complete source
code to see how these code snippets have been used in the actual example.

Calling Centric REST API using Java

Use this pattern to call any Centric REST endpoints. In this example, we are invoking the
Session endpoint to log on to the Centric 8 server. Without a valid logon, all REST API call will
return unauthorized access error. Let us assume the Centric 8 server URI is http://c8server

Step 1
Instantiate a HttpPost/HttpGet/HttpPut/HttpDelete object as appropriate for the REST
endpoint.

httpPost = new HttpPost(“http://c8server/csi-

requesthandler/api/v2/session”);

The HttpPost object will call the Session endpoint using Http POST method, HttpGet will call
the endpoint with HTTP GET method and so on.

Step 2
Create the JSON payload by initializing a StringEntity with identity information

String json = "{\"username\": \"" + username + "\", \"password\": \"" +

password + "\" }";

JAVA SAMPLE REST CLIENT CODE 831

 Centric 8 REST API DEVELOPER GUIDE

stringEntity = new StringEntity(json);

stringEntity.setContentType("application/json");

Step 3
Load the StringEntity to the HttpPost you have instantiated in step 1

httpPost.setEntity(stringEntity);

Step 4
Execute the POST call to Session endpoint and retrieve the HTTP response from the Centric 8
server. This response will contain the session token in the JSON payload as well as the HTTP
error code

CloseableHttpResponse httpResponse;
httpResponse = closableHttpClient.execute(httpPost);

Step 5
Parse the HTTPResponse

// get the error code

httpResponse.getStatusLine().getStatusCode();

// get the error message

httpResponse.getStatusLine().getReasonPhrase();

// get the http response headers

httpResponse.getAllHeaders();

// get the entity which contains the JSON or XML return payload

httpResponse.getEntity());

Step 6
Do not forget to close the HTTP response.

httpResponse.close();

The actual working example code is provided in the following pages.

Client Source Code - TestREST

/*
An example java program to illustrate how to use C8 REST API.

This is the entry point of the program.

JAVA SAMPLE REST CLIENT CODE 832

 Centric 8 REST API DEVELOPER GUIDE

Author: Soumya Mitra

Date: September 28, 2016

Version: 1.0

DISCLAIMER: This code is provided as is as an example and unsupported by

Centric 8 technical support.

License: Creative Commons Attribution-ShareAlike

*/
public class TestREST {

HttpResultBean resultBean;

TestREST() {

// Creating an instance or worker class

CallREST callrest = new CallREST();

resultBean = new HttpResultBean();

try {

// ========== Testing Session Login ================

resultBean = callrest.login("<username>", "<password>" );

System.out.println("Headers received from server for Session POST =====");

resultBean.printHeaders();

System.out.println("JSON: " + resultBean.toPrettyFormat() + "\n-------------

---------\n");

// ========== Testing Season ================

resultBean = callrest.seasons(0, 10);

System.out.println("Headers received from server for Seasons GET =====");
resultBean.printHeaders();

System.out.println("JSON: " + resultBean.toPrettyFormatArray() + "\n--------

--------------\n");
// ========== Testing MaterialType ================

resultBean = callrest.materialTypes(0, 10);

System.out.println("Headers received from server for MaterialTypes GET

=====");

resultBean.printHeaders();

JAVA SAMPLE REST CLIENT CODE 833

 Centric 8 REST API DEVELOPER GUIDE

System.out.println("JSON: " + resultBean.toPrettyFormatArray() + "\n--------

--------------\n");
// ========== Testing Session Logout ================

resultBean = callrest.logout();

System.out.println("Headers received from server for Session DELETE =====");

resultBean.printHeaders();

// =========== close the client session ===========

callrest.closableHttpClient.close();

} catch(Exception e) { // Catch any exception while

// closing the connection

e.printStackTrace();

}
}

public static void main(String argv[]){

new TestREST();

Source Code: CallREST

/*

An example java program to illustrate how to use C8 REST API

Uses:

open-source HTTP client and core library from Apache foundation

https://mvnrepository.com/artifact/org.apache.httpcomponents

and

Gson from Google

https://mvnrepository.com/artifact/com.google.code.gson/gson

Author: Soumya Mitra

Date: September 28, 2016

Version: 1.0

DISCLAIMER: This code is provided as is as an example and unsupported by

Centric 8 technical support.

License: Creative Commons Attribution-ShareAlike

*/

JAVA SAMPLE REST CLIENT CODE 834

 Centric 8 REST API DEVELOPER GUIDE

import org.apache.http.impl.client.*;

import org.apache.http.impl.cookie.BasicClientCookie;

import org.apache.http.protocol.BasicHttpContext;

import org.apache.http.HttpHeaders;
import org.apache.http.client.methods.*;

import org.apache.http.client.protocol.HttpClientContext;
import org.apache.http.entity.*;
import java.io.IOException;

import java.net.CookieHandler;

import java.net.CookieManager;

import java.util.StringTokenizer;

public class CallREST {

CloseableHttpClient closableHttpClient;

CloseableHttpResponse httpResponse;

HttpGet httpGet;

HttpPost httpPost;

HttpDelete httpDelete;

org.apache.http.Header[] httpResponseHeader;

StringEntity stringEntity;

HttpResultBean hrb = new HttpResultBean();

String[] httpHeaderValues;

StringTokenizer st;

BasicHttpContext basicContext;
BasicCookieStore basicCookieStore;

BasicClientCookie basicCookie;

public CallREST() {

CookieHandler.setDefault(new CookieManager());

basicContext = new BasicHttpContext();

basicCookieStore = new BasicCookieStore();

basicContext.setAttribute(HttpClientContext.COOKIE_STORE,
basicCookieStore);

JAVA SAMPLE REST CLIENT CODE 835

 Centric 8 REST API DEVELOPER GUIDE

closableHttpClient =
HttpClientBuilder.create().setDefaultCookieStore(basicCookieStore).build();
}

/*

===============================================

REST calls to Session

endpoint

==================== START ====================

*/

// Login
// Returns HTTP error code and message in HttpResultBean

public HttpResultBean login(String username, String password)

throwsException{
try {

// Initializing the HttpPost for Session endpoints

httpPost = new HttpPost(C8Endpoints.SESSION);

// Initializing a StringEntity with identity JSON object

String json = "{\"username\": \"" + username + "\",

\"password\": \"" + password + "\" }";

stringEntity = new StringEntity(json, “UTF-8”);

stringEntity.setContentType("application/json");
// Loading the StringEntiry to the HttpPost request

httpPost.setEntity(stringEntity);

// Executing the POST to Session endpoint for login and setting

session cookie

httpResponse = closableHttpClient.execute(httpPost);

// Loading HttpResultBean with Http Error code and messages to

communicate to caller
hrb.setResultBean(httpResponse);

} catch(Exception e){

e.printStackTrace();
}

finally{

JAVA SAMPLE REST CLIENT CODE 836

 Centric 8 REST API DEVELOPER GUIDE

// Closing open httpResponse

if(httpResponse != null)

httpResponse.close();

return hrb;
}

// Logout

// Returns HTTP error code and message in HttpResultBean

public HttpResultBean logout() throws IOException{

try{

// Initializing the HttpDelete for Session endpoints

httpDelete = new HttpDelete(C8Endpoints.SESSION);

// Executing the DELETE request to the Session endpoint to

logout
httpResponse = closableHttpClient.execute(httpDelete);

// Loading HttpResultBean with Http Error code and messages

to communicate to caller

hrb.setResultBean(httpResponse);

} catch(Exception e){
e.printStackTrace();

}
finally{

// Closing open httpResponse

if(httpResponse != null)
httpResponse.close();

this.invalidateCookie();
}

// returning the HttpResultBean to the caller

JAVA SAMPLE REST CLIENT CODE 837

 Centric 8 REST API DEVELOPER GUIDE

return hrb;

/* ===============================================
REST calls to Session endpoint

===================== END ===================== */

/* ===============================================

REST calls to Season endpoint

==================== START ==================== */

// Get all seasons from Centric 8 Server

// Returns season array, HTTP error code and message in HttpResultBean

public HttpResultBean seasons(int skip, int limit ) throws Exception{

try {

// Initializing the HttpPost for Season endpoints

String uriString = C8Endpoints.SEASON +

"/?skip="+skip+"&limit=" + limit;
httpGet = new HttpGet(uriString);

// ensure the response will be in JSON format

httpGet.addHeader(HttpHeaders.ACCEPT, "application/json");

// Executing the POST to Season endpoint

httpResponse = closableHttpClient.execute(httpGet);

// Loading HttpResultBean with Http Error code and messages

to communicate to caller

hrb.setResultBean(httpResponse);

} catch(Exception e){
e.printStackTrace();

}
finally{

// Closing open httpResponse

if(httpResponse != null)

JAVA SAMPLE REST CLIENT CODE 838

 Centric 8 REST API DEVELOPER GUIDE

httpResponse.close();

return hrb;

/* ===============================================
REST calls to MaterialTypes endpoint
==================== START ==================== */

// Get all MaterialTypes from Centric 8 Server

// Returns MaterialType array, http error code and message in

HttpResultBean

public HttpResultBean materialTypes(int skip, int limit )

throwsException{
try {

// Initializing the HttpGet for MaterialTypes endpoint

String uriString = C8Endpoints.MATERIAL_TYPE +

"/?skip="+skip+"&limit=" + limit;

httpGet = new HttpGet(uriString);

// ensure the response will be in JSON format

httpGet.addHeader(HttpHeaders.ACCEPT,
"application/json");

// Executing the GET to MaterialTypes endpoint

httpResponse = closableHttpClient.execute(httpGet);

// Loading HttpResultBean with Http Error code and

messages to communicate to caller

hrb.setResultBean(httpResponse);
} catch(Exception e){
e.printStackTrace();

finally{
// Closing open httpResponse

if(httpResponse != null)

JAVA SAMPLE REST CLIENT CODE 839

 Centric 8 REST API DEVELOPER GUIDE

httpResponse.close();

return hrb;

public void setCookie(String id, String value) {

System.out.println("Seeting Cookie: " + id + " " + value);
basicCookieStore.addCookie(new BasicClientCookie(id,value));

public void invalidateCookie() {

basicCookieStore.clear();

Source Code: HttpResultBean

/*

An example java program to illustrate how to use C8 REST API

Uses open-source HTTP client and core library from Apache foundation
https://mvnrepository.com/artifact/org.apache.httpcomponents

and Gson from Google https://mvnrepository.com/artifact/com.google.code.gson/gson

Author: Soumya Mitra

Date: September 28, 2016. Version: 1.0

DISCLAIMER: This code is provided as is as an example and not supported by

Centric 8 technical support.

License: Creative Commons Attribution-ShareAlike

*/

import org.apache.http.Header;

import org.apache.http.HttpEntity;

import org.apache.http.client.methods.CloseableHttpResponse;

import org.apache.http.util.EntityUtils;

import com.google.gson.Gson;

import com.google.gson.GsonBuilder;

import com.google.gson.JsonArray;

JAVA SAMPLE REST CLIENT CODE 840

 Centric 8 REST API DEVELOPER GUIDE

import com.google.gson.JsonObject;

import com.google.gson.JsonParser;

public class HttpResultBean {

private int httpCode = 0;

private String httpErrorMessage = "";

private String[] headerValues = null;

private Header[] headers = null;

private HttpEntity entity = null;

private String stringBody = null;

private String resultJSON = null; // Will contain REST API Http Response JSON
Payload

private JsonArray jsonArray;

JsonObject jsonObject;

private boolean resultIsArray = false;

public boolean isResultArray() {

return resultIsArray;

private void setJSONString(String json) {

this.resultJSON = json;

public void setHttpCode( int i) {

this.httpCode = i;
}

public void setHttpErrorMessage(String s) {

this.httpErrorMessage = s;

public void setHeaders(Header[] hdrs){

if(hdrs != null) {

headers = hdrs;

headerValues = new String[hdrs.length];

for ( int ctr=0; ctr<hdrs.length; ctr++ ) {

headerValues[ctr] = hdrs[ctr].getValue();

JAVA SAMPLE REST CLIENT CODE 841

 Centric 8 REST API DEVELOPER GUIDE

public void setEntity(HttpEntity httpEntity){

entity = httpEntity;

if (entity != null) {

// A Simple JSON Response Read

try {

this.resultIsArray = false;
this.setJSONString(EntityUtils.toString(httpEntity));

if (this.resultJSON.charAt(0) == '[') { // found an array

this.resultIsArray = true;

jsonArray = (JsonArray)jsonParser.parse(this.resultJSON);

} else if (this.resultJSON.charAt(0) == '{') {

// found an object

jsonObject = jsonParser.parse(this.resultJSON).getAsJsonObject();

} else {

System.err.println("Unrecognized JSON data type, expect it to

start with '[' or '{' \n" +

this.resultJSON);

System.exit(8);

} catch (Exception e) {

e.printStackTrace();

public void setBody(String stringbody) {

this.stringBody = stringbody;

public void setResultIsArray(boolean resultIsArray) {

this.resultIsArray = resultIsArray;

public void setResultBean(CloseableHttpResponse closableHttpResponse) {

// First initialize all setters to make sure no old values get cached

this.setHeaders(null);

this.setHttpCode(0);

JAVA SAMPLE REST CLIENT CODE 842

 Centric 8 REST API DEVELOPER GUIDE

this.setHttpErrorMessage("");

this.entity = null;

this.resultJSON = "";

// Load new values into the bean from HttpResponse

setHttpCode(closableHttpResponse.getStatusLine().getStatusCode()); //
getting the HTTP error code

setHttpErrorMessage(closableHttpResponse.getStatusLine().getReasonPhrase()); //
getting the error message

setHeaders(closableHttpResponse.getAllHeaders()); // getting all

httpheaders

setEntity( closableHttpResponse.getEntity());

public String getJSONString() {

return this.resultJSON;

public int getHttpCode() {

return this.httpCode;

public String getHttpErrorMessage() {

return this.httpErrorMessage;

public String[] getHeaderValues(){

return headerValues;

public Header[] getHeaders() {

return headers;

public HttpEntity getEntity(){

return entity;

public String getBody() {

return this.stringBody;

void printHeaders() {

// Analyzing the returned error code and message

JAVA SAMPLE REST CLIENT CODE 843

 Centric 8 REST API DEVELOPER GUIDE

System.out.println("Http error code: " + this.getHttpCode() + " " +

this.getHttpErrorMessage());

System.out.println("Header vales: ");

if(this.headerValues != null) {

for(int ctr=0; ctr < this.headerValues.length; ctr++) {

System.out.println(this.headerValues[ctr]);

public String toPrettyFormatArray() // Utility to print pretty JSON Array

JsonParser jsonParser = new JsonParser();

JsonArray jsonArray = (JsonArray) jsonParser.parse(this.resultJSON);

Gson prettyGson = new GsonBuilder().setPrettyPrinting().create();

String prettyJson = prettyGson.toJson(jsonArray);

return prettyJson;

public String toPrettyFormat() // Utility to print pretty JSON object

JsonParser jsonParser = new JsonParser();

JsonObject json = jsonParser.parse(this.resultJSON).getAsJsonObject();

Gson prettyGson = new GsonBuilder().setPrettyPrinting().create();

String prettyJson = prettyGson.toJson(json);

return prettyJson;

Source Code: C8Endpoints

/*

This class contains static variables defining URI of C8

Server. Modify it to point to your Centric 8 server

Author: Soumya Mitra

Date: September 28, 2016. Version: 1.0

DISCLAIMER: This code is provided as is as an example and unsupported by

Centric 8 technical support.

JAVA SAMPLE REST CLIENT CODE 844

 Centric 8 REST API DEVELOPER GUIDE

License: Creative Commons Attribution-ShareAlike

*/

public class C8Endpoints {

public static String C8URI = "http://<c8server-and-port>/csi-

requesthandler/api/v2/"; // replace with your C8 server URI

public static String SESSION = C8URI + "session";

public static String SEASON = C8URI + "seasons";

public static String MATERIAL_TYPE = C8URI + "material_types";

public static String COLORWAY = C8URI + "colorway";

JAVA SAMPLE REST CLIENT CODE 845

 Centric 8 REST API DEVELOPER GUIDE

9. FAQ

Object Change Detection

Most Centric business objects contain an attribute named: _modified_at

The purpose of this attribute is to record when a business object has been changed by an user.
A System initiated object change does not change this attribute. Note that modified_at is what
is known as an intent timestamp, not a commit timestamp. As a transaction runs, it posts the
modified_at values as it goes, but these values do not become visible until the transaction
commits.

Normally there is only a short lag between modified_at and commit_time, but sometimes
modified_at may lag by several minutes. This means that modified_at values not only lag, they
may not even be posted in ascending order. If you run a query at 10:00, you may come along
a few minutes later and see that a new transaction has just posted a modified_at time value
of 9:55. Therefore, modified_at is not reliable for detecting changes in a system where update
transactions are running. Relying on modified_at, you could miss detecting changes. You
should instead be looking at the Shadow Table integration features, for true transaction-based
change detection. Refer to the topic REST GET incremental updates to RET endpoints in the
C8 Advanced Administrator – Volume II document.

A simple modified_at example:

1. Query a specific Centric Style by using Style endpoint

Record the value of the _modified_at attribute
Run the same query of Step 1. again and check the _modified_at attribute, which will
remain unchanged as no attribute of that Style has been changed yet.
Change any attribute of the Style from Centric UI or by Rest API.
Run the same query of Step 1. again and check the _modified_at attribute, it will now be
changed as the Style has been changed.

REST Session timeout

REST session is the same as the http session maintained by the Centric Server. There is no
separate code or setting for REST to configure or resolve the session timeout issue. All session

FAQ 846
 Centric 8 REST API DEVELOPER GUIDE

timeout issues should be resolved by inspecting the Centric Server configuration carefully
while consulting the Centric Server Admin Guide.

Please note that from Centric 7.0 onwards uses Undertow as the web server and supports web
socket. The earlier version of Centric used IIS as the web server. To support Web socket,
Centric Server now checks for web socket connection for every http request. If the web socket
connection fail for 10 times, then server/client will automatically expire the session. Please
check the C8 configuration for Undertow and adjust the following to resolve the issue:

▪ Increased the number of maximum connections

▪ Set Keep-Alive to true
▪ Cookies should not be used

Create an on-line Customers, Suppliers and SalesDivision

In Centric Web UI, you can create an on-line user for the Customer, Supplier or Sales Division
as follows:

We will replicate creating an online user as we do in the Centric web interface as shown above.
This can be done in two ways.

Three steps processes as shown below:

Step 1: create Supplier, Customer, and SalesDivision using following Rest endpoints.

▪ POST /suppliers
▪ POST /customers

FAQ 847
 Centric 8 REST API DEVELOPER GUIDE

▪ POST /sales_divisions

Step 2: Get the newly created Supplier/Customer/SalesDivision id and use that in OnlineCrew
POST method to create a new OnlineCrew object.

POST /online_crews/parent/{parent_id}

Step 3: Add existing User/s to the newly created online crew of the Supplier / Customer /
SalesDivision.

PUT /online_crews/{online_crew_id}

{
"crew_users": [

"C3178",
"C3179"
],

"active": true

Alternate two step method, creating OnlineCrew and linking User in single POST call

Step 1: create Supplier, Customer, and SalesDivision using following Rest endpoints.

▪ POST /suppliers
▪ POST /customers
▪ POST /sales_divisions

Step 2: Get the newly created Supplier/Customer/SalesDivision id and use that in OnlineCrew
POST method to create a new OnlineCrew object.

POST /online_crews/parent/{parent_id}

While passing the following payload to the POST call

"crew_users": [
"C3178",

"C3179"

],

FAQ 848
 Centric 8 REST API DEVELOPER GUIDE

"active": true

Please note the following conditions have to be met for the both above methods:

Condition A: The User passed to the OnlineCrew data payload should not be linked to any
Company, Supplier or SalesDivision objects. The best way to ensure that is to check the User
attributes and make sure they satisfy the following:

▪ identity not equals "centric:"

▪ UserType = "UserType:User"
▪ __Parent__ = "centric:"

Condition B:The Supplier object should have following attribute values:

▪ IsSupplier = "true"
▪ IsAgent = "true"
▪ Crew = "centric:"
▪ State not equals "SourceState:Inactive"

Assigning a role to the on-line Customers, Suppliers and

SalesDivision
Use the following endpoint to assign a role to the OnlineCrew linked to a
Supplier/Customer/SalesDivision

/api/v2/online_crews/{online_crew_id}/assignments

and pass the following payload with the appropriate node_name, user and role values.

"node_name": "string",
"assigned_users": [
"string"

],

"role": "string"
}

FAQ 849
 Centric 8 REST API DEVELOPER GUIDE

A valid Role to assign should have the attributes set as follows:

▪ UsedByOnlineCrew = true
▪ UsedByACL = false

Passing an invalid Role will return an error.

Refset Attribute Changes

Refset attributes were previously wrongly read as reflist and hence the response type was a
list (array). We made changes so that the refset attributes are properly read as refset, and the
response type of such attributes are map (key:value pair).

This change affects all GET/PUT/POST APIs that deal with refset attributes.

Figure 1. Example: GET api call response body

Old Behaviour:

FAQ 850
 Centric 8 REST API DEVELOPER GUIDE

New Behaviour:

Figure 2. Example: PUT/POST api call request body

Old Behavior: The user sends the value as a list

FAQ 851
 Centric 8 REST API DEVELOPER GUIDE

New Behavior: The user has to send the value to refset attributes as a map(key: value pair)

Things to take care of while calling the API:

1. Make sure the integration via such API calls properly read refset response as a map
(key: value pair)
2. Make sure when editing refset attributes, the request payload is sent as a map (key:
value pair)
This change is part of 7.2 SP4, 7.3 SP3, 7.4SP1, 7.5, and future releases.

Calling API in Postman

1. Get detailed API error message
By default, when an API call fails in Postman, the user gets the below generic error
message:

FAQ 852
 Centric 8 REST API DEVELOPER GUIDE

If the user wants to get detailed API error message (same as in C8 Swagger page), pass the
request header “Accept” = “application/json”:

How API attributes behave in Swagger

Understanding API definition in Swagger can give users a lot of information when calling
GET/PUT/POST/DELETE api. This documentation tries to encourage users to understand the
importance of API definition and API Payload.

Legend

1. API Definition:
The "Example Value" section is where the user can see the attributes type (string, List,
Boolean,etc). Example: API definition for GET:Style.

FAQ 853
 Centric 8 REST API DEVELOPER GUIDE

2. API Payload:
It can be seen when the user clicks on "Try It Out" in Swagger. It includes the list of
attributes sent to C8 server.

Attributes and its’s meaning in API definition

Presence of attributes in API definition hosted in Swagger means different things based on
HTTP method
1. GET
a. By default the attributes user sees in the API Definition are the attributes that will be
part of the GET API response.
b. Presence of custom attributes in API definition and API response depends on few
things:
▪ In API response:
• OTB the attributes are rest exposed and present in the API response by
default.

• If custom attributes are "Rest Exposed", they will be part of the API response.

• “Rest Exposed” attributes can be used “Query Parameter” to filter the results.

FAQ 854
 Centric 8 REST API DEVELOPER GUIDE

▪ In API definition:
• To see custom attributes in GET:API definition, after custom attribute is set to
either “Rest Exposed” or “Rest Update”, restart Wildfly server and refresh
Swagger Page.
Example,

Presence of custom attributes on Style object after Wildfly server was restarted
and Swagger page refreshed.

2. PUT
a. Unlike GET method, where user can read API definition and know what attributes will
be part of GET:API response, for PUT method, user should focus on API Payload to
understand what attributes can be edited via API.
b. Unlike GET method, attributes present in API Definition of PUT method does not mean
they can be edited by API.
c. The attributes that are part of API payload can be edited. If any particular attribute is
not present in default API payload in Swagger, most likely the chances are it cannot be
edited via API. Contact support in such cases.
d. To see custom attributes in PUT: API payload, after custom attribute is set to either
“Rest Exposed” or “Rest Update”, restart Wildfly server and refresh Swagger Page.

FAQ 855
 Centric 8 REST API DEVELOPER GUIDE

Example,
Presence of custom attributes on Style object PUT:API payload, after Wildfly server
was restarted and Swagger page refreshed:

3. POST
a. POST API Payload and Definition behaves similar to PUT.

b. API User should focus on API Payload to understand what attributes can be set via API.
c. Attributes present in API Definition of POST method does not mean they can be edited
by API.
d. The attributes that are part of API payload can be set. If any particular attribute is not
present in default API payload in Swagger, most likely the chances are it cannot be
edited via API. Contact support in such cases.
e. To see custom attributes in POST: API definition, after custom attribute is either set to
“Rest Exposed” or “Rest Update”, restart Wildfly server and refresh Swagger Page.
Example,
Presence of custom attributes on Style object PUT:API payload, after Wildfly server
was restarted and Swagger page refreshed:

FAQ 856
 Centric 8 REST API DEVELOPER GUIDE

4. DELETE
a. Delete method is fairly simpler than other http method.

b. After a successful Delete api call, the node is deleted and the attributes that are part
of API Definition will be part of API response with 200 http status.

FAQ 857
 Centric 8 REST API DEVELOPER GUIDE

10. OBJECT DIAGRAM (UML)

Understanding the relationship between the Centric business objects is the key in using the
REST API and efficiently navigate and traverse the Centric 8 object tree. This series of UML
diagram illustrates shows the relationship between key business objects. To keep the diagram
complexity low, we have deliberately omitted some relationship details. Use C8 Class browser
utility from the bottom left corner of the Centric UI to inspect any Centric node objects in full
details.

Style hierarchy

OBJECT DIAGRAM (UML) 858

 Centric 8 REST API DEVELOPER GUIDE

11. HTTP CODES AND MESSAGES

The HTTP standard provides a list of status codes to convey the success or error status of each
request. The C8 REST API utilizes the subset of these codes relevant to C8 operation, while
preserving full error details in the JSON or XML error response body. The HTTP status codes
utilized by the C8 REST API are as follows:

HTTP Status code Caused by

200 Successful REST API call
201 Successful create
204 Success with no additional content
400 Bad request
401 Not authorized
403 javax.ws.rs.ForbiddenException
404 Not found
405 Trying to call an endpoint with unsupported http method
406 javax.ws.rs.NotAcceptableException
415 javax.ws.rs.NotSupportedException
500 Internal server error
503 javax.ws.rs.ServiceUnavailableException

HTTP CODES AND MESSAGES 859

 Centric 8 REST API DEVELOPER GUIDE

12. ERROR CODES AND MESSAGES

The http error code provides very high level summary of the underlying error condition. This
is not sufficient for coding a graceful error recovery. We are addressing that by augmenting
the error message with enhanced code and message verbiage. In REST API V2 for Centric 6.5,
only a subset of REST endpoints provides this enhanced error message. We will keep on adding
more endpoints in the future releases to cover 100% of the Centric REST API. The Table A lists
the REST endpoints which provides the enhanced error message and the Table B contains the
list of the enhanced error code and messages.

Table A

List of Centric 6.5 REST endpoints having enhanced error capability

BOMSectionDefinition
CareAndComposition endpoint
CareAndCompositionRevision endpoint
CareSymbol endpoint

ColorMaterial

Colorway

Contact

CurrencyExchangeRate
ColorColorwayContext

CurrencyExchangeTable

CustomerPurchaseOrder
EnumList

EnumValue

Localization

LookupItem

MarketingCollection

MarketingLook

MarketingSegment

MaterialPlanPlacementColorway

Material

MCMaterial

ERROR CODES AND MESSAGES 860

 Centric 8 REST API DEVELOPER GUIDE

MCProductColor
MCProduct

Table B

Exception class Error Error Error message

Code message example

NodeNotExistsException C200 Referenced No such node: 'C4567’

Node doesn’t
exists

NodeWrongTypeException C210 Referenced Wrong type: for node 'C4567’

Node is a wrong
type

AttributeRequiredException C100 An attribute is Attribute 'description' is

required required'

AttributeRequireConditionExcept C110 Setting the Cannot set attribute ‘color’

ion attribute since it’s not in the parent
requires a
particular
condition

WrongAttributeValueException C120 An attribute has 'C4567's attribute ‘is_dim’ is

an 'false’, but must be: 'true’
impermissible
attribute value

NodeMustBeActiveException C121 The node must 'C4567's attribute ‘Active’ is

be active (active 'false’, but must be: 'true’
set to true or No
Inactive state)

WrongStateException C122 The state not Cannot change state

allowed ‘Approved’ from state: ‘Draft’

AttributeMustNotSpecifiedExcept C130 The attribute Attribute ‘description’ should not

ion must not be be set
specified

UnknownAttributeException C140 An attribute is Unknown attribute: 'id' on

unknown 'C1234'. Unknown attribute: 'id'

CustomAttributeException C150 A problem with a No such node: 'C1234' for

custom attribute attribute: 'MyCustomAttr'.

NodeNotValidException C300 Node validation Node C1502 failed to pass

failed validation rules.

ERROR CODES AND MESSAGES 861

 Centric 8 REST API DEVELOPER GUIDE

NodeNotUniqueException C310 The node is not Node C1502 failed to pass

unique validation rules. Details:
Season.Action.Validation__Uni
que__

NotSpecifiedException C999 Not specified n/a

QueryParamException C400 The query The 'limit' parameter value

parameter not (100000) must be more than or
valid equals to 1 and less than or
equals to 10000.

CannotChangeFieldException C500 A field cannot be Cannot change field: 'color'

changed

DuplicateException C600 A duplicate Duplicate 'pc_colorway':

would violate a 'C1234'
uniqueness
constraint

ModuleNotInstalledException C700 The optional Module Not Installed

Centric module
is not installed in
the Server

InvalidActionException C800 Trying to pass Invalid Action

an invalid action
parameter to an
object revision
or batch
endpoints such
as
DocumentRevisi
on,
FinalInspectionB
atch etc.

AccessRoleRequireException C900 The Role is not Access Role Require

present

ERROR CODES AND MESSAGES 862

 Centric 8 REST API DEVELOPER GUIDE

13. URL ENCODED CHARACTER TABLE

Character UTF-8
backspace %08
space %20
tab %09
! %21
linefeed %0A
return %0D
" %22
# %23
$ %24
% %25
& %26
' %27
( %28
) %29
* %2A
+ %2B
, %2C
- %2D
. %2E
/ %2F
0 %30
1 %31
2 %32
3 %33
4 %34
5 %35
6 %36
7 %37
8 %38
9 %39
: %3A
; %3B
< %3C
= %3D
> %3E
? %3F
@ %40
[ %5B
\ %5C

URL ENCODED CHARACTER TABLE 863

 Centric 8 REST API DEVELOPER GUIDE

Character UTF-8
] %5D
^ %5E
_ %5F
` %60
{ %7B
| %7C
} %7D
~ %7E
%7F

URL ENCODED CHARACTER TABLE 864

 Centric 8 REST API DEVELOPER GUIDE

14. CENTRIC SERVER AND REST API LOGS

When C8 Centric Server is deployed under a real, or virtual machine (as opposed to a Docker
container) it logs activities, grouping them into different log files for easy accessibility. The
following is the list of all Centric Log files and the information they contain.

Log File Name Contains

pi_sessions.log
pi_profile.log
pi_performance.log
pi_nodeprocessor.log
pi_rollupservice.log
pi_reportdb.log
pi_rest.log
pi_jobservice.log
pi_centric.log
pi_security.log
server.log
Wildfly Logsboot.log
All sessions and client request authorization logs.
Slow DB requests and server processes.
Metrics that are reported in the Performance Monitor.
Requests that resulted from executed operation scripts.
Rollup-service activity, warnings and errors.
ReportDB activity, warnings and errors.
Rest API activity, warnings and errors.
Job service activity, warnings and errors.
Activity, warnings and errors not otherwise categorized.
Security exceptions.
WildFly (application server)(Up to 7.0 release) main log.
Log for the WildFly start up. Read it when WildFly service
failed to start.

When Centric Server is deployed in Docker container, it logs all activities to a single log file.

Log Analysis
Frequently, one needs to see a more comprehensive picture of logged events than can be
obtained by merely opening and inspecting a log file.

The two most usual situations are:

• Watching a running log in real time, while working with the logged process
• Forming a comprehensive picture or synopsis of events in several logs at one time.

We will use Perl 5 for both of these coammand. Check whether Perl 5 is installed by going to
the command line of your chosen terminal (DOS, CMD or Powershell), and invoking:

perl -v

HIt the Enter key. If perl is installed, you should see a response somewhat like this:

This is perl 5, version 24, subversion 0 (v5.24.0) built for MSWin32-x64-

multi-thread
(with 1 registered patch, see perl -V for more detail)

CENTRIC SERVER AND REST API LOGS 865

 Centric 8 REST API DEVELOPER GUIDE

Copyright 1987-2016, Larry Wall

Binary build 2400 [300558] provided by ActiveState

http://www.ActiveState.com
Built Jun 9 2016 21:44:59

Perl may be copied only under the terms of either the Artistic License or
the
GNU General Public License, which may be found in the Perl 5 source kit.

Complete documentation for Perl, including FAQ lists, should be found on

this system using "man perl" or "perldoc perl". If you have access to the
Internet, point your browser at http://www.perl.org/, the Perl Home Page.

If Windows doesn’t seem to know what you are talking about, then you probably need to
install Perl. ActiveState has a good Perl distribution package here.

Once Perl is installed, you can proceed with either of the scenarios below:

Watching a Running Log in Real Time

This is a good way to visually inspect the running output of one log file at a time.

Since our focus in this guide is on C8 REST API we will work with pi_rest.log. It would be possible
to involve other log files and even inspect several of these concurrently in tiled terminal
windows (DOS, CMD or Powershell). For example, if you are testing login on C8 REST API, but
you want to watch the pi_security.log simultaneously, you could open a window separate from
the one that displays pi_rest.log, and use a command that targets pi_security.log.

We will use Perl 5 for to emulate the tail -f command that one usually uses on Unix or Linux.

1. Log into the C8 server,

2. Start a DOS or Powershell terminal session
3. In the terminal session CD to the \Log directory beneath the C8 install directory.
4. Copy (just the bold part of) the Perl / DOS session given below:

c:\C8\Log> perl -e "$|++; open FILE, qq{<}.shift; @arq=<FILE>; $a=shift;

foreach(@arq[-10..-1]){print if /$a/} while(1){while(<FILE>){print if /$a/}}"
.\pi_rest.log "[ERROR]|[WARN ]|[INFO ]"

5. Paste the command into the terminal session window.

6. Hit the “Enter” key to run it.

CENTRIC SERVER AND REST API LOGS 866

 Centric 8 REST API DEVELOPER GUIDE

Notes:

• The preceding Perl expression works only on pi_rest.log, but you can easily change the
mention of “pi_rest.log” in the invocation above to any of the other log files described
in the table at the start of this section.
• It selects only the lines of interest: "[ERROR]", “[WARN ]”, and "[INFO ]" level log lines,
which should cover everything usually printed in the log file. If you wanted to add other
levels to your query, see this list of log levels. If you add any, be sure to space-pad to
five characters in the square brackets and delimit the additional log levels with the pipe
symbol “|”.
• You could limit to just “[ERROR]” and “[WARN ]” for example, by leaving out the
“|[INFO ]”. Note that you would remove the text, including the square brackets, and
the pipe symbol “|”, which is essentially a delimiter that means “or”. But the command,
as printed above, will show you everything that happens, and that is usually what you
will want.
• This command outputs in chunks of 10 lines at a time. If you have less than 10 lines in
your log file when you start the command, you will get a harmless error:

Modification of non-creatable array value attempted, subscript -10 at -

e line 1.

• To resolve this, you could open the log file in an editor, add 10 or more blank lines,
then save and close. You could also just wait until the log output has surpassed 10 lines
before starting the command.

Below is an example of output of this command.

Note that in the output below, you can see the id values of the objects created (such as “C647”
or “C656”) in close apposition to the endpoints used to create them
(“/collections/C633/hierarchy” and “/collections/C640/hierarchy”).

[2020-10-16 17:46:45,559] [INFO ] [REST (137)] -- Child Node C640 of C628 for
relationship Hierarchy was created.

[2020-10-16 17:46:45,700] [INFO ] [REST (138)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0001'
using GET method

[2020-10-16 17:46:45,887] [INFO ] [REST (139)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0002'
using GET method

CENTRIC SERVER AND REST API LOGS 867

 Centric 8 REST API DEVELOPER GUIDE

[2020-10-16 17:46:46,121] [INFO ] [REST (140)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0003'
using GET method

[2020-10-16 17:46:46,293] [INFO ] [REST (141)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-
requesthandler/api/v2/collections/C633/hierarchy' using POST method

[2020-10-16 17:46:46,418] [INFO ] [REST (141)] -- The Style with URL C647 is
either a Template or has no ProductSourcing or ProductSources. Hence, no need
to create any BOMSupplierAttributes

[2020-10-16 17:46:46,465] [INFO ] [REST (141)] -- REST Validation of C647 was

successful.

[2020-10-16 17:46:46,512] [INFO ] [REST (141)] -- Flushing changes

[2020-10-16 17:46:46,528] [INFO ] [REST (141)] -- Saving 1 Nodes as user.

[2020-10-16 17:46:46,637] [INFO ] [REST (141)] -- Saving 9 Nodes as system.

[2020-10-16 17:46:46,809] [INFO ] [REST (141)] -- Changes flushed.

[2020-10-16 17:46:46,825] [INFO ] [REST (141)] -- Followup processing.

[2020-10-16 17:46:46,856] [INFO ] [REST (141)] -- Child Node C647 of C633 for
relationship Hierarchy was created.

[2020-10-16 17:46:47,012] [INFO ] [REST (142)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0001'
using GET method

[2020-10-16 17:46:47,231] [INFO ] [REST (143)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0002'
using GET method

[2020-10-16 17:46:47,465] [INFO ] [REST (144)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-requesthandler/api/v2/collections?code=0003'
using GET method

[2020-10-16 17:46:47,637] [INFO ] [REST (145)] -- REST API call to 'http://mg-

wf8-sql12.csi.local:8080/csi-
requesthandler/api/v2/collections/C640/hierarchy' using POST method

[2020-10-16 17:46:47,731] [INFO ] [REST (145)] -- The Style with URL C656 is
either a Template or has no ProductSourcing or ProductSources. Hence, no need
to create any BOMSupplierAttributes

[2020-10-16 17:46:47,778] [INFO ] [REST (145)] -- REST Validation of C656 was

successful.

CENTRIC SERVER AND REST API LOGS 868

 Centric 8 REST API DEVELOPER GUIDE

[2020-10-16 17:46:47,809] [INFO ] [REST (145)] -- Flushing changes

[2020-10-16 17:46:47,840] [INFO ] [REST (145)] -- Saving 1 Nodes as user.

[2020-10-16 17:46:47,949] [INFO ] [REST (145)] -- Saving 9 Nodes as system.

[2020-10-16 17:46:48,106] [INFO ] [REST (145)] -- Changes flushed.

[2020-10-16 17:46:48,121] [INFO ] [REST (145)] -- Followup processing.

[2020-10-16 17:46:48,168] [INFO ] [REST (145)] -- Child Node C656 of C640 for
relationship Hierarchy was created.

Time-Serial Log Analysis Across All Logs

This is the technique to use for performance issues, or other issues of a general nature, where
one would like to look in several logs at one time.

It can be made to work on Mac (Unix), Linux, or Windows, so it can be done on a test VM
(typically running MS Windows), or on one’s daily work machine.

1. Marshall the logs into a directory. This can be simply the “Log” directory under the C8
installation, or, If you have downloaded the logs from C8 or from Jira, unzip the
resulting zip file, and keep the logfiles all together in a directory in one’s local
filesystem.
2. Open a terminal session and traverse to the log file directory in one’s filesystem.
3. One may run a Perl one-liner to get just the [ERROR]s and [WARN ]ings from ALL the
logs at once, showing the filename, the line number in that filename, and log line. The
perl one-liner as it would be used on Unix/Mac/Linux is:

Unix / Mac / Linux

perl -ne 'my $counter = 0; if (m/\[ERROR\]|\[WARN/){$counter++; my $datetime =

/\[(\d{4}-\d\d\-\d\d \d\d:\d\d:\d\d,\d{3})\]/; print $counter . "\t" . $1 . "\t"
. $ARGV . "\t" . $. . "\t" . $_};' *.log* > outfile.txt

The expression immediately above will not work on M.S. Windows. Here is a DOS /
PowerShell compatible version:

Windows / DOS / Powershell

perl -ne "BEGIN { @ARGV = map +glob, @ARGV; my $counter = 0;} if

(m/\[ERROR\]|\[WARN/){$counter++, my $datetime = /\[(\d{4}-\d\d\-\d\d
\d\d:\d\d:\d\d,\d{3})\]/; print $counter . qq{\t} . $1 . qq{\t} . $ARGV .
qq{\t} . $. . qq{\t} . $_}; close ARGV if eof" pi*.log* > outfile.txt

CENTRIC SERVER AND REST API LOGS 869

 Centric 8 REST API DEVELOPER GUIDE

This latter version satisfies DOS’s insistence on double-quotes to wrap and protect the
Perl script, and handles DOS and PowerShell’s recent refusal to expand asterisk wildcards
into full file name (when they appear in a Perl command line). Because of the “hoisting”
of the double quote, I also use the Perl-specific qq{} construct to wrap what had
previously been double-quoted within the program.

The one-line-perl script as given above, in both instances will output to a file called
“outfile.txt”. Excel does not seem to recognize a “.tsv” (tab separated values) file ending
any more, so we use “.txt”.

One must have the lines sorted by date/time. This is to make time-proximate log entries
from different logs appear together and hopefully tell a story.

The lines will still be unsorted for time, but one can now pull them into M.S. Excel.

4. Start up Excel and import the tab separated values file. You should not need to change
anything about the formatting.
5. Sort on the second column, which contains the sort-compliant representation of the
date time. Now the lines will be in the order that they occurred in time. They will jump
around across different log files, but should tell some cogent story of what is happening
across any interval.
6. Save As the file, being sure to save it as an XSLM, which can contain a macro.
7. Now, one will want to draw the viewer’s eye to data of significance by highlighting
the lines that should stand out.

For example (and what may suffice in the case of REST API), one may want to highlight
anything that comes from the pi_rest.log or any of its re-numbered predecessors. One may
also want the rows from pi_profile.log or any of its re-numbered predecessors, as long as
the log line mentions the string “REST”.

One can do this in one or both of two ways:

a. Fleetingly, for quick reference in a text editor,

or

b. Persistently, usually for sharing with a team, in M.S. Excel.

c. To highlight ephemerally, but quickly.

CENTRIC SERVER AND REST API LOGS 870

 Centric 8 REST API DEVELOPER GUIDE

i. One can save the re-sorted file and then pull the file into any decent
text editor (e.g. Vim, or GVim). If one uses (G)Vim, one can use a
regular expression to highlight the text that one wants to stand out.
ii. A search pattern that would result in this highlighting in (G)Vim is (type
“/“ first):

\[REST [^\]]*]\|pi_rest.log\(\.\d\)\?

iii. Hit enter after typing this after the “/“

Expected Result:

The desired strings should be highlighted in some contrasting color,

indicating lines of interest.

While this is good for getting a sense of how many lines of interest
there are, and patterns among them, the highlighting is ephemeral: it
will go away as soon as one closes the file, searches on another
string, or clears it with “:noh”. So, the highlighting not conveniently
available to anyone with whom one may share the file.

d. To highlight lines persistently in a format that is widely usable, one may use M.S.
Excel.

To do this, one would use the Visual Basic editor that comes with every M.S. Office
application.

i. On a Macintosh in Excel, go to the Excel system menu (in the top

(Apple) system menubar). and choose “Preferences”.
ii. From the resulting “Excel Preferences” dialog, under the “Authoring”
section, choose “View”.
iii. From the resulting “View” dialog, in the section titled “In Ribbon,
Show”, ensure that the checkbox titled “Developer” is checked.
iv. Close the dialog box by clicking the System red button in the upper left
hand corner.

Expected Result:

The “Developer” tab should now show in the Excel window menubar.

v. Click the “Developer” tab. Expected Result: There should be a new

“ribbon” containing commands such as “Visual Basic” and “Macros”.

CENTRIC SERVER AND REST API LOGS 871

 Centric 8 REST API DEVELOPER GUIDE

vi. Click the “Visual Basic” button. Expected Result: A “Microsoft Visual
Basic” window should be fronted. One’s result may vary a bit, as the
first time I did this on the Mac, I could not get the window to come to
the front of any visible viewport. I saved the Excel “book” where I had
ordered the data on the time column, then saved the macro earlier.
Then I killed Excel completely, then reopened it. I had to re-execute
the steps i - vi.
vii. Once the “Microsoft Visual Basic” editor is displayed, find the
modules. There should a folder in the left-nav panel, called Modules,
and in it, any macros one may have recorded should be listed as
Module1, Module2, etc.
viii. Right click the Modules folder, choose “Insert”, thence choose
“Module”.

Expected Result:

A code window should appear in the large main area of the

“Microsoft Visual Basic…” application window.

ix. At this point, here is what I wrote in the code window. It worked for
me:

Sub Highlight1()
Dim x As Integer
Dim testPos As Integer
Dim testPos2 As Integer
Application.ScreenUpdating = False
' Set numrows = number of rows of data.
NumRows = Range("A1",
Range("A1").End(xlDown)).Rows.Count
' Select the top cell of the column into which we put
the log file name. .
Range("C1").Select
' Establish "For" loop to loop "numrows" number of
times.
For x = 1 To NumRows
' Here to "next" is our code to highlight.
testPos = InStr(1, Selection.Value, "pi_rest", 1)
If Not testPos = 0 Then
With Selection.Interior
.Pattern = xlSolid
.PatternColorIndex = xlAutomatic
.Color = 65535
.TintAndShade = 0
.PatternTintAndShade = 0
End With
End If
ActiveCell.Offset(0, 2).Select
testPos2 = InStr(1, Selection.Value, "[REST", 1)
If Not testPos2 = 0 Then
With Selection.Interior
.Pattern = xlSolid

CENTRIC SERVER AND REST API LOGS 872

 Centric 8 REST API DEVELOPER GUIDE

.PatternColorIndex = xlAutomatic
.Color = 65535
.TintAndShade = 0
.PatternTintAndShade = 0
End With
End If
' Selects cell down 1 row from active cell.
ActiveCell.Offset(1, 0).Select
Next
Application.ScreenUpdating = True
End Sub

x. Save (click the floppy disk image) and run the function (click the blue
triangle). Give the Visual Basic function time to run. Eventually .…

Expected Result:

Cells containing the text elements “pi_rest” and “[REST” should

become highlighted in yellow. You can focus on them more easily to
look for any unifying characteristic, such as extra-long duration or
other Warning conditions.

CENTRIC SERVER AND REST API LOGS 873

 Centric Software, Inc.
Centric Software, Inc.
655 Campbell Technology Parkway,
Suite 200, Campbell
CA 95008
Phone: 1.408.574.7802

Technical Support
866. 796-6218 8:00 AM-8:00 PM EST
Email: support@centricsoftware.com

Dev Guide Documentation Feedback

Email: documentation@centricsoftware.com