--- title: "Contract Item" slug: "contract-item" updated: 2026-01-28T11:00:55Z published: 2026-03-04T11:07:39Z canonical: "docs.safran.com/contract-item" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.safran.com/llms.txt > Use this file to discover all available pages before exploring further. # Contract Item ## Contractitem ### /v1/contractitem Retrieve the contract item detail. ### Example for calling: http://server/v1/contractitem?id=1&networkid=2 - Retrieves contract item having id = 1 for network with id 2. http://server/v1/contractitem?id=1&projectid=3 - Retrieves contract item having id = 1 for project with id 3. http://server/v1/contractitem?code=MyCode&networkid=2 - Retrieves contract item having code = MyCode for network with id 2. http://server/v1/contractitem?code=MyCode&projectid=3 - Retrieves contract item having code = MyCode for project with id 3. http://server/v1/contractitem?id=1&projectid=3&owner=SAFRANSA - Retrieves contract item having id = 1 for project with id 3, owned by SAFRANSA. ### Allowed Methods: [GET] API Controller: **ContractItem** ### Description: Retrieved the contract item details for a specified set. ### Request Fields: | Name | Type | Description | Notes | | --- | --- | --- | --- | | id | integer | Id of the contract item | [Mandatory or code] | | owner | string | Owner of the project linked to the contract item | Relates to "[SafranWebApiOwnerVerificationDuringApiCalls](/v1/docs/safran-project-integration-api-application-settings)" in Application Settings | | code | string | Code of the Contract Item | [Mandatory or Id] | | networkid | integer | network id of the related project | [Mandatory or ProjectId] | | projectid | integer | The Project connected to the Contract Item | [Mandatory or NetworkId] | - Either the id or the code needs to be provided - Either the networkid or the project id needs to be provided ### Response Fields #### contractitem | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | projectid | integer | The project which the Contract iItem is connected to | | | wbs | wbs | The Workbreakdown structure for the Contract Item | see [wbs](/v1/docs/contract-item#wbs) | | code | string | The Contract Item code | | | alias | string | The Alternative ID | | | type | type | The [Type](/v1/docs/contract-item#type) of the Contract Item | see [type](/v1/docs/contract-item#type) | | id | integer | The Contract Item ID | | | registered | datetime | The Contract Item Registered date | | | baselined | datetime | The Baseline Run date | | | companyrepresentative | person | The [Person](/v1/docs/contract-item#person) acting as the company representative | see [person](/v1/docs/contract-item#person) | | customerrepresentative | person | The [Person](/v1/docs/contract-item#person) acting as the customer representative | see [person](/v1/docs/contract-item#person) | | userfieldX | userfield | Series of user fields used in the Contract Item | see [userfield](/v1/docs/contract-item#userfield) | | description | string | The description of the Contract Item | | | document | document[] | List of [Documents](/v1/docs/contract-item#document) for the Contract Item | see [documents](/v1/docs/contract-item#document) | | comment | string[] | List of comments for the Contract Item | | - userfieldX, where X is from including value 1 to including value 16. #### wbs Work breakdown Structure | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | id | integer | The ID of the WBS | | | code | string | The code of the WBS | | | description | string | The description of the WBS | | #### type Type of the Contract Item | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | type | string | The type code | | | description | string | The type description | | #### person Representative Person | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | signature | string | The signature of the person | | | name | string | The name of the person | | #### userfield User defined fields | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | fieldnr | int | Contract item field number | | | label | string | Label for the contract item userfield | | | connectedfieldnr | int | Contract item field number connected to the Userfield Number | | | autoupdate | bool | Auto Update of Activities | | | value | string | The value set by the user | | #### document Documents of the Contract Item | **Name** | **Type** | **Description** | **Notes** | | --- | --- | --- | --- | | description | string | Description of the document | | **Sample JSON Response** json result ``` [ { "projectid": 100028, "wbs": { "id": 100000, "code": "API Test 100", "description": "API Testing Code 100" }, "code": "Contract Item 100", "alias": "CI100", "type": { "type": "100001", "description": "Type 001" }, "id": 100000, "registered": "2026-01-20T19:53:25", "companyrepresentative": { "signature": "2", "name": "Our 002" }, "customerrepresentative": { "signature": "1", "name": "Sign 001" }, "userfield1": { "fieldnr": 1, "label": "Referanse 001", "connectedfieldnr": 1, "autoupdate": true, "value": "Master 1.1" }, "userfield2": { "fieldnr": 2, "label": "Ref 2", "connectedfieldnr": 2, "autoupdate": false, "value": "Master 2.1" }, "userfield3": { "fieldnr": 3, "label": "Reference 3 -> 1", "connectedfieldnr": 1, "autoupdate": false, "value": "Master 1.2" }, "description": "API Test 1, Testing Contract Items for the API", "document": [ { "description": "API Test Document 001" } ], "comment": [ "API Test Comment 001" ] } ] ```