Print and Reproduction Metadata

GET {{base_url}}/metadata/PREntry

Use this endpoint to retrieve the Print and Reproduction metadata.

The metadata describes the fields in each table of the database for the record and describes whether or not the table is a custom table and whether or not it has a grid ID. Each field describes whether or not the field is required, the data type, the default value, whether or not it is updateable, and other useful minimums, limits, and maximum details.

For more information, see Metadata Reference.

HEADERS

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

{"prControl":{"Keys":"Batch","TableName":"prControl","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Recurring","FieldType":"Checkbox","Caption":"Recurring","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"EndDate","FieldType":"Date","Caption":"End Date","DefaultValue":"2007-12-31T00:00:00.000","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"DefaultCurrencyCode","FieldType":"Dropdown","Caption":"Currency","DefaultValue":"[FUNCTIONALCURRENCYCODE]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3,"CodeTable":"FW_CFGCurrency","LimitToList":true},{"FieldName":"Total","FieldType":"Numeric","Caption":"Amount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"SumTotal","FieldType":"Numeric","Caption":"File Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffTotal","FieldType":"Numeric","Caption":"Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Selected","FieldType":"String","Caption":"Selected","DefaultValue":"Y","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Creator","FieldType":"String","Caption":"Creator","DefaultValue":"ADMIN","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Period","FieldType":"Numeric","Caption":"Period","DefaultValue":"200712","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Company","FieldType":"Company","Caption":"Company","DefaultValue":"[CURRENTCOMPANY]","Hidden":false,"Required":true,"Updateable":true,"MaxLength":14}],"Caption":"prControl"},"prMasterKey":{"Keys":"Batch,RefNo","TableName":"prMasterKey","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"RefNo","FieldType":"Uppercase","Caption":"RefNo","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":7},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"TransDate","FieldType":"String","Caption":"TransDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StatusDesc","FieldType":"String","Caption":"StatusDesc","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true}],"Caption":"prMasterKey"},"prMaster":{"Keys":"Batch,RefNo","TableName":"prMaster","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"RefNo","FieldType":"Uppercase","Caption":"Reference Number","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":7},{"FieldName":"TransDate","FieldType":"Date","Caption":"Transaction Date","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":40},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"CurrencyCode","FieldType":"Dropdown","Caption":"Currency","DefaultValue":"[FUNCTIONALCURRENCYCODE]","Hidden":false,"Required":true,"Updateable":true,"MaxLength":3,"CodeTable":"FW_CFGCurrency","LimitToList":true},{"FieldName":"CurrencyExchangeOverrideMethod","FieldType":"String","Caption":"CurrencyExchangeOverrideMethod","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CurrencyExchangeOverrideDate","FieldType":"Date","Caption":"CurrencyExchangeOverrideDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CurrencyExchangeOverrideRate","FieldType":"Numeric","Caption":"CurrencyExchangeOverrideRate","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":10},{"FieldName":"Status","FieldType":"String","Caption":"Status","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StatusDescription","FieldType":"String","Caption":"Status","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedByName","FieldType":"String","Caption":"Approved By","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedBy","FieldType":"String","Caption":"AuthorizedBy","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"RejectReason","FieldType":"String","Caption":"Reject Reason","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":500},{"FieldName":"ModUser","FieldType":"String","Caption":"ModUser","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"ModUserEmployee","FieldType":"String","Caption":"ModUserEmployee","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"ModDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Diary","FieldType":"Dropdown","Caption":"Diary","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CodeTable":"CFGDiaryAutoNum LEFT JOIN CFGDiary ON CFGDiaryAutoNum.Code = CFGDiary.Code LEFT JOIN CFGDatesStatus ON CFGDiaryAutoNum.Period = CFGDatesStatus.Period and CFGDiaryAutoNum.Company = CFGDatesStatus.Company LEFT JOIN (SELECT '0/'+CONVERT(varchar,Years) AS Pd, Years * 100 AS Period FROM (SELECT Distinct Period/100 AS Years FROM CFGDatesStatus WHERE Closed = 'N' and CFGDatesStatus.Company = /*N*/'PR') x) _OpenYear ON CFGDiaryAutoNum.Period = _OpenYear.Period","LimitToList":true},{"FieldName":"DiaryNo","FieldType":"Numeric","Caption":"Diary Number","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false}],"Caption":"prMaster"},"prDetail":{"Keys":"Batch,RefNo,PKey","TableName":"prDetail","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"RefNo","FieldType":"Uppercase","Caption":"RefNo","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":7},{"FieldName":"PKey","FieldType":"String","Caption":"PKey","DefaultValue":"[GUID]","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Originals","FieldType":"Numeric","Caption":"\u003cbr /\u003eOriginals","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Copies","FieldType":"Numeric","Caption":"\u003cbr /\u003eCopies","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"\u003cbr/\u003eDescription","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":40},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"\u003cbr /\u003eProject","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":10},{"FieldName":"WBS1Name","FieldType":"String","Caption":"\u003cbr /\u003eProject Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ClientName","FieldType":"String","Caption":"\u003cbr /\u003eClient Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2Level","FieldType":"String","Caption":"WBS2Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ChargeType","FieldType":"String","Caption":"ChargeType","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"\u003cbr /\u003ePhase","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS2Name","FieldType":"String","Caption":"\u003cbr /\u003ePhase Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3Level","FieldType":"String","Caption":"WBS3Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"\u003cbr /\u003eTask","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS3Name","FieldType":"String","Caption":"\u003cbr /\u003eTask Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"FunctionalCurrencyCode","FieldType":"String","Caption":"FunctionalCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Org","FieldType":"String","Caption":"Org","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Account","FieldType":"Account","Caption":"\u003cbr /\u003eAccount","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":6},{"FieldName":"AccountName","FieldType":"String","Caption":"\u003cbr /\u003eAccount Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AccountCurrencyCode","FieldType":"String","Caption":"AccountCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"GlobalAccount","FieldType":"String","Caption":"GlobalAccount","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AccountType","FieldType":"Numeric","Caption":"AccountType","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Amount","FieldType":"Currency","Caption":"\u003cbr /\u003eAmount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CurrencyExchangeOverrideRate","FieldType":"Numeric","Caption":"Exchange\u003cbr /\u003eOverride Rate","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":10}],"Caption":"prDetail"}}