diff --git a/docs/api-reference/get-a-team.api.mdx b/docs/api-reference/get-a-team.api.mdx index 9283aa3a2..70399bd1c 100644 --- a/docs/api-reference/get-a-team.api.mdx +++ b/docs/api-reference/get-a-team.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch a specific team in your Port organi sidebar_label: "Get a team" hide_title: true hide_table_of_contents: true -api: eJzVVUtvIzcM/isCT7uA1pP0OCgK5FAsFgWKYJueAh9kiZPRRjOapSinrjH/vaA0fiT2FrunopexLYo0+T04e3CYLPmJfRyhhYfeJ0UxMyoTQnxJahez4qg6ZNsro9KE1nfeKkYzKD9KnNR9JFaRnszo/zZSavXzhppfyuMhqoCGRjVEQmU2MXNJTlrZHu2zKgc9qkcXbR5w5FJh/a5nnlLbNC7atJoi8crHJqX4gTbGNvL4ELdIW48vzfsVaGDzlKB9hAepDmsNkyEzICPJ8R6S7XEw0O6BdxNCC4bI7ECDZxySnOOYB6ngHWgYzYCgwRIaRnfHoCFP7vh9orj1Dgn0Kww15ISUVp2nxL/XEvUkmDcHOBgfjr8mbznTKZrYcE6wnmcNXrj5mpF2h75a6DwGl978uzCIqoYKdS9m5BN/XaQCteC/Up86lRM6reIYduV8YRfdocSLD0FtUPnRhuzQCeNykTBNcUxYeQYNhF+zJ3TQdiYknPUVuBOTH5/gMM9kuD+Ns6B9OYwEVOyOfV+OdaUJpozzWkNCm8nzrvC/QUNIwi+hcS1Xmci1wzhFBD/d3MjH604+I5PHLTqVsrWYUpdD2InqbBwZR5YUM03B2yLf5kuSvHMUvrfgglbcfEG7CG1CYl+7i8/nAh5FEItqZeb1rEHmOrvzjTreXWWmsnElcLLBRVRDF2kwDC2IPT6wH1BSTm757pSjqa618ArAi/gsRjkp4LHioAWwtQbjnJdEE+7PYKharakDch8dtPCEBS1RZwvN9rYpQmn2As0MoinaHlZKpgAtHDaVmfxhUYE44DKa0+nCmTz/EJFUXg4iPXE8+d/wzPd3mftIy56FxUs9GkGt7ooulnTPQe6X3Xx3/wk0SNtVfbermwJ3TDyYguZS/SOyMmqB7g3gR6X/z18TFVfGv7iZgvFj0apQtV9Yf4TtLVQjyYJtCzZrDX1MLNH9fmMS/klhnuW4LmaRg/PJbMJxC/4rgv/Jmr46+zPuzt8nWxOyXCoK3RryMtIPjvfu82LE9+oHd/jVDl+tu2N/h84LPbOsvsUG0msN3VmLE58lXaxoGfJo/Y+/PoAGk0UE5wZ8LgZcvkj1qw29dWZtQZ6yDK6m7PfV3vN8vF9D38xYRjzcFnzW8zz/A/tvXOk= +api: eJzVVk1v1DAQ/SuWTyBtNy3HCCH1gBBCQhWUU9WD15k0pt7Y9UfKEuW/M2Mn2bQbUDkhLtvsfGXmvTez7XkFXjplgzItL/l1ozxzJgZgQmvz6NnBRBYMqyHIhgnmLUhVK8kCiD1TLfkduzIuMOPuRKt+Ciq1fbtzxbv0cW2YBuFatjcOq+6weEr2GyYbkPcsGRpgN5WRcQ9tSBVuXzUhWF8WBZr91uIbtsoU3psztxOyoI8z04HrFDwWr7d8w4O487y84ddUnd9uuBVO7CGAI3PPPb5vL3jZ83CwgNMK58QBE1UATEA7tHFPFVSF1hZz8Y90IAJUlwGfo63mZ+tMpypw+LjEEIM8vnBbK+fD51wiW7R4ZsBmlJ6/WSVDdEevRxwijjEM2CBx8xDBHaa+Sl4r0JXH7/DDalOhKbgImxNCgeXIxOSjaMORztq4hDzRsWUfa4ZvrjbMtPqQ7CPZUE0lHpXWbAfIu9SxQjsKgAIdeGtaD5l27MnBQ1QOKl7WQnsYNivo++BUe8en8awIzXG6EfzTYcjBTD33fTrWShOEzICC8CCjU+GQ5LBDVSJ9SDcyXJUhq4bCpnGSJt6cn9Ofp518AWweOkTARynB+zpqfSARStMG1DClCGu1kknNxXdPeUsUXlpwRMvsvoMcdWfBBZW7M/dLPbekj1HENPMtgktzLWJ+UwcVv8ZMZmPFcdyKE++Go672Aj2ctuUsKKwxLJfnxSnzjq218ATAE/9Ae3NUwE3GYUOAIcOiqhQlCn21gCFrNafi3WgMJvI7SGiROktedBdFEkrREzQDJ025brow0WkMmg6XsGq6W5w24NQb/TFgIc+vJJLMyyTSI8dWfYLFGbiM2Kcbzy4fd6lBQWNWPh21SekqaIpPp/ry6iOGUttZfRfb8wS38WEvEppj9Q8Q8OiP0D0DfFb6f/6rkXEN8CMUVgvEj7RKVPUj6ze8u+B5kejelgkbpKtBuMjb9zvh4ZvTw0DmfKdJDpXyYqfnK/hHBP/JmV6d/R7ltfh56YSOFJQU2gmnaKS/HO/Vl3ERX7O/vOGrHT45d3N/U+eJnoFO37gG1Gt2XeJptWGRdHKiach59T+8v8ZYEUkEywW8Tws4PlD11Yaeb2ZugT7pGKym9H1e72GY47PrtxnjiFM04YP/MQy/AFu0YkQ= sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch a specific team in your Port organization.
","required":false},{"schema":{"type":"string"},"in":"path","name":"name","description":"The name of the team you want to fetch.
","required":true}]} + parameters={[{"schema":{"type":"array","items":{"enum":["id","name","createdAt","updatedAt","provider","description","users.firstName","users.lastName","users.email","users.picture","users.status"]}},"in":"query","name":"fields","explode":true,"description":"The fields you want to fetch for the team. If used, only the specified fields will be included in the response.
","required":false},{"schema":{"type":"string"},"in":"path","name":"name","description":"The name of the team you want to fetch.
","required":true}]} >
diff --git a/docs/api-reference/get-actions-automations.api.mdx b/docs/api-reference/get-actions-automations.api.mdx index b7274a761..5df1b01a8 100644 --- a/docs/api-reference/get-actions-automations.api.mdx +++ b/docs/api-reference/get-actions-automations.api.mdx @@ -5,9 +5,9 @@ description: "This route allows you to fetch one or more self-service actions an sidebar_label: "Get actions/automations" hide_title: true hide_table_of_contents: true -api: eJztVm1v4zYM/iuC9mVXOHVbbF+MIECwBl2xrS1yOWBFG6SyzcRCFclH0cnlgvz3QZaduHnD7tpiG7AvqUtRFB/y4cuSp2ATlDlJo3nEB5m0DE1BwIRSZm7ZwhSMDBsDJRkzGphBNjUIzIIatyzgTCbAROIMWCZ0GhpkoiAzFV4ktbOB7M4gMZEkptB02o4x7JQ/gwxYIpRic6kUywHHBqdMMGUmMhGKPXVvLp9YDDQH0M4p9rkAXLBcoJgCAVoWgzLzwL3NEKhAr9Zw6YU/lAliU+HgkHsbJQFK0XTJMAUCtccpYlPQIWsBSzJInplTcdYeUpMUU9BUHg9/zIhyG4VhahJ7mhukU2nCylZL6LTVsBV+8D7wgJOYWB498K7X5MOAb/Dy6GHJbZLBVPBoyWmRA4+4QBQLHnBJMLUNuSWUesJXq4BLl+EyejzgWkzLa+ULI5mCJjmWgDzYoQSwzXFomRmXUP3NcE/OQ8+audC0ps4aGsLnQiKkPBoLZWEVvB2WWBWQo9T0PXDWl0PL5pmxa06HTfKUuKTN3gVXwEEXU5f3X/q97qDHA37Z+73nP7r3rQs+PATd5ICli3vxPqyPmXsxtAeImSAIglazslvwJQeUoBOwoQUq8lYhW2ODrSr/P8TCyqSVAgmp7IcdduwygfVBwcyJjFYLNja4t5d8U2RjYxQIzQ+EJy9iJW0G6U54bp0LWDvkfDk5aST85OSUXY/ZE2EBT4F3eG3sRVsp21cMHiOk3+T9Tv6b8eAB37zDhwcQEsrJBHBUWnxjNvZuBteD+5En5SUPasGnu8uXAs9WJxhc/9Hrj+76t3e9/uB+1Pvz7rpfHnRv7ke1vV+7N1e9w5yuIcEMNO3ldXkSVi29UofU8+94N9rDwUYyX5e82TkP+OziYKpmgNZX6rb5YcAtJAVKWpRNPgaBgM4mgkgjUU8Dp4hgc6MtlJm7ODtzf15G6GORJGCtq4mfLi52z2/dMPfVOjZu2Es9YYBo0DKTJAUipNGjftRtErGCjvvAzqNmrE1Zp+cU2yFla8nlxnolb4flhc21tNOOO1LPhJLpyKEHS+0w7rRDStcqLrOpIMFyNDOZQspSA5Zp0xzbfkfxyahu16+FtbsO+c/7IvPPISdALdQIvIkt4F3Nag3vzdqZwwhXAZ8CZSblEZ+AK5NcUMYjHs7O60WDO1rhrF4dClQ84vUAELms+z93/N49LexGocHQjy72nn41TzetJZe/QYPy3YIyg/JrPaLKsshApIDVNB+b8rok5fTLXbF7d+0KqaqWiJ+fnrmM5sbSVGinXlm/Ato3rLdbxpInRpPrJf/vuf+WPdfTheALhbkSsizZkoHLisdVOxWbRTgzlpx8uYyFhU+oVisn9k3W8TuV1pVH3VWPsuBNV9u9aJ5hcWDNnglVOP2y7F7v9GsX2CPeH1isXwHgv72RHglVcxH/zvi8+0p6xP3monzcfa+/tXa+ghHvvssdQb29af4d5JstbqM9dP+gdOo8ehg2Z/NVb+AX+ezlmHwux2T14bpXfaQXDdPb89O74H6dh3uvLJd+CK9Wa31/dPBGNY9rbReg4Wq1+gt3Ek5x +api: eJztVm1v2zYQ/isE92UN7CgJti9GEMBYhCzYlhiuC6xIA4eSzhYRWVRJyq5r+L/vjpRs+RXtkmAbsC+ydXc8PXd87mXBEzCxloWVKucdPkilYVqVFpjIMjUzbK5KZhUbgY1TpnJgSrOJ0sAMZKO2AT2VMRrH5MAwkScBGojSqonwIpmTD816Slu0i1WZ29PLSAdX7jFIgcX4LTaT+ChAj5SeMMEyNZYoZ0/du+snFoGdAeQEin0uQc9ZIbSYgAVtUIlIW/RtpsGW2ps1IG3gsamwDF8wHEvf1hKdSNGEpFgGAt24OEWE6TjkrcXiFOJnRibk7SFRcTmB3Dr144+ptYXpBAGKzWmBGTiVKqh8tdFXu+EreOcx8Ba3Ymx454F3vSV/bPF1vKhYcIPfnQjeWXA7LwBvTmgt5ngUo5mYhtxYLfMxXy5RRTfssod2OXqjY+4LQ5kgZjmSoFEFX4pMJai1uoTWDkOAra0Dw9TIRe4dBXsoEHgSzURuV0xaRarhcyk1JLwzEpmBZev1QouyEgq0sK8Q3coXimapMivGB01quTClSd8kTESelxNixS/9sDsIUXAd/h76P92P7Qv+eCgTCsvKQfyW8B9W1owABOYAi2MNwkK72Qba6BxrCfIYTGCwFIt2KdtY0O2KHT9Ewsi4nYAVMjPvdrizyxPWhwymJFJ5Nmfoa2/j+a5ER0phfef8QLaKMsrwEtHHdnruCYKuARGWk5PG/Z+cnLLbEXuizD61POCVs40e5HpdBD5GSL4L/Q4dmvlA8fo7SIj9EaKH8Rj00Hl8ZXKGd4Pbwceh5+g1KirBh971psCTlwSD2z/C/rDXv++FfVSEf/Zu+07RvcO3yt+v3bub8DDF65BgisW7c3HEa6cJqv5fmeO1OP4d71V7ONi4zJdd3vQcX6YXB69qig3fF+62e5wJBuISx9fcTYQIRxY2OPSJhZl0RD06yFCDKfAF3M1dnJ3Rz2aG3pcxFq2hmvjp4mJXf0+T31frSNFmgGEw0Frh/FUxwkBknU/5p/zSiiiDK/qj8cnYpU2vQjK8DPBfLblee6/k+KM3jiU4ja9kPhWZTIYUPRh7GURXaJisTOhmE2EFK7SaYudOWKLAsFw1Z7xfaPxlVKfrrwU1XIr8532Z+ecix2Gfi2wI3sVW4N2c1RYezQrM4QgxRFwhUoUc4mOgMimETfElmJ7XWwknWulpvWeUOkN9PQBEIev+z4nfu9rSrA0aDH1Puff0q3m6bi2F/A0alO+WCFHLr/XEcmWRIqfxlC//kXLHpc3I3i2W3d4tFVJVLR1+fnpGN1ooYyfY6tG88n4Ddt/s3m4ZCx4rTC/2kv+X4n/LUuzpYuGLDYpMSFeyjoGLisdVOxXrrRlXNUvyxQI3D/igs+WSxL7JEr8Taag86q56lAWvuvjujeYZ62D/To5dsCR7V3YvB/3SffYI+gNr9wsC+G9vpEdS1dzL/2Z+3nwlPQK/uSgfh+/tt9bOFzDizXe5I1Fvb5rfEvl6i1tbP9IL9tiIhtjDY3M234QDv8inm2Py2Y3J6g91r1qVzxuut+enh0BPQrj3yGLhhzB2xxVkpzp4oprHtTUlCHfz5V/sa16C sidebar_class_name: "get api-method" -info_path: api-reference/port-api +info_path: api-reference-temp/port-api custom_edit_url: null --- @@ -47,7 +47,7 @@ This route allows you to fetch one or more self-service actions and/or automatio ","required":false},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"blueprint_identifier","description":"The identifier/s of the blueprint/s whose actions/automations you wish to fetch.
","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["CREATE","DELETE","DAY-2"]}},"in":"query","name":"operation","description":"The [operation type/s](https://docs.port.io/create-self-service-experiences/setup-ui-for-action/#basic-details) of the action/s you want to fetch. Relevant only for self-service actions.
","required":false},{"schema":{"type":"boolean"},"in":"query","name":"published","description":"Only relevant for **automations**. If `true`, only published automations will be fetched.
","required":false},{"schema":{"type":"string","enum":["self-service","automation"]},"in":"query","name":"trigger_type","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["ENTITY_CREATED","ENTITY_UPDATED","ENTITY_DELETED","TIMER_PROPERTY_EXPIRED","ANY_ENTITY_CHANGE"]}},"in":"query","name":"trigger_event","description":"The event/s that triggered the automation/s you want to fetch. Relevant only for automations.
","required":false},{"schema":{"type":"string","enum":["v1","v2"]},"in":"query","name":"version","required":false}]} + parameters={[{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"action_identifier","explode":true,"description":"The identifier/s of the action/s and/or automation/s you want to fetch.
","required":false},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"blueprint_identifier","explode":true,"description":"The identifier/s of the blueprint/s whose actions/automations you wish to fetch.
","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["CREATE","DELETE","DAY-2"]}},"in":"query","name":"operation","explode":true,"description":"The [operation type/s](https://docs.port.io/create-self-service-experiences/setup-ui-for-action/#basic-details) of the action/s you want to fetch. Relevant only for self-service actions.
","required":false},{"schema":{"type":"boolean"},"in":"query","name":"published","description":"Only relevant for **automations**. If `true`, only published automations will be fetched.
","required":false},{"schema":{"type":"string","enum":["self-service","automation"]},"in":"query","name":"trigger_type","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["ENTITY_CREATED","ENTITY_UPDATED","ENTITY_DELETED","TIMER_PROPERTY_EXPIRED","ANY_ENTITY_CHANGE"]}},"in":"query","name":"trigger_event","description":"The event/s that triggered the automation/s you want to fetch. Relevant only for automations.
","required":false},{"schema":{"type":"string","enum":["v1","v2"]},"in":"query","name":"version","required":false}]} >
diff --git a/docs/api-reference/get-all-credentials.api.mdx b/docs/api-reference/get-all-credentials.api.mdx index b3e8a8f8b..7dea3d995 100644 --- a/docs/api-reference/get-all-credentials.api.mdx +++ b/docs/api-reference/get-all-credentials.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch all credentials in your Port organi sidebar_label: "Get all credentials" hide_title: true hide_table_of_contents: true -api: eJy1VMFu2zAM/RWDZy9pdzSGATkMRbFLsXWnIAfFYmK1sqVSVDrP8L8PlJ3YSVNsl+bgGKIeTb73yA40hpKMZ+MaKOCxMiEjFxkzZa17DVnrYsYu2yGXlZxlJaHGho2yITONxCl7cMSZo71qzB8lqRZftrT8Cjmw2gco1rDyPsAmB69I1chIctpBKCusFRQdcOsRClBEqoUcDGMdZueByTR7yAGbWEtCoyGHRtUIOZSEilGvGHKIXp/eA5aEnEBqa1HDpu9zMNLoS0RqjxkK2Bm0OkD+hg7MhpBwYJrSRo3SNVeYEQbvmoCL7H6XNY6z4LE0O4M6T0SNwFdjbbbFI1qfqCF8iYZQQ7FTNmC/SQVHMtwmbraoCEl6JVS6UIlBuXX8cOLn882N/J3X/QOZDB5QZyGWJYawi9a2C6HKNYwNC0R5b02Z5Fo+BcHN9fDkPBKb4Svuea5R005CMEXc9Dmk8v6to9s+YSmSnOcfZLhUu5+Um2Jb5yyqRoJGX8VMdrjin52jWjEUIDb5xKZGgUyu+W/IaK63Bchvru5a2NvkoLQ2QrayD7Pek/aXvntPvzF3jVw5DQXsk7u94goKWB5ul0kFqY0OxxGLZKGAitmHYrlU3iy8I14YB31+LRrDdGFmyZ/ijEGsozEnsb35jrNpWkWuHI2rAMaJq1BpJBgmcOcS3LCV+2l9rB7uIQcpe+DgdnEjNHsXuFbNZBK4Q75cRJeD200+/4CVNjTN+JuX3iqTrJh47EYp1nC4hXEkNjlULrAcdt1WBfxFtu/leFhBIpE2YXT5NTecN/OBC+lqY8/YzvfjQdkol5I3DoqMFA7FWlbAqLB0NKBWZYmeZ6g3K0eynNx89+1RWItC4dxbz8lb44tkP9tDx9yXphtKkKf4/Cqk6wbn9v3p/hB6FzG2eLwtFG36vv8LPcl9Kg== +api: eJy1VU1v2zAM/SuGzlnS7mgMA3IYimKXYutORQ6yRcdaFUuVqLSe4f8+UrZrJ02xXZpDIosfJt97ZDqhIJReO9S2Ebm4r3XIvI0ImTTGPoestTFDm1WAZc13WelBQYNampDphu0+u7MeM+v3stF/JKdafyn85qtYCZT7IPIHsXUuiN1KOOnlARA833YilDUcpMg7ga0DKkB6L1uK0wiHsLgP6HWzJwM08cAJtaKHhnLRD5UkEdQW6Rydej0HIAumIFkYUGLX95SaG32K4NspQy4qDUYF9nxxxiq6Qh9h9QYdyAZPhkQ3pYkKGAQkg4fgbBNgnd1WWWMxCw5KTe5qlXAbA581nQuYotUrUh6eoiZsRV4RtNDvUv3Ra2wTVAVID55bp25VLhOg7DW9OMH1+eqKf07r/gGEHhxBZSGWJYRQRWPaNSNnGyQyOYQSGl0m9ja/A8ct6XHeOvCoh7fYxyVlTTvzwrDtCORU3r9ptcVvKJmh0/wDK+fk9zORs62w1oBs2KjVxZhZHRfkVFl/kGQRrJpPqOm9/VJE/x0yau1tAfxZsvvA6BFtUinNYEtzt+g9cX+uu/f4G3PTPNWWMot9EruTWNPD5ni9SSxwbf44TVz0how1ogv5hhz02tHwrrWlJi5ZY5gdFpL8ycoYyJqEOZPt9HdYDNc2Un1+3AxiHMCaRExRw0BWNoVrNOyftsn27pZcuewBg+v1FcPsbMCDbGaRiBvA870kzgDsZp1/wIYbmkZ4wY0zUicpJhy7kYoHcbwW40gQhDW1wJddV8gAv7zpe74eNhJTpHQYVX5JDafNfOBCutjYIxG7WJdHaSI7JW0cpddcODXBK2BkmDsaorakXYeLqDcrh7O8qvnm2z2jFhnCpbYek7bGA2c/2UNT7nPRDSXwN+v8YkjXDcolPib/wfRuxNji5M0Q0V9M/xcdP4KF sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch all credentials in your Port organization.
","required":false}]} + parameters={[{"schema":{"type":"array","items":{"type":"string","enum":["id","name","createdAt","updatedAt","secret","enabled"]}},"in":"query","name":"fields","explode":true,"description":"The fields to include in the response. If not specified, all fields will be included.
","required":false}]} >
diff --git a/docs/api-reference/get-all-entities-of-a-blueprint.api.mdx b/docs/api-reference/get-all-entities-of-a-blueprint.api.mdx index 7a79838c0..b02f29f9e 100644 --- a/docs/api-reference/get-all-entities-of-a-blueprint.api.mdx +++ b/docs/api-reference/get-all-entities-of-a-blueprint.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch all entities in your software catal sidebar_label: "Get all entities of a blueprint" hide_title: true hide_table_of_contents: true -api: eJztWdty2zYQ/RUM2od4Qol2Jn2oRvHU07qZtJ04k7gvlVQbIlciYhBggIUcRaN/7wAkSOoWuYkTO61fdAFx2T27exbcXdAUTKJ5gVxJ2qPnGTdEK4tAmBDq2pC5sgQVmQAmmRsjIJEjB0O4dA81MWqC10wDSRgyoaZkzAykREnCyJTPQJKxsFBoLrHbH+v42H+cKyKAaUlypYGwsbJYbx2RJIPkirgxzIAMUpXYHCQyJ+boUYZYmF4cpyox3UJp7HIVjy0XacdJ1AkSdSqJYjOXSSdlyDqo6sHvwnEHXRpRZFNDewN6Wg3SUUQLplkOCNo9WVCTZJAz2ltQnBdAe3SslAAmaURTmDArkPYmTBhYRpQ7NN9Z0HMaUclyNx3eJ8KmcJEwkVjBENKLQqsCtD8vohreWa4hrXaJ1mzzYkIuUVu4jMig2YI0W3wCMIk1qHL+ATpcIky1B9jEiZITPrUaStBylYKIDaAtOrUt4+bgOIjDlexUw/P4gFxzIcgYSKV4SiZa5d6iAfrSIegy2oIu05o59DhCblrjBjWXU7rcgTKX/rD9eJ5I4o8gakJmTFgwjXwDL+Cc/Pbm7OWt+dtbo2THoLYJWg0HXXImxdwdZyAIEBDTgFZLSF2QOXk0mEJJAyVevypN4D3LCwE9crkgQ9rYohvwf5E6HSYc9JBGQ8pbf5eXt4p4ZV563wB2vDUGovKcI7a979bR3PC1rfBWMEY05/IPkFPMaO8oYFowzBpI6yi7aE5aOcURwTre5xmQZrpD3Slbb0WuM2Wa0PPMfs0k1vQegnEUUQOJ1RznnvfGwDRoR44aWNqDmiHdzICl95cnh4fua1Ws14CawwxSYmySgDETK8TccW6iJIJEt4QVheCJZ5DYmdGNNQDedMMKaDV+CwnSqGVIt4u6cp8gbU57AwfgaBnRWpv9YbBj25aF3CESziYetnLVIJjd5xNE0E6Fvwcnnb9Y58Nh58efLrqPe8PhcBg/64wef++04CjaYRdtSlBPAaaTjISAXBUsUfmYS4ZKt/SmTKY0okpTp7224uOqMzlfUWcXCCFOtrBGRN2jdTGe+fM9LWw9Z1N5afMx6NURIehy5HiJpSl37sHEq5ZcFe83YTNoBG2JFeQYbYP6M/XkclXRm1LtfdbJxS3j0mzVrJUsvpwCwf/flP7fYr27CIUgzek7y8SXDI2gdUgkW2KlmvKyDJZoW/DUU4RoT9gTS9Tbjd6S4V7Iexhat6vizyFK7jjePkGrkQepPb8VQCFURnsO/MxdynuU07gCdAtYPClvChsPEFi+LRs3d7DdSTb4T5ix/1a8j2Af2OeBfR7Y5+uyT4PEST2tuhx4UlkFZR3Fup6zKEUpaxtbp26XYveNdoN6bvhe8OkMddMD1m/WzQFleD7w3APPPfDcN8Vze97CNgSoqyGRq5bsuZv51U8Pn25WaM4khPLTRLk+ApdTAlorbYhKEqs1pL2hHMo+srGAY/dDHw8lIX3Mjk/dxH6MWT3yS7N7Nd6P/YJmWXrcHx9LhRcTZWXaj8fH/RjT+uFJuw7GMfOyFVrNuKtLXzYvkJfkmhkiFZJqI79JOC4O8jonevrkyf1RncsZEzy9cNYEgxsAnLf1dZVTkiooFc2Z6+34wqjv/JR1t49p/sO2Ot/dae5yGxMXUG6xbnlJwoxSmlqY3RouI5oDZiqlPToFLDNoRns0nh3FtSOZeLGtTruMW1FkQM9C/8hqQXs01LpZwUOp2yeMzafWNBNaNdk3zjwlx4XKbMPKBf8dWqX5E4uZ0vyDv77QqtScAUtdlvKl54nyyysOeaU0kpNXLxxLgTalYY+6h87ohTKYM/++Ve3+HHC1JagmhDWBtt4QWDQF3/9zo7G0FMJ7jAvBuA8ob/xF5WUDOjuiUdMDcH7U29ERgFa7MlMG3erFwgHzpxbLpRsuk4FzwJQb5+I7GmJt8/yHe407LHAF8xu0aKtrAfURe3M477oTdqetxo8C3nRrv1Fov2aTcb/jruA4cn80d0D+y/B/9Lq6Ex6QW2oq7hA+pC05b0selNrKef7tvUphTqty6kmSQIGtTTYaig6OOqk/Pz13r+7W0W07eV755Fn9aL2Ergq4nlVLEdxn+yV9ZcliUabm5bKeXz7auaJSsQmU8j7/D0z7gi0= +api: eJztWV9v2zYQ/yoEt4cGta2k6B5mpMGCLSuyDU3RZi9zvISWzjYbilRJyolr5LvvSImSbMt11qZNuiUPikUeeXe/+0cdFzQBE2ueWa4k7dPTKTdEq9wCYUKoK0PmKidWkTHYeOrGCEjLLQdDuHSTmhg1tldMA4mZZUJNyIgZSIiShJEJn4EkI5FDprm0vf2Rjg7841QRAUxLkipcykbIs9q6Q+IpxJfEjdkpkEGi4jzFWebEHD6ZWpuZfhThsOllStseV9Eo5yLpOom6QaJuKVFk5jLuJvjStaoa/C6w2+nRDrVsYmh/QI/KQTrs0IxploIF7WYW1KBUKaP9BbXzDBCtkVKog8TVCYxZLiztj5kwcNOh3KH5Pgc9x1mJu+ArXMciT+A8ZiLOBbOQnGdaZaA9vw7V8D7nGpJyl86KbY7H5MLqHC46ZFBvQeotPgGYODdWpfwDdNE6MNEeYBPFSo75JEdCD1qqEhCRAZtn3cqWUc04CuLg4m45PI92yBVHfxkBKRVPyFir1Fs0QF84BL3ptKDLtGYOPW4hNY1xY5H9hN5sQJlLz6wNT7jOBKpC+w7GVXgP0V8dR6LGZMZQS1OLO/Dyzslvb09e3Zn7vTOIFiqTxxaR3umREynmjp2BIEAAUCP0WiKAGHNOHg0mQztBAd+vSiPELM0E9MnFgpzR2jS9YI7jxOkw5qDPaOeM8sbrzcWdGqC0Nn3geLushtCqNOXWNn3zzsFd88RWtEtUOzTl8g+QEzul/b0AccbwtUK4isHzmtMSlza8T1G1mtyh7pSttiJXU2XqwPR5/4rheEj+IVQxLxqIc4328VlxhFkc2WPq1MCSPlT501EGLL37PNvddf+WxXoDqDfM0AAmj2MwZpwLMXcZGZOQxd3cEpZlgsc+v0TOjG6sBvC2G5ZAq9E7iC2+N5Iv7qIu3RNknqIuDsAhgl9psz0qNmzbsJBjIuFk7GErVg2C2X21QT/UToW/B4fdv1j3w273x5/Oe0/7Z/gXvegOn37vtOBWNKOwsy5BRYKmwaod4nNZsFilIy6ZVbqhN2UyQUocc9rrXHxcdSbnS+psAiHESUsSQWY4tSrGC8/fp4VWPuvK48IRYrw0IgS6q0tTLEm4cw8mXjfkKqtCHTaDWtCGWEGOYRvUn6knBveSorfNvA9ZJxe3jEvTqlmjdnw5BYL/vy38v5H17iMUgjRH73MmvmRoBK1DIWmJlZLkVREsnbbgqUiEaBJsiSXq7UbvyHDH8gGG1t2q+HOIknuOt0/QauhBatI3AiiEynALw8/cpThHOY1LQFvA4nFxUlibsMDStmpcn8E2F9ngP4Fi+yF5W4J9zD6P2ecx+3zd7FMjcViRlYcDn1SWQVlFser2LApRis5HK2m7FJtPtGup55bfBZ+eoW7LYPVkXTMowvMxzz3mucc8903luS1fYWsCVN2QjuuWbDmb+dXPd5+vd2hOJIT201i5WwbEjoDWShui4jjXyK5/Js/kvmUjAQfuh8YnIft2enDkCPcj/BVGfql3L8fxn15alhzsjw6ksudjlctkPxodIElSTR42+2DcTr1saJ4Zd13ri/oD8oJcMUNwI1Ju5DcJ7KIgr3Oi58+ePRzVuUS34sm5syYYuwbAaVNf1zkliYJC0ZS5mx/fGPX3QkXf7WOa/9DW57s/zV1tY+Icii1WLS9JoCikqYTZrCGqmIKdKowJOgFbVNApvkSzvahyJBMt2vq0N1EjigzoWbhdyrXALUKvm2U8tLp9wVifzU1N0OjJvnXmKXJc6MzWWTnjv0OjU3+Yoxaaf/DHF1q2mqfAElelfOt5rPzyMoe8Rn7k8PWxy1IodmHYvd6uM3qmjE2Z/94qd38JdvnCEM3P6kCjKw3qRd3w/T9fQxaWsnBto0xgwXHYeuMvSi8b0NkeEtZ+hi/9DTcC0LjMnKKB3OrFwgHzpxY3N264KAbOARNunItvuH5smuc/fBO5wQKXGDbbL3DLYwH1EXt7OO/7Juxebx4/Cnh9l/uNQvs1Lxm3O+4SjkP3orkD8l+G/5M35Zlwh9zRpeIG4UPZkvOm5EGp1pznv97LEua0KkgP4xgy29hk7ULRwVEV9ZdHp+7TPXfptlk8L33xLH80PkKXBVytqoUI7tn8SF9aslgUpRlTcqAvpjauKFWsA6U4z/8DzeaM4w== sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch all entities in your software catalog based on a "},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`","required":false},{"schema":{"type":"string","minLength":1},"in":"path","name":"blueprint_identifier","required":true,"description":"The identifier of the blueprint whose entities you want to fetch.
"}]} + parameters={[{"schema":{"type":"boolean","default":false},"in":"query","name":"exclude_calculated_properties","required":false,"description":"If `true`, [calculated properties](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/) will be excluded from the entities.
"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`","required":false},{"schema":{"type":"string","minLength":1},"in":"path","name":"blueprint_identifier","required":true,"description":"The identifier of the blueprint whose entities you want to fetch.
"}]} >
diff --git a/docs/api-reference/get-all-teams-in-your-organization.api.mdx b/docs/api-reference/get-all-teams-in-your-organization.api.mdx index 66f8f054f..1467861d6 100644 --- a/docs/api-reference/get-all-teams-in-your-organization.api.mdx +++ b/docs/api-reference/get-all-teams-in-your-organization.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch all of the teams in your Port organ sidebar_label: "Get all teams in your organization" hide_title: true hide_table_of_contents: true -api: eJzVVU1v4zYQ/SvEnFqAsZI9CkWBHBaLRYEiaNOT4QNNjiJuKFE7HDrrGvrvBUnJlhPtB3op6oMsz5fJee/NnMBg0GQHtr6HGh5bGwT5yCiUc/4liKOPgr1okHWbbMI3glsUjKoLwvYpgMSDJxaenlRv/1ap1uaXPVW/5sejFw4V9aLzhELtfeSSLYVuUT+LbGhRbI3XscOec4XdTy3zEOqqMl6HzeCJN9ZXIfgb2itdpceNPyAdLL5UP29AAqunAPUWHlN12EkYFKkOGSmZTxB0i52C+gR8HBBqUETqCBIsYxcW9sBk+yeQgH3sUkVrQEKvOgQJmlAxmnsGCXEw5/eB/MEaJJBXTZUQA1LYNJYC/15KFItTrwzYKevOvwarOdLFG1hxDLAbRwk2gfU5Ih3nc9XQWHQmvPr3BCmK4spYvqieL4A2ngQq3WZANuJjI2JAI4Xv3TFjEgbUtrFo5hov1jmxR2F77aJBkyiQAgnD4PuABXiQQPg5WkIDdaNcwHEnIaCOZPmYwdijIqTUXEJlai6YpbC5VEbk3e1t+rq+0x/IZPGARoSoNYbQROeOiQLa94w9pxQ1DM7qzKXqU0h5Swb8aMGJEX7/CfWE8oDEtpzOPy/Z1B8vlGGKuBsllHt9n3Jf+QNr3tJynCFfcVzIucLmxlOnGGpIpL1h22FKuXD4h1POVF87wlVnV/yZzf++I0Uka4UvClvzntW25py1tuabdPfWNX2WVN9OeMvEjJ0EZYxNjVDuYXGJIoiS2yG33kANT5jvqriFGqrDXTVXCkiHeYJFclDDPBjVYOe5CKNc88ZwCVgI8M8kg9LOWYYXOAb7Gy7Gyn3k1tM01mEaPS2qBH8ZRY3P6ZZdis+r4P7hI0hIxy76utvc5jb7wJ3KtJiqf0DOW+V6nSw3yeuBdrpo/P++rkrDGb9wNThl+6wOyuQuPNjC4Q7mGbKT0PrAyXo67VXAv8iNYzKXRZD4YWxQe3ceut9s3X+zFlYv/YzH5QI7KBdTUObsQZFNd4J6m+bpxLx02ZJ1rzUOvMh6M/dTlbPMPrx/BAkqpvYuOf+cOT+9pOpXQ32u/VoM5QjpmfS3mnI6FUWN4zm+uL6aMV1xjk4t2o3j+A8Xg1aU +api: eJzVVktv3DYQ/isETw2wXtk9LooCPhRBEKAwWudk+MCVRhZjrsgMh3I2i/3vnSGlXTmrtEEvQXzQUvP4NI9vhj7oBmKNNpD1vd7o+85GhT4RKOOcf4lq75Mir1qguhOZ8q2iDhSB2UVlezFAdeeRlMcn09svRrDWv22x+j0/7r1yYLBXO48Mu2X04r1SdQf1s8oChnxofJ120FNGePylIwpxU1UsjuvAX1hbX8Xor3Br6koeV34AHCy8VG/WeqXJPEW9edD3gq4fVzoYNDsgQBEfdOTv7YzeHDTtA3C6BtHs2dESsMNZHglt/8QK6NNOEG3DLz1j8U+NYAiaW+JzCs3pHNAPtgHk47yobBQ5gHVrMdKfBaJInPlKwMFZd3oLtqaEZ23kuiRO63jkgKVZnxLgfopro1sLrokS9OfgfMMiwgSriw6DKpa5tS+mp3N/W48KDB+kP2v1rlX86WalfO/2uUUxQG3ZvZkwXixTYgtMhNqlhuXMCDFEiMH3EQoPOCiET8kiNHrTGhfhyN2JUCe0tM+92TJFuHZcay5vs6HSQjGboHKDfr2+lp/XOf0F3C8Y+Osx1TXE2Cbn9sKI2vfEhBIXE4KzdaZW9TGK35wQ3ws4EsRvP0I9Nj0Aki3R+ec5ufr9mUHSikduXMnrvxn4jQ8wDy9YepwYsKA4c3WB3NztnWGNFg5fkWWM45zS3+1yYv5SCK8qu6DP5P7/FSkzswR8Hrgl7Wn4lpTT6C3pxjG8VI1/c6o/jP1eCTOYyqZprBTCuLtZEmUgii9vq86zp36CnKuhjl+q4aaakLhcw7TQEnLqetqTJthpTXKgS9oUzwazAfxbxqCUcxrDczuCfQ+zLXObOEAct7weN1HHI8teZTO1PrtbcmKfb4bbu3dsKmGX+bpZX+cy+0g7k2kxor8FypfM69tlfrHoC0adZvxnv71KwQk+UxWc4cLKdGAmd+HBgx5u9LRDuH8d10+kh8PWRPiA7ngUcbkXhB+NjWbrTkv3X0v3Y66FxaSfmXCz+2wwLolR5uxg0EpOnJ/s05F5kmzxuuV9HWjmdbH3BeU0Zm//uGdbk6S8c84/Z86PB0F/tdQn7K+HoYQgT5m/RZfDoUwUt2qyL6pveowpTtZSIv4f4PgP0+5b7w== sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch all of the teams in your Port organization.
< ","required":false}]} + parameters={[{"schema":{"type":"array","items":{"type":"string","enum":["id","name","createdAt","updatedAt","provider","description","users.firstName","users.lastName","users.email","users.picture","users.status"]}},"in":"query","name":"fields","explode":true,"description":"The fields you want to fetch for each team. If used, only the specified fields will be included in the response.
","required":false}]} >
diff --git a/docs/api-reference/get-all-users-in-your-organization.api.mdx b/docs/api-reference/get-all-users-in-your-organization.api.mdx index fee2d6c98..cc6eb7fd0 100644 --- a/docs/api-reference/get-all-users-in-your-organization.api.mdx +++ b/docs/api-reference/get-all-users-in-your-organization.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch all of the users in your Port organ sidebar_label: "Get all users in your organization" hide_title: true hide_table_of_contents: true -api: eJzVVcGO4zYM/RWBpxbwJDM9GkWBORSLRYFi0M6eghwUiY61I1teiso0DfzvBaU48cx62+nuoWgOjkSRFEm9R57AYjTkBnahhxoeWxcVhcSotPfhOapjSIqDapBNKzIVGsUtqhSRonK9KJB6CMQq0F737k8tvlY/7mj9U/48BuVRU6+6QKj0LiQu1pUyLZonJQJxubHBpA57zh6237XMQ6zXaxtMXA2BeOXCOsZwQztt1vK5CQekg8Pn9fcrqID1PkK9gQ/iHbYVDJp0hyy7enOCaFrsNNQn4OOAUIMm0keowDF2cSaPTK7fQwXYp048OiubTjsPFTSOIv+qO4QKvL4sB2c4kawia05RAhJ3FQwUDs5KFBUYQs1o7xkqSIO9rBl1F1d9cVU2k9lFMLctkrkHCh4vHspm/riTzMV727nrfqDAaBjtRTK/pkiu12zHsQInUPmUkKR2+cIaGofeSoKvAYWqHGUkPeuer3BqAinUps1wWKn3jSxspULvjxkRcUDjGod28vHsvFc7VK43Plm0AkBRJIxD6CMW2Enc+Ck5Qgt1o33EcVtBRJPI8TFDYYeakORpCbWtU0GMqE2uMh5+uL2Vv5c5/YZMDg9oVUzGYIxN8v4oADShZ+xZTPQweGcyktcfo9jN8fdWh2c8ht1HNFyQNCCxK9GFpzmW++MVsEwJt2MFJa9/BvwXLiiI/4wX45wDS6cXViwdTjxZOjszZ+nI2UVxESxdcyHdm/ku2L6Cf6EdNIE6zVCD0OGGXYdy05UdbzYJtP+GZ1ksxTgHfe5Ymau5T/y7EmTOf310/fLDv4ova23H/Ht5UjBbCbq3FWhrndBE+4fZLYXUxbZDboOFGvaYg9HcQg3rw9168hSRDtMMSOShhmm06MFNkwXGauk0xavCrIn8LlQu+U6t5Fqvwf2Cs9Z4n7gNdB6McG6fLWpp7aWdNiGbO/ain4fp/cN7qEDCLj3ibnWbUR0id7q/1hneIee5/HIgz2fx66Z8uvap//vALwVn/IPXg9euz3Sk3LIKDjZwuIOpD24raENkkZ5OOx3xA/lxFHEZZoIP66Le+cvg+NvS/TejbTHpJzzOh/BB+yRKGbMHTU5ygnojM+GMPEm2WN0bgwPPrD6bXeLlQrN3Pz9CBTpJeeeYf8qYPy/E+4vBNPl+TYYSgnyFf4smp1Nh1Dhe9MvRFy3OKU7aUiJpNX8BzqPEwQ== +api: eJzVVU1v3DYQ/SsETy2wXtk9LooCewiCoEBhtM7J8IErzVqMKZEhh3K2i/3vnSFXEm0riZMeguxBSw7ngzN8b+YoGwi11w617eVG3rQ6CG8jglDG2McgDjYKtGIPWLcsE3YvsAURA/ggdM8KXlxbj8L6e9XrfxX7Wv++89Uf6XNjhQHle9FZT2535D1br0TdQv0gWMAubxtbxw56TB7ufmkRXdhUFYnD2lGEtbZVCPbC71Rd8efCDuAHDY/Vr2u5kqjug9zcyvfsXd6tpFNedYC829weZaB4nZKbo8SDA0pXea8OZKgRulDIA3rd39MB9LFjj7rhTae0of+99gH/Ise0NmpaOl1j9LwKlEEMfCF2RyfeDrrhW6xk7UEhNFukdXTNtEZQXVj32VXejGaToLTNktKDtwYmD3lTPu4o02HbdHreUxSEmpxMkjJMlsxh7k4nKhdD5WMEz7VLATdUFDANJwifnLENidBHWL3AF4ismYD1qHqc0bW3XoCiBaNjLd7tedGshO3NIQEkOKg1mTejj0dNgNwBwbA2sSE54ZEVPQRn+wAZhZwGfIzaU46bvTIBToSNAHX0Gg8JGTsCKBWaXppybzYxA4jVRlcJHr9dXvLf05z+BkILDBQ9xLqGEPbRmAPjsbY9EpzZRDlndJ2AXX0IbFfC8bUOz/C0uw/0YhlYDjzqfDv7UEK7P8z45ae4o4fLeX0d/58JkAnwgiankhJLpxNJlg5H2iydnYm0dESMXBJnwVKYiYOvpj9DfebCQncgwHaKTiSz4wI1ZXgqWf1qE+qc/+NZFktxKkGfGliibmob31aC1AK+/3b98sM/u1/Sohvy7+lJxuyK0U10VE2jmSbKXBdRMqmzLfX71pKlvId0GYUtbarhqho90d8wjoToCdBynDTK6XHQ0LMsncYwKxRN5B+mcs53bCVzvZz+E4pOuY10QX+ek/LcTVtqO2SVu+veJnONhvXTbN1evyNVvnbuEVfry4RqG7BT/Vxn+RYwjemn87kczfJZUz7Ofepnn/+54AifsHJGUWGZjj61rIyDWzlcybEP0vu1VD+WHo87FeC9N6cTi/NsY3w0OqidmQbHF0v3Y0bbYtIPBLhiJg/KRFZKmB2U15wT5ccz4Yw8TjZbbWnmOCysXswu9jLR7O2bG9JVkctbYv4hYf68YO9PBtPo+zkZ8hX4y/xbNDkeM6PoqUb9fPRZi3OKozaXiFvNfzJmyhw= sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch all of the users in your Port organization.
< ","required":false}]} + parameters={[{"schema":{"type":"array","items":{"type":"string","enum":["id","email","firstName","lastName","picture","status","type","providers","createdAt","updatedAt","teams.name","teams.provider","teams.createdAt","teams.updatedAt","roles.name","roles.description","roles.isAdmin","roles.protected","roles.createdAt","roles.updatedAt"]}},"in":"query","name":"fields","explode":true,"description":"The fields you want to fetch for each user. If used, only the specified fields will be included in the response.
","required":false}]} >
diff --git a/docs/api-reference/get-an-entity.api.mdx b/docs/api-reference/get-an-entity.api.mdx index a3e0ae533..1a0758fc5 100644 --- a/docs/api-reference/get-an-entity.api.mdx +++ b/docs/api-reference/get-an-entity.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch a specific entity in your software sidebar_label: "Get an entity" hide_title: true hide_table_of_contents: true -api: eJzlV99v3DYM/lcE7qUBfOek6F6MwwEBlhXdhrVYs6ckSGSbPmuVJZeikl4P/t8L+cfZzeXaJC3abnvxnSWKpD6SH+kN5OgyUjUrayCB01I5QdYzCqm1vXFibb1gKwrkrBRSuBozVahMoGHFa6FMkCDhbME3klBkkqW2q/kipXjZPk6t0CjJiMoSCplaz91phS4SWYnZGxHWuERxltvMV2hYBocunpTMtUviOLeZm9eWeK5snHql81kwOxvMznqzsVubbJZLljO228WfBnMHc4iA5cpBcgYn/SJcRFBLkhUyUtjZgMtKrCQkG+B1jZBAaq1GaSCCHAvpNUNSSO2wiUAF3N56pDVEYGQVxPFdpn2Ol5nUmdeSMb+sydZIrb0ICN96RZj3WqJbUXhRiCsmj1eROBtViFHFI4DJvGNbqfc4U4ZxRS3ALs6sKdTKE3agVTZHHTtkX89S7bEmZTgeDceDO8qaWb+8jg/EjdJapCj6i+eiIFu1Ee3ypEsHaKI7sJVEMmCnGCs3WXdMyqyg2YOxMq2pz6N5bERrQthCXEvt0Y3enfVp/Nvrl39+tWz7x1kzc0w+Y094MBcvjV4Hcw4HBwa8CNmTwTzUUfCH0NXWOOzw+tWSwHeyqjUm4mojzmGMxHxA/0Ue7lAopHOIzkFNXpurr4p4H9wfH/FAWCkKW1WKeZqM3wbeHsYIKmX+QLPiEpKjAdNacjmBtAXjctT6EbiBA25je1qiGMUDwmOVtWR9Iw1vGftTdfcAN7dU8OWeblVN/U5RW7Nygu3g8EUEDjNPitctI6coCSnQNqHME9xyd5Acwtrm8tPDw/DzsS+vfZahc9BE8Ozw2e7+S4ODg4UNjU+ZlUAiS07YLPNEmCfn5twsWKYal+EPLc+NEAsulydBcBFzuV35ZdTery/i9sB4LF8u0qWxfFlYb/JFnC4XMefbzWMzgHOjuGw9q8leq0CuVyOsV+JGOmEsi15Nq+LBxiZh+QJz8QBOi/PTpz8OzspcS63yy5Cx6HgHgNPpfQO9iNxid9FKhsmnZY92Lurq6FM3//muDPx+N2ckI/Uldip202yQ6LzZOrP/hk0EFXJpc0hghQxRxxYJxNdH8TaRXLy5izaaeKjdeLPDfg2EsqfrYQ7zpCGBoUnIWg09omW03V3vRoEJg7wOIevYYeCRsRfW6necNLljz6Ul9b4dcaBnwxJljtQ3xsK2xxXrIP/KEovjVy8gguB2F+yj+WFIhNo6rqQJ4r3258hCDpUNtxhzA5k1jIb/L4N4FwHGdxzXWqq2eNqgbvqMOoPrI4jG9hNm52RPM9q2hAiS3bZ6EUFpHQeVm00qHf5NumnCcjfkhGzLlQs5vmeqmUbnPzug7wnKG1zf46umHfUggbY47w/m954Wv+t8/knAx0+cfym0324Qv0/ifoTjRXghFYB8YPE/+asfew/Eo4bxPa4O/cisp35ur7DDaA/LhM86fb+5/FG+30nYzcV0jHh+cgoRSB9If9qa37Stuf8TwnSnpds9uzMbngGkO49sNl3jb5qtfLe190Q/A4y1Ga7QNB8At9jTbw== +api: eJzlV21P3DgQ/iuW70uRdjeAel8ihIR0tOLudFQH9wnQrpNMNj4cO7UdYBvlv3fsvMLuUqBVae++ZBN7PC/PjJ+ZrWgCJta8sFxJGtLzjBuiVWmBMCHUrSErVRKrSAo2zggjpoCYpzwmIC23K8Klk9DEqNTeMg0kZpYJtZwdRDo49I9zRQQwLUmucJ9FqL05zcFMSJxBfE3cms2AXCQqLnPcZc6hqzeZtYUJgwCXzaxQ2s64CqKSi2TqzE47s9PWbGBWMp4m+DG1ql/8pTO3M6MTatnS0PCCHreL9GpCC6ZZDha026moQa9yRsOK2lUBiEukFMYg8XQCKSuFpWHKhIF6QrnD7WMJeoW7ErXgJ9zFokxgHjMRl4JZSOaFVgVob29CNXwsuYak1TJ5kIWTlCysLmExIReDCjKoeAEwcWmsyvknmHJpYak9wCaIlUz5skRBD1quEhCBAVsW00iUUGiUDgbDQecOHp62y6tgh9xyIUgEpA08IalWuc9oUydNOdB6sgFbpjVz2HELuRmtG4vGl7TegjGX3tQmNOGuEBgIDR2ID8E9ksRbJColNwxjNIOzF21V/352+tc3K75/DWKFwZSxRZx3ZuRUipUzZ6BzoINPI/BaInx4rZw/GkyBWYIGvndKI8AsLwSEZFGRSzokZtYl4yRxMaQc9CWdXFI++qwX3zQBba5/ugQ4OkOsVZ5za8el+n3QblGd0JzLP0EubUbDvQ7iguHngLAHYz5ovYf1JmzPMYxB3CE83EFP5bdM2p7PH7uVz3CzJ4qv97RXNfY7AqHk0qDbncPI2AbiUuOu5+sI+wvaRFLXwJIQemZ3kl1afWnv7+66n/u+nJVxDMYgEPTt7tv1/VMJnYOpcm0RkSGgtdKGqBj9wCjDS3kpDyyLBBy6F41PQg5sdnjsBA8CfOtWfhu0t+v4o+8dS7B3Hkpl56kqZXIQRIcokvSbeIdacG65zbxnWJI33FHvYoB1gfk2BNWQVo1X8Wxjo7R8hbmgA8fjvL//4+DMJfIQT+auYsHYNQDOx/E6eiGJgibQnLm5yLOHn5qae/RY5L9uqsDXixxnHsnEHBoV62XWSTTe9M5sjxBDxEkqU3jv6RIsnTRsEdLgZi/oC8kE1SbaqIPu7gbVGvvV1F17fdNNaaUWqLZrEqzgXY/wjLa+W5pBYMQgZy5lDTt0PDK0xoL/AaOed1RiZJp/8gMQbdkwQ87BU02fTJU/zq1w8h/QHjn6cIKizu0m2XuzXVcIhTI2x5kSxVvt78ES1t1s+oAxK4qzmsW9/8uY3mTAwh0OoIJxf3l8Uqu2oi7ozR4KDjWFH+GWZtS3BBRZb6tYDRlmw6msqogZ+EeLunbLzczjqi3hxtX4lpl9nJ3/7Pi+JSnXeEO+/J/Hj3oo5y/n08F87WnxVcf1RwEf/gD9pNB+v0H8KYV7D8cr96G5A/KZl//N3+3Yu0NeNIxvcbXrR3I19rMPYY3RnlcJX3T6aXP5i3zfSNj11XiMeH98juKsdKQ/bs3XvjW3Ly5NGy097NmNWfd0IG08UlVN46/rXr7Z2nqinQGGu+lCqOvPGCveJQ== sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch a specific entity in your software catalog.
< "},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","required":false,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"string","minLength":1},"in":"path","name":"entity_identifier","required":true,"description":"The identifier of the entity you want to fetch.
"},{"schema":{"type":"string","minLength":1},"in":"path","name":"blueprint_identifier","required":true,"description":"The identifier of the blueprint the entity belongs to.
"}]} + parameters={[{"schema":{"type":"boolean","default":false},"in":"query","name":"exclude_calculated_properties","required":false,"description":"If `true`, [calculated properties](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/) will be excluded from the entity.
"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","required":false,"explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"string","minLength":1},"in":"path","name":"entity_identifier","required":true,"description":"The identifier of the entity you want to fetch.
"},{"schema":{"type":"string","minLength":1},"in":"path","name":"blueprint_identifier","required":true,"description":"The identifier of the blueprint the entity belongs to.
"}]} >
diff --git a/docs/api-reference/get-audit-logs.api.mdx b/docs/api-reference/get-audit-logs.api.mdx index 1d5dfbd72..1cc453c11 100644 --- a/docs/api-reference/get-audit-logs.api.mdx +++ b/docs/api-reference/get-audit-logs.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to fetch audit logs from your Port account. sidebar_label: "Get audit logs" hide_title: true hide_table_of_contents: true -api: eJztl11v2zYUhv8KwZttgGInaQsMwjDAaNzCWLEVjXOxBcZMS0cSUYpUySO7qeH/PhxRllV/qEnseRuwG8exyKPnfJLvksfgIisLlEbzkI8z6Zg1JQITSpmFYw+mZGhYAhhlTJSxRKZM6lhiTU4PLXtvLDIRRabU2GO/00+tdZHQTChn2AzYXMICYjaXgt3Tru8cuxtNvs8QCxf2+6IoeilgYSz2pOk7QJQ6df0BWXtn0h96P81s/+fqowW6kEqxAmxibM4EvVVGQrHp4NebKZsBLgAIQbFPJdgHVggrckCwjs1AmUXAhI6ZBSytX1ZhYyaQ5YKcxgxYZCWClaLHA44idTy85xUWnwR8Y5GH90vuogxywcMlx4cCeMgdWqlTvgq4pBhXGDzgWuT0VMagUSYSLA+2sjHQbPOUmaRCUSZlMAeNVWoWQmOTHx8fHnALn0ppIeZhIpSDVfBkKnorPuwQvfFloFQ7xRaUQIgJgwBdARERx8wbOSHVTJVQWKnxSLDGzgnZbKn/lPGRYCKibcyW+oRkC5hlxnwcHQtX2zk92ZDK+VR4vjmeBCmsFUQlEXK3B/4AvbEylfpx1JHJpU791Pwa21vpux7zMw0SGk21d1IjpFaQ5X49lNDKNAVLEfDToMfeGMtMAX6dW8/CetI2gzaoNvjX+aE5Aza9G01PmNCRdiiUqkCOTmjL+VOmM+Cgy5wmeHucNAPPlpTSuph4wF1kLETCkje+PfnkUEVYcKa0EbgjPV/bYUTed8d5v/a2hg94ZDTC52qGyiShpe0jaP3uMZkLuEOBJflT1x1FIY4lmRLqRqDgAc/BOZHC4bhIHaky3hOWcQYskaBi99VpVq9nUleBseAKox302ChhpYM4YEarh62g1XbWlV3biHeMPKPaA04NJZCHPBYIFyhzONQC1OJ7/XQoLF1oGO12KPJifaS3SmLnTA/W/KPb35inYNPry+vri8uXF9cvxlc/htevwpcveq+urv54Vis/xTk0e10DHf8LHTvgQ9MHj+jQhcRs/xFNr2IXbPr6w3AwHk4DNr17f+O/GcumN8N3w/HwmflYd+zt3evXw9tbHvA3g9G7uw9DPjngU9Olz/PJb38SrC7zGdhDMVYyl7uXNCqVXHyWeZkzv58Kxd+3v3WFnQTcQVRaGtJ0y56BsGApShZEHFb+XSiT8gktXTd7NQCvLy/pz9csN5CIUiH7UK+sTvkcMDMxD3kKRF8IzHjI+/Or/sY+cdj5+rJfWsVDvlEwslfLF05R231aus2Clku3FF5Pu3ZsM9AL+Qu0YjsoMTNWfhF1GVfxz0DElI4qH4mptktUtL7SZ4P3Ix5wwvbuX/UuKXeFcZgLTctr628BW8WyncKlPzw0/q8VH6cVfQrpuO0XSkhNQa+qYllX1z2fX9GZuqnfgGfGIT1ZLmfCwZ1VqxX97HuMqi6WTsxU0xwdSXq2hNxL/hEethXrXKiSFlb1/niuo4RkB1tzjTsL166O7EBr3zbPQrdHTHbgNfr1LGzbWrIDrC1fz8m2JSS/TbiRsafE/E8ox47gNCr5LLnbpxk74Hb06lkgD8m7ru5sKctnMv6TWqvrNNlowyMcO6u46vCmVn9HeHJGLdXhRyX0TtkMJ1NSHdCNsvubwbfkUgdRo8uOKIjHKqYOjLUc21BM6B8rCYOH95O29nk7HFcXUrqdtkXIx0qE1F/oFrp+pNv3rW114gHokzzfu2W59BJntWrW+0cHd9RqZzNC+GqyWq3+Aj/qLbU= +api: eJztV21v6jYU/iuWv2yTUijce6UJTZNQS6/Qqu2qpR+2Cg2TOMRqEufaTmkv4r/vHDsJKS9pC4xt0r5A4tgnz3Pecp4FDbj2lciMkCnt0VEkNFEyN5ywOJZzTZ5lTowkITd+RFgeCENiOdMkVDLBh4p8kcoQ5vsyT02L/I5LtX0+S8GUlmTKyaPgcx7AHyP3eOo7Te6G4+8jYzLda7dZlrVm3GTwpCVkW3NjRDrT7T5au5azH1o/TVX7Z/tTAzoXcUwyrkKpEsLwrcJnMZn0f72cwFvNnHOEEJOvOVfPJGOKJdxwpeEhUPQISwOiuMmV22Zhm4gZkjAkbSJOwEVwQrAW9ahhM01799TComOPrizC8oJqP+IJo70FNc8ZB6dqo4AHXXpUoI8tDLCTwiG4FQFPjQgFV7D2Mhr9lKyeEhlaKACP8EdYtaGZM7go4+P8A2YU/5oLxQPaC8H3fOm9GxW+1TxvILpyaQBeqoVY8ZgZiCvAQIA64z4iDogzckRU0zjnGWwwBwKr7BwRm8rTP0VwIDDm4zECto6IbM6nkZQPw0PBFXaOj2yA6XwseK443gWSKcUQFdR4oreA34FeKjGDdY/ypyyWASwZlfM3kfBlApZdE33Jwhlt6xZxLY6H2KkKspCxfKYYWm4XPQogzmZcoUNcc2iRKwnNAhqi3afL1lg03qrvevaAe53rodChJ3fDyRHjO0y1AeYWyMHxrZE/ZnQhfGmeYEOvd5eq/0Epwm+RW3Clfam4zxSycdVKx7sSRHENX0Of671yZKcjSrMEiUCmHOSMknzBxaO+BD8/2Q4rwhC31j9Q5btHaA68YZjJkV6RhuiUABiAKRZfMsNgIeFasxnf7SaR+nEevO6lEXgBYMSBfvHpK47Dv/UTIMwg7XmLDEOSax54RKbx85oPCztl3hc2gg0je9SCR7HcmIGVAAJ4ZgSw3EEdG8BGWSBPcKzC6YfgabhJsvL7X8uQjQHAK/EPb38jDgWZdM+73bPzj2fdD6POj73up97HD61Pnc4fexX6e8gZuZUaT4N/IbEdHKqyeEPBzoWJtn/P8VXkjEwubgb90WDiQZ/9cumuoFdPLgfXA7jZLx5lAd/eXVwMbm9h5ao/vL67GUDBbedUFe1+nNzxd4EFiFNoDjvwxCIRmxMdpkrCnkSSJ8Sdx0Rxw/lr8y4M5Zr7ucIWjiP5lDMF7wcvKc6CnuV3BqbARWPb02yx237YPT/Hv5dYLnnI8tiQm2KnHQlg5I8kvJKCZqGoAkwEN+3HTntlH3Gox1IZ5CqGHSu5I1qF1qHotc2n4OVqQ43SLbrXoS2Jrfp7Jn7hNd/2cwCpxDdWpLH1fwROwHDYeITSHhcmxv1WzPW/DGErwnb0O61zjF0mtUlYitsL65+5qSXLeggX7luSmv+F5duEpQshfn3bWcwgVOB0mxWLIrvu6WMHP7Gr/PVoBFHBJ4vFlGl+p+LlEpddjWHWBUKzaVwVR0OQ9tabW5E/QB6uydtHBiMWLNp8fzuug1RnA7ZqyDsJrk3R2QCtPoueBN0W5dkArxK7J8G2LjwbgNW17imxranO1xGuNO8xYf4ndGWDcypJfZLYbVOUDeA21OxJQO5Se03VWdOde2L8J7VW09dkJRUPIHZScdXAplB/BzA5oZZq4GGF3jGL4WhKqgF0pez+ZuBrcqkBUaXLDkiItyqmBhilHFuhGOMNDKlTlAj347r2+TwY2YEUp9O6CHmwIqS4wCm0fJTW5611deIA4C8y33pksXASB6bccr97tPNEoXZWLQQILZfLvwB6MT3G sidebar_class_name: "get api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to fetch audit logs from your Port account. Your audit log ","required":false},{"schema":{"type":"string"},"in":"query","name":"entity","description":"Fetch all audit logs related to the specified entity.
","required":false},{"schema":{"type":"string"},"in":"query","name":"blueprint","description":"Fetch all audit logs related to the specified blueprint.
","required":false},{"schema":{"type":"string"},"in":"query","name":"run_id","description":"Fetch all audit logs related to the specified action run.
","required":false},{"schema":{"type":"string"},"in":"query","name":"webhookId","description":"Fetch all audit logs related to the specified webhook.
","required":false},{"schema":{"type":"string"},"in":"query","name":"webhookEventId","description":"Fetch all audit logs related to the specified webhook event.
","required":false},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"origin","description":"Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
","required":false},{"schema":{"type":"string"},"in":"query","name":"InstallationId","description":"Fetch all audit logs related to the specified integration.
","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["blueprint","entity","run","webhook","scorecard","action"]}},"in":"query","name":"resources","description":"Fetch all audit logs related to the specified resource type/s.
","required":false},{"schema":{"type":"array","items":{"enum":["action","context","diff","identifier","resourceType","status","trigger","additionalData","message"]}},"in":"query","name":"includes","description":"The fields you want to include in the response. If used, only the specified fields will be included in the response.
","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"from","description":"The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"to","description":"The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
","required":false},{"schema":{"type":"string"},"in":"query","name":"action","description":"Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
","required":false},{"schema":{"type":"string","enum":["SUCCESS","FAILURE"]},"in":"query","name":"status","description":"Fetch all audit logs with the specified status.
","required":false},{"schema":{"type":"number"},"in":"query","name":"limit","description":"The maximum number of logs to fetch.
","required":false}]} + parameters={[{"schema":{"type":"string"},"in":"query","name":"identifier","description":"An identifier of the log event you want to fetch.
","required":false},{"schema":{"type":"string"},"in":"query","name":"entity","description":"Fetch all audit logs related to the specified entity.
","required":false},{"schema":{"type":"string"},"in":"query","name":"blueprint","description":"Fetch all audit logs related to the specified blueprint.
","required":false},{"schema":{"type":"string"},"in":"query","name":"run_id","description":"Fetch all audit logs related to the specified action run.
","required":false},{"schema":{"type":"string"},"in":"query","name":"webhookId","description":"Fetch all audit logs related to the specified webhook.
","required":false},{"schema":{"type":"string"},"in":"query","name":"webhookEventId","description":"Fetch all audit logs related to the specified webhook event.
","required":false},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"origin","explode":true,"description":"Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
","required":false},{"schema":{"type":"string"},"in":"query","name":"InstallationId","description":"Fetch all audit logs related to the specified integration.
","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["blueprint","entity","run","webhook","scorecard","action"]}},"in":"query","name":"resources","explode":true,"description":"Fetch all audit logs related to the specified resource type/s.
","required":false},{"schema":{"type":"array","items":{"enum":["action","context","diff","identifier","resourceType","status","trigger","additionalData","message"]}},"in":"query","name":"includes","explode":true,"description":"The fields you want to include in the response. If used, only the specified fields will be included in the response.
","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"from","description":"The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"to","description":"The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
","required":false},{"schema":{"type":"string"},"in":"query","name":"action","description":"Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
","required":false},{"schema":{"type":"string","enum":["SUCCESS","FAILURE"]},"in":"query","name":"status","description":"Fetch all audit logs with the specified status.
","required":false},{"schema":{"type":"number"},"in":"query","name":"limit","description":"The maximum number of logs to fetch.
","required":false}]} >
diff --git a/docs/api-reference/search-entities.api.mdx b/docs/api-reference/search-entities.api.mdx index 4887b22a9..3be46977d 100644 --- a/docs/api-reference/search-entities.api.mdx +++ b/docs/api-reference/search-entities.api.mdx @@ -5,7 +5,7 @@ description: "This route allows you to search for entities in your software cata sidebar_label: "Search entities" hide_title: true hide_table_of_contents: true -api: eJztWW1vG7kR/ivsFGgbYKW11UuvXegEOHcukBaNjdjFAZWFhLscSbzsknsk145O2P9eDJf7YkmW1cLXXIt+iLIkh8N5eWY4HG/B8ZWFZA6Xykkn0cIiAoE2M7J0UitI4HYtLTO6csh4nusHyza6Yk4zi9xka7bUhmHYzaSiVcOsXroHbpBl3PFcr1jKLQqmFeNsJe9RMYuO6SUzVY52PE1NPPM/t5rlyI1ihTbIeKor13GPWLbG7BOjObdGNhc6qwpUjpOoi9+tnSttEsdCZ3ZcauPGUsdpJXMxIqFGrVCjIFRsNyobCe74yOlu8tftca8GYv1Zm0YigY7L3AbJrrVxv7WtJQrM1lxJW0SNWhHjSjBdouFOG8tGzCI2kocdv2E/Vmg27BRFmi0jrsTIb4pfjSECgz9WaN0bLTaQbCHTyqFy9MnLMpeZ5xj/YMmVW7DZGgtOX25TIiSg0x8wcxBBaUhOjwDPpkilIqkHtNYZqVYQAaqqIMxwJSACbQ5hBlnPg8BSWfRIIe0HPoc6Aj8cnMON4RuIQDos/DxXm6slJPPnpA6jzb7MdQStG2ixVWAGEcy+gQim9O8bWNQR3PO8wp7DHFRVpGhgUdeNtaVBQfPdaQPe7fZFBFwISdbg+fVAyCXPLUbgpMtJvHeeN3tf5Qh19OL6pegeEBVEoLR70w0OKtofqhWeZO6l0cUheCy1KbiDBAR3OHKyIN3A6VNpd+zsj/H7F73hvuMO2XuuVqfZDS26Y0h2WnjIOV1oY/QDRLBB69A00zm37nvET+FzQt82DP6mlVuH79/7Qbvyh0ej80kYHgCSF29Xu+tmuv5ZgNfY72eCHUXUr+iHshGXyl6ozWAEEQiN9p123zYzEEGKK6ns99KbMqy+obkwhUrsrF4qESZkAPhb9RjXe2mjc3trhU6NjiQEe08SJgYkqdY5cjWgaWcGRG0Oa0n2ctqOIQdb96TsQ+NwvHiAnOT1G8+68fu/gKnnIXIIBdJeFqXnKL2//IAcdARPO0gfiNJtOhXh/rxTIX5IfoM5dyhutRc6zSssjVQH0siBXNqvCGkwa27FnnVVWmeQFx7NDyoMFo+038PbyV5+T4JLrQ75ec+5Q81OcHTrhpsTC4lm9YBdWiA/BwG/etznx7PQ8ZSgqjyHY8H30iliL5sfwHgw7qlIb8gD1Bf17gGDWq6ttZ6x52MOzlRk4pIbXqBDY7399irJXmeBS17lrveOpJLQ16yUqHlB5Pg5yyuBHzKeZ5UPtA8D5AzPD9o+LjDfLtlHEuxjxOY9C9az+DdeA1llnS7kTziSyuHK+CCycabVUq4qg81LodAC89iiq8pRFzpxf3DciiO1GrUejV+xB5nnLEUWFBeM6hpfDrfvja4iPmDd5++Pg1aWyh/2vD0vFPNH0JPMR4vt5Zt7ATfsLzdX717skUUvkpF1pspcZfDVmF2pfEPHWWwFaC1m0FVGoaDHpX8+oC21sjjuXmb4mRdljgn7uGV3gww0bu3/VpAOS4nmDqI7kINh/fFFLR7c+8u3OD3KUmS6KKRzQzi+vHkXEVjMKiPpzp9vIUVu0DR3LBcJdq0HomyP9zafnJ3Rf48td1NlGVpLt8hXk8n++pVCMirpstTUsaCaB42hJ7jOssoYFMmdulNTx9McZ/RhZneKsalbzy6JcBq7dTfzXc89zE9jv6HfJmbTdCbVPc+l+BCe5NM4nU1jJzoSehSXRt9Lin5yD6NSlintWMFdtm6s7xstDRrD7va0uBWXNH99yDJfTnOHRvH8AzYsdhS/UKylaKTphHlawzqCAt1aC0ig1NZXFtytIYH4/jxuIROaIkAAM/ft3VSZHBJow4aXso0aH+n7q5XtCQZY9fdqg8MWsX12KOVfcRD2F5VbayN/8mkfQmpYIxdUGNQRUPC971s1l01E7bZaQkclNETmw6dXX5mEYuaMdDmy3r7PYXI2+Wp09vVo8qfb89fJ6/Nk8sfx2dfn/2je1EfW62dOGNZG+2Q0Oyian9y9X2ocqTL3+wZdOl74hLxsugyhMqL2HLu4fkunorFNkJyPzyiACFQF92V58OFN05Pr0tFOxh401/7fE/1F90QDWBx+dnGZU4Ohjpqw34YkMof7c99V6FwdEskigjVlm2QO2y355+8mr2uabu55CkohLaWpJy72IUz+h6vUJ6z8CTcnFPdtCvBJ4nRzfumS6YsWqUcN3tf5/6Wm/c9Vo6cA95EdFzQwkgwJyZyumXCvUy5otn3b2HF0S5z7vXt/gSFeXVVzfXVzS+2X8JcbilhIwHBqPtNvAr4Z58ObCPzcFnKuVhVfEW3D0/eFKspqw+rkk69Owseg4cF9K7aVcLdsadSh32Ev89GW7bapfeq6o2+WntwRzNVjtelS/BMUivnc +api: eJztWW1v2zYQ/iucBmwLYFmJ166bkRpIuwzIhjVBkqHAkiChJNpmK5EaSSVxDf/33VGkJNuK4w3pug77UFckj8d7ee54vMwDQyc6GF4Eh8Jww5kOrnpBynSieGG4FMEwOJ9yTZQsDSM0y+SdJjNZEiOJZlQlUzKWijC3m3CBq4poOTZ3VDGSUEMzOSEx1SwlUhBKJvyWCdhtiBwTVWZM9/djFY3sz7kkGfAVJJewm8Zwbs29R5IpS94TnDNTRi5SmZQ5rFIU9eqbqTGFHkYRTOt+IZXpcxnFJc/SEIUKvVChEyrSM5GEKQxCI+vJL/1xOy2xfgIlrUQpM5Rn2kl2Aod8rb0lcpZMqeA671Vq9QgVoHPBFDVSaRICIaskdzu+In+UTM3INopUW0JgGdpN0U4/6AWKwUCbVzKdBcN5kEhhgA9+0qLIeGI5Ru80unIeaDBgTvHLzAoGzpXxO5YY4FMolNMiwLLJYy5Q6hatNoqLCdAyUeaIGRAFRkDTgRnwfM0DwVJqZpGC2rd8HixABRy2zqFK0Rkw5obldp6K2fEYDnxMajearcsMp3g34KJXYAQsRi/hZx//vQyugO6WZiVrOFwEQBsz0HGxqKzNFUtxvj6txdtvB4PQNOVoDZqdtIQc00yzXgAAy1C8N5Y3OQULgIxPrl/MzB1jAhgJaV7Vg05Fm0OlYFuZe6xk3gUPcHNOAYIBRBYLDc9Rt8DIbWlX7GyPsfuvGsP9COTklIrJdnZjkG02IdnI1ELOSAhyJe/gcwZRxVQ1nVFt3jL23n0O8Fu7wa8QcVP3/a0d+JXvlkZ7AzfsAJIVb1W7k2p68VGAV9nvI8EOI+oL/MFsRLnQB2LWGsFnKpl+I83ragYmYjaBlbfcmtKtvsI5N8VEurJ6KFI3wR3Aj8QyrtfSRu12b4VajZrEBXtD4iZaJLGUcEOJFo2faRH5HOZJ1nLaiiFbW9ekbEKjO14sQLby+pllXfn9L2DqcYh0oYDrw7ywHLn1lx2ggzbgaQXpLVHqTdsi3J63LcS75FcsAxun59IKHYMlChCyI4105NJmJQVdkupWbFiXBRAwmls03wk3uFrSfg1vW3v5FAUHoi4/rzm3rdkWjvZuONuykKhWO+zigfwYBOzqZp9vzkKbU4IosyzYFHxPnSLWsnkHxp1xt0V6Re6gDvxXDmjVcr7WesSeyxyMKtHEBVU0Z3Alamu/tUqy0TllY1pmpvEOx5LQ1qyYqIELDNl9kpUpu05olpQ20K5byGmf77RdLjCPxuQGBbvpkYuGBWlY/I3XQFJquP/5BxZCMLCJskGkI7i2xnxSAqF9KeQyZRkU46Yswjp0oubgyIsDm0Pv0WiH3PEsIzEjTvGUYF1jy2H/3qgr4g7rPn5/dFqZC3tYlz3ZfZGBKpV/V817AO80PBFfaDZ4dCPuhZV3Rn4+O37zZG8ufKCEoEyZGLD0Tp8ci2yGx8GzwQngDajA9EqAAeGtaV8TTBfgJ9avH2rsnuZFxobkZk4uWwmp791xlKIOY87UZdC7DHhruLh5Ugc4b392DsAnG9ha5jk3pg3Wp7c2JCPNklJxrAggs8TwzoV0am9gmg5Z3ZhASn+8dcFgdxf/W7bcWZkkTGu8Y54NBuvrx4KhUVGXscR+BlZEDIp+eKDLBOQAHw0vxaXYNzTO2Ag/FPwSsm+mo0Mk3I/gy8/82HB38/CfWtqWjvbjERfgR55euwf7fhSPgDCtSfDJDBa75Zgb0D0EC10CdS2BizKZVta3bZgKnG63Py3y4qLmz7ss8+k0h1sDLpprVrFYURyg7ikqaWphHtYQVIS7aCohmoJCalt3UHgMDIPodi/ykHEtkwABpm79zVWqDOh82NCC+6ixgb++WuqGoIVVe+tWOPSIbZJFwX9hrSxwUIKsin+wl0LgMsUU0I1lA+iCwXfaNHIOq4habcS4fotrl1y0H2ZN3eJKnV3UZcO6f71DDA2ehbsvwsEP53vPh8/3hoPv+7sv9n6vXtwb1hePnNCunNbJcLZVUj+4e70Q2VCDrncV1ip0V/Bd2XQ9rloSrozCXh45ODlCIQArVczs9XdxN2Isp7aGdy49qxp4dXZaSeCtTtz/DdR/dQPVYcewe6jiMuxGgL9tFpi7nHIR3O7ZFkTtapdXIBtMMfkAxXyO/vlNZYsFTldVAMZoyjVmrQfq2DZM/sMl7QNWfs9mW7wEfOTanLG9OT91BfVJS9iNBm8eBZ+paf+54nQb4C7Z8QoHiqMhIfzxmnHXPOaCatvryo7hOXJu9q79uQZ51UXOyfHZOfZq3J95cvtwCBTFTjX+wtnYBbHhjQR2bh5kVExKOkHaiqdtIpWY1drFyntbrLiPVneE2r6tl3C1iqnUwd9243Npy3xelUKQFT19tfTgDmeuBqtVS+NPDxIJZw== sidebar_class_name: "post api-method" info_path: api-reference/port-api custom_edit_url: null @@ -47,7 +47,7 @@ This route allows you to search for entities in your software catalog based on a "},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","required":false,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"}]} + parameters={[{"schema":{"type":"boolean","default":false},"in":"query","name":"exclude_calculated_properties","required":false,"description":"If `true`, [calculated properties](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/) will be excluded from the entities.
"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"include","required":false,"explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"exclude","required":false,"explode":true,"description":"An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`"}]} >
diff --git a/static/apispec.yaml b/static/apispec.yaml index ebda54363..e36c06a1f 100644 --- a/static/apispec.yaml +++ b/static/apispec.yaml @@ -5652,6 +5652,7 @@ paths: in: query name: include required: false + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" - schema: type: array @@ -5659,6 +5660,7 @@ paths: type: string in: query name: exclude + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" required: false - schema: @@ -6688,6 +6690,7 @@ paths: in: query name: include required: false + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" - schema: type: array @@ -6696,6 +6699,7 @@ paths: in: query name: exclude required: false + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" # - schema: # type: boolean @@ -7251,6 +7255,7 @@ paths: in: query name: include required: false + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure). Only these values will be returned in the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" - schema: type: array @@ -7259,6 +7264,7 @@ paths: in: query name: exclude required: false + explode: true description: "An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure) to be ommitted from the response.
For example: `{ \"properties.propertyIdentifier\",\"identifier\"}`" # - schema: # type: boolean @@ -12736,6 +12742,7 @@ paths: type: string in: query name: action_identifier + explode: true description: The identifier/s of the action/s and/or automation/s you want to fetch.
required: false - schema: @@ -12744,6 +12751,7 @@ paths: type: string in: query name: blueprint_identifier + explode: true description: The identifier/s of the blueprint/s whose actions/automations you wish to fetch.
required: false - schema: @@ -12756,6 +12764,7 @@ paths: - DAY-2 in: query name: operation + explode: true description: The [operation type/s](https://docs.port.io/create-self-service-experiences/setup-ui-for-action/#basic-details) of the action/s you want to fetch. Relevant only for self-service actions.
required: false - schema: @@ -17590,6 +17599,7 @@ paths: - users.status in: query name: fields + explode: true description: The fields you want to fetch for each team. If used, only the specified fields will be included in the response.
required: false security: @@ -17748,6 +17758,7 @@ paths: - users.status in: query name: fields + explode: true description: The fields you want to fetch for the team. If used, only the specified fields will be included in the response.
required: false - schema: @@ -18024,6 +18035,7 @@ paths: - roles.updatedAt in: query name: fields + explode: true description: The fields you want to fetch for each user. If used, only the specified fields will be included in the response.
required: false security: @@ -18415,6 +18427,7 @@ paths: type: string in: query name: origin + explode: true description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
required: false - schema: @@ -18454,6 +18467,7 @@ paths: # - action in: query name: resources + explode: true description: Fetch all audit logs related to the specified resource type/s.
required: false - schema: @@ -18471,6 +18485,7 @@ paths: - message in: query name: includes + explode: true description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
required: false - schema: @@ -22291,6 +22306,7 @@ paths: - enabled in: query name: fields + explode: true description: The fields to include in the response. If not specified, all fields will be included.
required: false security: