GET api/v2/works/{workId}
Request
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workId | integer |
Required |
Response
WorkDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| FinishDateTime | date | ||
| PriceList | PriceListBasic | ||
| EditionUser | UserBasic | ||
| EditionDateTime | date | ||
| Id | integer | ||
| ControlNumber | string | ||
| Number | integer | ||
| Year | integer | ||
| Identification | string | ||
| Active | boolean | ||
| ReferenceKey | string | ||
| Confidential | boolean | ||
| Finished | boolean | ||
| WorkType | WorkTypeBasic | ||
| Account | AccountBasic | ||
| RelatedAccount | AccountBasic | ||
| OwnerUser | UserBasic | ||
| CurrentWorkFlow | WorkFlowBasic | ||
| Priority | PriorityBasic | ||
| ServiceCenter | ServiceCenterBasic | ||
| WorkConclusion | WorkConclusionBasic | ||
| WorkClass | WorkClassBasic | ||
| WorkSubClass | WorkSubclassBasic |
Response Format
application/json, text/json
Sample:
{
"FinishDateTime": "2026-02-02T21:08:41.0105235Z",
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"EditionUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"EditionDateTime": "2026-02-02T21:08:41.0105235Z",
"Id": 1,
"ControlNumber": "sample string 2",
"Number": 3,
"Year": 4,
"Identification": "sample string 5",
"Active": true,
"ReferenceKey": "sample string 7",
"Confidential": true,
"Finished": true,
"WorkType": {
"Id": 1,
"MasterId": 2,
"Identification": "sample string 3",
"Active": true,
"Confidential": true,
"LastVersion": true,
"BlockLimitAmount": true,
"Version": 8,
"Prefix": "sample string 9",
"SectionConfigs": [
{
"SectionId": 1,
"Order": 2,
"Visible": true
},
{
"SectionId": 1,
"Order": 2,
"Visible": true
}
]
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"RelatedAccount": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"OwnerUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"CurrentWorkFlow": {
"Id": 1,
"WorkFlowStepFrom": {
"Id": 1,
"Identification": "sample string 2",
"Active": true
},
"WorkFlowStepTo": {
"Id": 1,
"Identification": "sample string 2",
"Active": true
},
"ResponsibleUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"ResponsibleServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Conclusion": "2026-02-02T21:08:41.0105235Z",
"Execution": "2026-02-02T21:08:41.0105235Z",
"EstimatedWork": 1.1,
"AllowSamples": true,
"SampleStatus": {
"Id": 1,
"Identification": "sample string 2",
"BeforeReceive": true,
"AfterPublish": true,
"PortalSampleStatus": true
},
"Returned": true,
"CreateDateTime": "2026-02-02T21:08:41.0105235Z",
"ExecuteDateTime": "2026-02-02T21:08:41.0105235Z"
},
"Priority": {
"Active": true,
"Id": 2,
"Identification": "sample string 3"
},
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:08:41.0105235Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"WorkConclusion": {
"Id": 1,
"Identification": "sample string 2",
"Active": true
},
"WorkClass": {
"Id": 1,
"Identification": "sample string 2",
"Active": true
},
"WorkSubClass": {
"Id": 1,
"Identification": "sample string 2",
"Active": true
}
}
text/html
Sample:
{"FinishDateTime":"2026-02-02T21:08:41.0105235Z","PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"EditionUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"EditionDateTime":"2026-02-02T21:08:41.0105235Z","Id":1,"ControlNumber":"sample string 2","Number":3,"Year":4,"Identification":"sample string 5","Active":true,"ReferenceKey":"sample string 7","Confidential":true,"Finished":true,"WorkType":{"Id":1,"MasterId":2,"Identification":"sample string 3","Active":true,"Confidential":true,"LastVersion":true,"BlockLimitAmount":true,"Version":8,"Prefix":"sample string 9","SectionConfigs":[{"SectionId":1,"Order":2,"Visible":true},{"SectionId":1,"Order":2,"Visible":true}]},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"RelatedAccount":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"OwnerUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"CurrentWorkFlow":{"Id":1,"WorkFlowStepFrom":{"Id":1,"Identification":"sample string 2","Active":true},"WorkFlowStepTo":{"Id":1,"Identification":"sample string 2","Active":true},"ResponsibleUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"ResponsibleServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Conclusion":"2026-02-02T21:08:41.0105235Z","Execution":"2026-02-02T21:08:41.0105235Z","EstimatedWork":1.1,"AllowSamples":true,"SampleStatus":{"Id":1,"Identification":"sample string 2","BeforeReceive":true,"AfterPublish":true,"PortalSampleStatus":true},"Returned":true,"CreateDateTime":"2026-02-02T21:08:41.0105235Z","ExecuteDateTime":"2026-02-02T21:08:41.0105235Z"},"Priority":{"Active":true,"Id":2,"Identification":"sample string 3"},"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:08:41.0105235Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"WorkConclusion":{"Id":1,"Identification":"sample string 2","Active":true},"WorkClass":{"Id":1,"Identification":"sample string 2","Active":true},"WorkSubClass":{"Id":1,"Identification":"sample string 2","Active":true}}